docs: Added missing TSDoc comments (#19)

.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 { MysaApiClient, MysaSession } from '@/api';
-import { MysaSession } from '@/api/MysaSession';
 import 'dotenv/config';
 import { readFile, rm, writeFile } from 'fs/promises';
 import { pino } from 'pino';
@@ -89,8 +88,13 @@ async function main() {
   });
 
   for (const device of Object.entries(devices.DevicesObj)) {
+    const serial = await client.getDeviceSerialNumber(device[0]);
+    rootLogger.info(`Serial number for device '${device[0]}' (${device[1].Name}): ${serial}`);
+
     await client.startRealtimeUpdates(device[0]);
   }
 }
 
-main().catch(rootLogger.error);
+main().catch((error) => {
+  rootLogger.error(error, 'Error in main');
+});

package.json

@@ -46,21 +46,22 @@
     "build:docs": "typedoc"
   },
   "dependencies": {
-    "@aws-sdk/credential-providers": "3.817.0",
+    "@aws-sdk/client-iot": "3.825.0",
+    "@aws-sdk/credential-providers": "3.825.0",
     "amazon-cognito-identity-js": "6.3.15",
-    "aws-iot-device-sdk-v2": "1.21.4",
+    "aws-iot-device-sdk-v2": "1.21.5",
     "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.30",
     "conventional-changelog-conventionalcommits": "9.0.0",
     "dotenv": "16.5.0",
-    "eslint": "9.27.0",
+    "eslint": "9.28.0",
-    "eslint-plugin-jsdoc": "50.6.17",
+    "eslint-plugin-jsdoc": "50.7.1",
     "eslint-plugin-tsdoc": "0.4.0",
     "pino": "9.7.0",
     "pino-pretty": "13.0.0",
@@ -70,9 +71,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.1"
   }
 }

src/api/MysaApiClient.ts

@@ -6,7 +6,8 @@ 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 { DescribeThingCommand, IoTClient } from '@aws-sdk/client-iot';
 import { fromCognitoIdentityPool } from '@aws-sdk/credential-providers';
 import {
   AuthenticationDetails,
@@ -19,7 +20,7 @@ import {
 } from 'amazon-cognito-identity-js';
 import { iot, mqtt } from 'aws-iot-device-sdk-v2';
 import dayjs from 'dayjs';
-import duration from 'dayjs/plugin/duration';
+import duration from 'dayjs/plugin/duration.js';
 import { MysaApiError, UnauthenticatedError } from './Errors';
 import { Logger, VoidLogger } from './Logger';
 import { MysaApiClientEventTypes } from './MysaApiClientEventTypes';
@@ -143,8 +144,23 @@ export class MysaApiClient {
   /**
    * Logs in the user with the given email address and password.
    *
+   * This method authenticates the user with Mysa's Cognito user pool and establishes a session that can be used for
+   * subsequent API calls. Upon successful login, a 'sessionChanged' event is emitted.
+   *
+   * @example
+   *
+   * ```typescript
+   * try {
+   *   await client.login('user@example.com', 'password123');
+   *   console.log('Login successful!');
+   * } catch (error) {
+   *   console.error('Login failed:', error.message);
+   * }
+   * ```
+   *
    * @param emailAddress - The email address of the user.
    * @param password - The password of the user.
+   * @throws {@link Error} When authentication fails due to invalid credentials or network issues.
    */
   async login(emailAddress: string, password: string): Promise<void> {
     this._cognitoUser = undefined;
@@ -175,7 +191,21 @@ export class MysaApiClient {
   /**
    * Retrieves the list of devices associated with the user.
    *
+   * This method fetches all Mysa devices linked to the authenticated user's account, including device information such
+   * as models, locations, and configuration details.
+   *
+   * @example
+   *
+   * ```typescript
+   * const devices = await client.getDevices();
+   * for (const [deviceId, device] of Object.entries(devices.DevicesObj)) {
+   *   console.log(`Device: ${device.DisplayName} (${device.Model})`);
+   * }
+   * ```
+   *
    * @returns A promise that resolves to the list of devices.
+   * @throws {@link MysaApiError} When the API request fails.
+   * @throws {@link UnauthenticatedError} When the user is not authenticated.
    */
   async getDevices(): Promise<Devices> {
     this._logger.debug(`Fetching devices...`);
@@ -184,7 +214,7 @@ export class MysaApiClient {
 
     const response = await this._fetcher(`${MysaApiBaseUrl}/devices`, {
       headers: {
-        Authorization: `${session.getAccessToken().getJwtToken()}`
+        Authorization: `${session.getIdToken().getJwtToken()}`
       }
     });
 
@@ -195,6 +225,138 @@ export class MysaApiClient {
     return response.json();
   }
 
+  /**
+   * Retrieves the serial number for a specific device.
+   *
+   * This method uses AWS IoT's DescribeThing API to fetch the serial number attribute for the specified device. This
+   * requires additional AWS IoT permissions and may not be available for all devices.
+   *
+   * @example
+   *
+   * ```typescript
+   * const serialNumber = await client.getDeviceSerialNumber('device123');
+   * if (serialNumber) {
+   *   console.log(`Device serial: ${serialNumber}`);
+   * } else {
+   *   console.log('Serial number not available');
+   * }
+   * ```
+   *
+   * @param deviceId - The ID of the device to get the serial number for.
+   * @returns A promise that resolves to the serial number, or undefined if not found.
+   * @throws {@link UnauthenticatedError} When the user is not authenticated.
+   */
+  async getDeviceSerialNumber(deviceId: string): Promise<string | undefined> {
+    this._logger.debug(`Fetching serial number for device ${deviceId}...`);
+
+    const session = await this.getFreshSession();
+
+    // Get AWS credentials for IoT client
+    const credentialsProvider = fromCognitoIdentityPool({
+      clientConfig: {
+        region: AwsRegion
+      },
+      identityPoolId: CognitoIdentityPoolId,
+      logins: {
+        [CognitoLoginKey]: session.getIdToken().getJwtToken()
+      }
+    });
+
+    const credentials = await credentialsProvider();
+    const iotClient = new IoTClient({
+      region: AwsRegion,
+      credentials: {
+        accessKeyId: credentials.accessKeyId,
+        secretAccessKey: credentials.secretAccessKey,
+        sessionToken: credentials.sessionToken
+      }
+    });
+
+    try {
+      const command = new DescribeThingCommand({ thingName: deviceId });
+      const response = await iotClient.send(command);
+      return response.attributes?.['Serial'];
+    } catch (error) {
+      this._logger.warn(`Could not get serial number for device ${deviceId}:`, error);
+      return undefined;
+    }
+  }
+
+  /**
+   * Retrieves firmware information for all devices.
+   *
+   * @returns A promise that resolves to the firmware information for all devices.
+   * @throws {@link MysaApiError} When the API request fails.
+   * @throws {@link UnauthenticatedError} When the user is not authenticated.
+   */
+  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();
+  }
+
+  /**
+   * Retrieves the current state information for all devices.
+   *
+   * @returns A promise that resolves to the current state of all devices.
+   * @throws {@link MysaApiError} When the API request fails.
+   * @throws {@link UnauthenticatedError} When the user is not authenticated.
+   */
+  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()}`
+      }
+    });
+
+    if (!response.ok) {
+      throw new MysaApiError(response);
+    }
+
+    return response.json();
+  }
+
+  /**
+   * Sets the state of a specific device by sending commands via MQTT.
+   *
+   * This method allows you to change the temperature set point and/or operating mode of a Mysa device. The command is
+   * sent through the MQTT connection for real-time device control.
+   *
+   * @example
+   *
+   * ```typescript
+   * // Set temperature to 22°C
+   * await client.setDeviceState('device123', 22);
+   *
+   * // Turn device off
+   * await client.setDeviceState('device123', undefined, 'off');
+   *
+   * // Set temperature and mode
+   * await client.setDeviceState('device123', 20, 'heat');
+   * ```
+   *
+   * @param deviceId - The ID of the device to control.
+   * @param setPoint - The target temperature set point (optional).
+   * @param mode - The operating mode to set ('off', 'heat', or undefined to leave unchanged).
+   * @throws {@link UnauthenticatedError} When the user is not authenticated.
+   * @throws {@link Error} When MQTT connection or command sending fails.
+   */
   async setDeviceState(deviceId: string, setPoint?: number, mode?: MysaDeviceMode) {
     this._logger.debug(`Setting device state for '${deviceId}'`);
 
@@ -249,13 +411,29 @@ export class MysaApiClient {
   /**
    * Starts receiving real-time updates for the specified device.
    *
+   * This method establishes an MQTT subscription to receive live status updates from the device, including temperature,
+   * humidity, set point changes, and other state information. The client will automatically send keep-alive messages to
+   * maintain the connection.
+   *
+   * @example
+   *
+   * ```typescript
+   * // Start receiving updates and listen for events
+   * await client.startRealtimeUpdates('device123');
+   *
+   * client.emitter.on('statusChanged', (status) => {
+   *   console.log(`Temperature: ${status.temperature}°C`);
+   * });
+   * ```
+   *
    * @param deviceId - The ID of the device to start receiving updates for.
+   * @throws {@link Error} When MQTT connection or subscription fails.
    */
   async startRealtimeUpdates(deviceId: string) {
-    this._logger.info(`Starting realtime updates for device '${deviceId}'`);
+    this._logger.info(`Starting real-time updates for device '${deviceId}'`);
 
     if (this._realtimeDeviceIds.has(deviceId)) {
-      this._logger.debug(`Realtime updates for device '${deviceId}' already started`);
+      this._logger.debug(`Real-time updates for device '${deviceId}' already started`);
       return;
     }
 
@@ -293,9 +471,15 @@ export class MysaApiClient {
   /**
    * Stops receiving real-time updates for the specified device.
    *
+   * This method unsubscribes from the MQTT topic for the specified device and clears any associated timers to stop the
+   * keep-alive messages.
+   *
    * @param deviceId - The ID of the device to stop receiving real-time updates for.
+   * @throws {@link Error} When MQTT unsubscription fails.
    */
   async stopRealtimeUpdates(deviceId: string) {
+    this._logger.info(`Stopping real-time updates for device '${deviceId}'`);
+
     const timer = this._realtimeDeviceIds.get(deviceId);
     if (!timer) {
       this._logger.warn(`No real-time updates are running for device '${deviceId}'`);
@@ -308,11 +492,19 @@ export class MysaApiClient {
     this._logger.debug(`Unsubscribing to MQTT topic '/v1/dev/${deviceId}/out'...`);
     await mqttConnection.unsubscribe(`/v1/dev/${deviceId}/out`);
 
-    this._logger.debug(`Stopping real-time updates for device '${deviceId}'...`);
     clearInterval(timer);
     this._realtimeDeviceIds.delete(deviceId);
   }
 
+  /**
+   * Ensures a valid, non-expired session is available.
+   *
+   * This method checks if the current session is valid and not expired. If the session is expired, it automatically
+   * refreshes it using the refresh token.
+   *
+   * @returns A promise that resolves to a valid CognitoUserSession.
+   * @throws {@link UnauthenticatedError} When no session exists or refresh fails.
+   */
   private async getFreshSession(): Promise<CognitoUserSession> {
     if (!this._cognitoUser || !this._cognitoUserSession) {
       throw new UnauthenticatedError('An attempt was made to access a resource without a valid session.');
@@ -320,20 +512,20 @@ 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');
+      this._logger.debug('Session is valid, no need to refresh');
       return Promise.resolve(this._cognitoUserSession);
     }
 
-    this._logger.info('Session is not valid or expired, refreshing...');
+    this._logger.debug('Session is not valid or expired, refreshing...');
     return new Promise<CognitoUserSession>((resolve, reject) => {
       this._cognitoUser!.refreshSession(this._cognitoUserSession!.getRefreshToken(), (error, session) => {
         if (error) {
           this._logger.error('Failed to refresh session:', error);
           reject(new UnauthenticatedError('Unable to refresh the authentication session.'));
         } else {
-          this._logger.info('Session refreshed successfully');
+          this._logger.debug('Session refreshed successfully');
           this._cognitoUserSession = session;
           this.emitter.emit('sessionChanged', this.session);
           resolve(session);
@@ -342,6 +534,15 @@ export class MysaApiClient {
     });
   }
 
+  /**
+   * Establishes and returns an MQTT connection for real-time communication.
+   *
+   * This method creates a new MQTT connection if one doesn't exist, using AWS IoT WebSocket connections with Cognito
+   * credentials. The connection is cached and reused for subsequent calls.
+   *
+   * @returns A promise that resolves to an active MQTT connection.
+   * @throws {@link Error} When connection establishment fails.
+   */
   private async getMqttConnection(): Promise<mqtt.MqttClientConnection> {
     if (this._mqttConnection) {
       return this._mqttConnection;
@@ -383,6 +584,15 @@ export class MysaApiClient {
     return this._mqttConnection;
   }
 
+  /**
+   * Processes incoming MQTT messages and emits appropriate events.
+   *
+   * This method parses MQTT payloads and converts them into typed events that can be listened to via the client's event
+   * emitter. It handles both v1 and v2 device message formats and emits events like 'statusChanged', 'setPointChanged',
+   * and 'stateChanged'.
+   *
+   * @param payload - The raw MQTT message payload to process.
+   */
   private processMqttMessage(payload: ArrayBuffer) {
     try {
       const parsedPayload = parseMqttPayload(payload);

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';