docs: Added missing TSDoc comments (#19 )

feat: Added getDeviceSerialNumber() API (#18 )
chore(deps-dev): Bump @types/node from 22.15.29 to 22.15.30 in the dev-dependencies group (#16 )
2026-02-04 09:41:07 +00:00 · 2025-06-07 10:08:05 -04:00 · 2025-06-07 09:57:28 -04:00 · 2025-06-06 12:21:38 +00:00 · 2025-06-06 12:21:26 +00:00
4 changed files with 449 additions and 150 deletions
--- a/example/main.ts
+++ b/example/main.ts
@@ -88,6 +88,9 @@ 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]);
  }
 }
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,8 @@
      "version": "0.0.0",
      "license": "MIT",
      "dependencies": {
-        "@aws-sdk/credential-providers": "3.823.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.5",
        "dayjs": "1.11.13",
@@ -19,7 +20,7 @@
        "@eslint/js": "9.28.0",
        "@semantic-release/npm": "12.0.1",
        "@types/lodash": "4.17.17",
-        "@types/node": "22.15.29",
+        "@types/node": "22.15.30",
        "conventional-changelog-conventionalcommits": "9.0.0",
        "dotenv": "16.5.0",
        "eslint": "9.28.0",
@@ -164,45 +165,45 @@
      "license": "0BSD"
    },
    "node_modules/@aws-sdk/client-cognito-identity": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/client-cognito-identity/-/client-cognito-identity-3.823.0.tgz",
-      "integrity": "sha512-zCTr4gemGm2bvbeOvXFa0g1SPyra+WlZvGQ7Vc/snFwOlZ/OLAH1OugYD357k9pMqh1DyElFbHlj2rY5I8JeUA==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/client-cognito-identity/-/client-cognito-identity-3.825.0.tgz",
+      "integrity": "sha512-FYXwkFmOYMiUYbLuzEl9by4Ks+bidXiHQwRXaDijuzkjM3B/Dd8noIxlvQCdxd6Ji7ofXcXTfNpVqN0U0JF9ag==",
      "license": "Apache-2.0",
      "dependencies": {
        "@aws-crypto/sha256-browser": "5.2.0",
        "@aws-crypto/sha256-js": "5.2.0",
-        "@aws-sdk/core": "3.823.0",
-        "@aws-sdk/credential-provider-node": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/credential-provider-node": "3.825.0",
        "@aws-sdk/middleware-host-header": "3.821.0",
        "@aws-sdk/middleware-logger": "3.821.0",
        "@aws-sdk/middleware-recursion-detection": "3.821.0",
-        "@aws-sdk/middleware-user-agent": "3.823.0",
+        "@aws-sdk/middleware-user-agent": "3.825.0",
        "@aws-sdk/region-config-resolver": "3.821.0",
        "@aws-sdk/types": "3.821.0",
        "@aws-sdk/util-endpoints": "3.821.0",
        "@aws-sdk/util-user-agent-browser": "3.821.0",
-        "@aws-sdk/util-user-agent-node": "3.823.0",
+        "@aws-sdk/util-user-agent-node": "3.825.0",
        "@smithy/config-resolver": "^4.1.4",
-        "@smithy/core": "^3.5.1",
+        "@smithy/core": "^3.5.2",
        "@smithy/fetch-http-handler": "^5.0.4",
        "@smithy/hash-node": "^4.0.4",
        "@smithy/invalid-dependency": "^4.0.4",
        "@smithy/middleware-content-length": "^4.0.4",
-        "@smithy/middleware-endpoint": "^4.1.9",
-        "@smithy/middleware-retry": "^4.1.10",
+        "@smithy/middleware-endpoint": "^4.1.10",
+        "@smithy/middleware-retry": "^4.1.11",
        "@smithy/middleware-serde": "^4.0.8",
        "@smithy/middleware-stack": "^4.0.4",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/node-http-handler": "^4.0.6",
        "@smithy/protocol-http": "^5.1.2",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.2",
        "@smithy/types": "^4.3.1",
        "@smithy/url-parser": "^4.0.4",
        "@smithy/util-base64": "^4.0.0",
        "@smithy/util-body-length-browser": "^4.0.0",
        "@smithy/util-body-length-node": "^4.0.0",
-        "@smithy/util-defaults-mode-browser": "^4.0.17",
-        "@smithy/util-defaults-mode-node": "^4.0.17",
+        "@smithy/util-defaults-mode-browser": "^4.0.18",
+        "@smithy/util-defaults-mode-node": "^4.0.18",
        "@smithy/util-endpoints": "^3.0.6",
        "@smithy/util-middleware": "^4.0.4",
        "@smithy/util-retry": "^4.0.5",
@@ -276,45 +277,160 @@
        "node": ">=14.0.0"
      }
    },
-    "node_modules/@aws-sdk/client-sso": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/client-sso/-/client-sso-3.823.0.tgz",
-      "integrity": "sha512-dBWdsbyGw8rPfdCsZySNtTOGQK4EZ8lxB/CneSQWRBPHgQ+Ys88NXxImO8xfWO7Itt1eh8O7UDTZ9+smcvw2pw==",
+    "node_modules/@aws-sdk/client-iot": {
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/client-iot/-/client-iot-3.825.0.tgz",
+      "integrity": "sha512-q2CcipEBhmLIaIr1NXL7ijYgQ5I4dKCMoeu/XdJNkPYE5ceONI+I+76CPlvqgFdG+/T2IrOsfpAGD8rtLTETzw==",
      "license": "Apache-2.0",
      "dependencies": {
        "@aws-crypto/sha256-browser": "5.2.0",
        "@aws-crypto/sha256-js": "5.2.0",
-        "@aws-sdk/core": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/credential-provider-node": "3.825.0",
        "@aws-sdk/middleware-host-header": "3.821.0",
        "@aws-sdk/middleware-logger": "3.821.0",
        "@aws-sdk/middleware-recursion-detection": "3.821.0",
-        "@aws-sdk/middleware-user-agent": "3.823.0",
+        "@aws-sdk/middleware-user-agent": "3.825.0",
        "@aws-sdk/region-config-resolver": "3.821.0",
        "@aws-sdk/types": "3.821.0",
        "@aws-sdk/util-endpoints": "3.821.0",
        "@aws-sdk/util-user-agent-browser": "3.821.0",
-        "@aws-sdk/util-user-agent-node": "3.823.0",
+        "@aws-sdk/util-user-agent-node": "3.825.0",
        "@smithy/config-resolver": "^4.1.4",
-        "@smithy/core": "^3.5.1",
+        "@smithy/core": "^3.5.2",
        "@smithy/fetch-http-handler": "^5.0.4",
        "@smithy/hash-node": "^4.0.4",
        "@smithy/invalid-dependency": "^4.0.4",
        "@smithy/middleware-content-length": "^4.0.4",
-        "@smithy/middleware-endpoint": "^4.1.9",
-        "@smithy/middleware-retry": "^4.1.10",
+        "@smithy/middleware-endpoint": "^4.1.10",
+        "@smithy/middleware-retry": "^4.1.11",
        "@smithy/middleware-serde": "^4.0.8",
        "@smithy/middleware-stack": "^4.0.4",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/node-http-handler": "^4.0.6",
        "@smithy/protocol-http": "^5.1.2",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.2",
        "@smithy/types": "^4.3.1",
        "@smithy/url-parser": "^4.0.4",
        "@smithy/util-base64": "^4.0.0",
        "@smithy/util-body-length-browser": "^4.0.0",
        "@smithy/util-body-length-node": "^4.0.0",
-        "@smithy/util-defaults-mode-browser": "^4.0.17",
-        "@smithy/util-defaults-mode-node": "^4.0.17",
+        "@smithy/util-defaults-mode-browser": "^4.0.18",
+        "@smithy/util-defaults-mode-node": "^4.0.18",
+        "@smithy/util-endpoints": "^3.0.6",
+        "@smithy/util-middleware": "^4.0.4",
+        "@smithy/util-retry": "^4.0.5",
+        "@smithy/util-utf8": "^4.0.0",
+        "@types/uuid": "^9.0.1",
+        "tslib": "^2.6.2",
+        "uuid": "^9.0.1"
+      },
+      "engines": {
+        "node": ">=18.0.0"
+      }
+    },
+    "node_modules/@aws-sdk/client-iot/node_modules/@aws-crypto/sha256-js": {
+      "version": "5.2.0",
+      "resolved": "https://registry.npmjs.org/@aws-crypto/sha256-js/-/sha256-js-5.2.0.tgz",
+      "integrity": "sha512-FFQQyu7edu4ufvIZ+OadFpHHOt+eSTBaYaki44c+akjg7qZg9oOQeLlk77F6tSYqjDAFClrHJk9tMf0HdVyOvA==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@aws-crypto/util": "^5.2.0",
+        "@aws-sdk/types": "^3.222.0",
+        "tslib": "^2.6.2"
+      },
+      "engines": {
+        "node": ">=16.0.0"
+      }
+    },
+    "node_modules/@aws-sdk/client-iot/node_modules/@aws-crypto/util": {
+      "version": "5.2.0",
+      "resolved": "https://registry.npmjs.org/@aws-crypto/util/-/util-5.2.0.tgz",
+      "integrity": "sha512-4RkU9EsI6ZpBve5fseQlGNUWKMa1RLPQ1dnjnQoe07ldfIzcsGb5hC5W0Dm7u423KWzawlrpbjXBrXCEv9zazQ==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@aws-sdk/types": "^3.222.0",
+        "@smithy/util-utf8": "^2.0.0",
+        "tslib": "^2.6.2"
+      }
+    },
+    "node_modules/@aws-sdk/client-iot/node_modules/@aws-crypto/util/node_modules/@smithy/util-utf8": {
+      "version": "2.3.0",
+      "resolved": "https://registry.npmjs.org/@smithy/util-utf8/-/util-utf8-2.3.0.tgz",
+      "integrity": "sha512-R8Rdn8Hy72KKcebgLiv8jQcQkXoLMOGGv5uI1/k0l+snqkOzQ1R0ChUBCxWMlBsFMekWjq0wRudIweFs7sKT5A==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@smithy/util-buffer-from": "^2.2.0",
+        "tslib": "^2.6.2"
+      },
+      "engines": {
+        "node": ">=14.0.0"
+      }
+    },
+    "node_modules/@aws-sdk/client-iot/node_modules/@smithy/is-array-buffer": {
+      "version": "2.2.0",
+      "resolved": "https://registry.npmjs.org/@smithy/is-array-buffer/-/is-array-buffer-2.2.0.tgz",
+      "integrity": "sha512-GGP3O9QFD24uGeAXYUjwSTXARoqpZykHadOmA8G5vfJPK0/DC67qa//0qvqrJzL1xc8WQWX7/yc7fwudjPHPhA==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "tslib": "^2.6.2"
+      },
+      "engines": {
+        "node": ">=14.0.0"
+      }
+    },
+    "node_modules/@aws-sdk/client-iot/node_modules/@smithy/util-buffer-from": {
+      "version": "2.2.0",
+      "resolved": "https://registry.npmjs.org/@smithy/util-buffer-from/-/util-buffer-from-2.2.0.tgz",
+      "integrity": "sha512-IJdWBbTcMQ6DA0gdNhh/BwrLkDR+ADW5Kr1aZmd4k3DIF6ezMV4R2NIAmT08wQJ3yUK82thHWmC/TnK/wpMMIA==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@smithy/is-array-buffer": "^2.2.0",
+        "tslib": "^2.6.2"
+      },
+      "engines": {
+        "node": ">=14.0.0"
+      }
+    },
+    "node_modules/@aws-sdk/client-sso": {
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/client-sso/-/client-sso-3.825.0.tgz",
+      "integrity": "sha512-U0J2RQUsxiin+uEYR8atMByojuvhtWvvEVSD2MhSUUnCa7BSu/H+4SbREBvnGDJ2nezrYh59bkSQBlp9c3Z9gg==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@aws-crypto/sha256-browser": "5.2.0",
+        "@aws-crypto/sha256-js": "5.2.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/middleware-host-header": "3.821.0",
+        "@aws-sdk/middleware-logger": "3.821.0",
+        "@aws-sdk/middleware-recursion-detection": "3.821.0",
+        "@aws-sdk/middleware-user-agent": "3.825.0",
+        "@aws-sdk/region-config-resolver": "3.821.0",
+        "@aws-sdk/types": "3.821.0",
+        "@aws-sdk/util-endpoints": "3.821.0",
+        "@aws-sdk/util-user-agent-browser": "3.821.0",
+        "@aws-sdk/util-user-agent-node": "3.825.0",
+        "@smithy/config-resolver": "^4.1.4",
+        "@smithy/core": "^3.5.2",
+        "@smithy/fetch-http-handler": "^5.0.4",
+        "@smithy/hash-node": "^4.0.4",
+        "@smithy/invalid-dependency": "^4.0.4",
+        "@smithy/middleware-content-length": "^4.0.4",
+        "@smithy/middleware-endpoint": "^4.1.10",
+        "@smithy/middleware-retry": "^4.1.11",
+        "@smithy/middleware-serde": "^4.0.8",
+        "@smithy/middleware-stack": "^4.0.4",
+        "@smithy/node-config-provider": "^4.1.3",
+        "@smithy/node-http-handler": "^4.0.6",
+        "@smithy/protocol-http": "^5.1.2",
+        "@smithy/smithy-client": "^4.4.2",
+        "@smithy/types": "^4.3.1",
+        "@smithy/url-parser": "^4.0.4",
+        "@smithy/util-base64": "^4.0.0",
+        "@smithy/util-body-length-browser": "^4.0.0",
+        "@smithy/util-body-length-node": "^4.0.0",
+        "@smithy/util-defaults-mode-browser": "^4.0.18",
+        "@smithy/util-defaults-mode-node": "^4.0.18",
        "@smithy/util-endpoints": "^3.0.6",
        "@smithy/util-middleware": "^4.0.4",
        "@smithy/util-retry": "^4.0.5",
@@ -389,19 +505,19 @@
      }
    },
    "node_modules/@aws-sdk/core": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/core/-/core-3.823.0.tgz",
-      "integrity": "sha512-1Cf4w8J7wYexz0KU3zpaikHvldGXQEjFldHOhm0SBGRy7qfYNXecfJAamccF7RdgLxKGgkv5Pl9zX/Z/DcW9zg==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/core/-/core-3.825.0.tgz",
+      "integrity": "sha512-UsdK6l62skh6mqY/La4xvehNj5sUl/eZ2N+8mNTHZKW4U+tiRESdrw1t/Z3r/NUAu7Tbmp+DHbUu+5K1BBY6YQ==",
      "license": "Apache-2.0",
      "dependencies": {
        "@aws-sdk/types": "3.821.0",
        "@aws-sdk/xml-builder": "3.821.0",
-        "@smithy/core": "^3.5.1",
+        "@smithy/core": "^3.5.2",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/protocol-http": "^5.1.2",
        "@smithy/signature-v4": "^5.1.2",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.2",
        "@smithy/types": "^4.3.1",
        "@smithy/util-base64": "^4.0.0",
        "@smithy/util-body-length-browser": "^4.0.0",
@@ -415,12 +531,12 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-cognito-identity": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-cognito-identity/-/credential-provider-cognito-identity-3.823.0.tgz",
-      "integrity": "sha512-mpP6slEenKRjRpTnGMUBbZLdAJa8GszgnQ6Vep+7Z8YwLNeGWsTFRZkavGMnGsQ5K5KdqxYgdHe0SZ9j8oIoWw==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-cognito-identity/-/credential-provider-cognito-identity-3.825.0.tgz",
+      "integrity": "sha512-TDqaakIsUeYbShBCt5F8wgjLOkq5d16JwhCgHCuM/kbwxeLmQkJWDNlui1Z32MLCIWRBilsFCr+aNG6tlj9siQ==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/client-cognito-identity": "3.823.0",
+        "@aws-sdk/client-cognito-identity": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/types": "^4.3.1",
@@ -431,12 +547,12 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-env": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-env/-/credential-provider-env-3.823.0.tgz",
-      "integrity": "sha512-AIrLLwumObge+U1klN4j5ToIozI+gE9NosENRyHe0GIIZgTLOG/8jxrMFVYFeNHs7RUtjDTxxewislhFyGxJ/w==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-env/-/credential-provider-env-3.825.0.tgz",
+      "integrity": "sha512-Ptkbhj4K1un+GIz5fmTLVCFtWv9rcbaCLgdZszudo/ZqLP0QzAoACADGYFFkPGYr2o51COKkgKPhHWl7FNEq6A==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/core": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/types": "^4.3.1",
@@ -447,18 +563,18 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-http": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-http/-/credential-provider-http-3.823.0.tgz",
-      "integrity": "sha512-u4DXvB/J/o2bcvP1JP6n3ch7V3/NngmiJFPsM0hKUyRlLuWM37HEDEdjPRs3/uL/soTxrEhWKTA9//YVkvzI0w==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-http/-/credential-provider-http-3.825.0.tgz",
+      "integrity": "sha512-r0V0rlNCjnFLfYfUqP6TlwAo+YgWxIkrgUb/K6mV2XCBElbFZlc9oPzMOJCmHF/+D6S60FLlMC9AnFopnEZ3/A==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/core": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/fetch-http-handler": "^5.0.4",
        "@smithy/node-http-handler": "^4.0.6",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/protocol-http": "^5.1.2",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.2",
        "@smithy/types": "^4.3.1",
        "@smithy/util-stream": "^4.2.2",
        "tslib": "^2.6.2"
@@ -468,18 +584,18 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-ini": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.823.0.tgz",
-      "integrity": "sha512-C0o63qviK5yFvjH9zKWAnCUBkssJoQ1A1XAHe0IAQkurzoNBSmu9oVemqwnKKHA4H6QrmusaEERfL00yohIkJA==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.825.0.tgz",
+      "integrity": "sha512-HDYopAiIGTLLhybI8jEuKGWdVUnKkkotwXHwvu8ttL5qgs13A6a/iWiREe71fmYH2fGT2URJE9+xeHa2oxohyQ==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/core": "3.823.0",
-        "@aws-sdk/credential-provider-env": "3.823.0",
-        "@aws-sdk/credential-provider-http": "3.823.0",
-        "@aws-sdk/credential-provider-process": "3.823.0",
-        "@aws-sdk/credential-provider-sso": "3.823.0",
-        "@aws-sdk/credential-provider-web-identity": "3.823.0",
-        "@aws-sdk/nested-clients": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/credential-provider-env": "3.825.0",
+        "@aws-sdk/credential-provider-http": "3.825.0",
+        "@aws-sdk/credential-provider-process": "3.825.0",
+        "@aws-sdk/credential-provider-sso": "3.825.0",
+        "@aws-sdk/credential-provider-web-identity": "3.825.0",
+        "@aws-sdk/nested-clients": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/credential-provider-imds": "^4.0.6",
        "@smithy/property-provider": "^4.0.4",
@@ -492,17 +608,17 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-node": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-node/-/credential-provider-node-3.823.0.tgz",
-      "integrity": "sha512-nfSxXVuZ+2GJDpVFlflNfh55Yb4BtDsXLGNssXF5YU6UgSPsi8j2YkaE92Jv2s7dlUK07l0vRpLyPuXMaGeiRQ==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-node/-/credential-provider-node-3.825.0.tgz",
+      "integrity": "sha512-qWMrrUgWFQN7nkMdQYzWF/Z/fhUctCjwTQQD/qNSs42qt3sxmC00SZcqwPn9N8S9R/hLmu5z6fefVF4o20nGng==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/credential-provider-env": "3.823.0",
-        "@aws-sdk/credential-provider-http": "3.823.0",
-        "@aws-sdk/credential-provider-ini": "3.823.0",
-        "@aws-sdk/credential-provider-process": "3.823.0",
-        "@aws-sdk/credential-provider-sso": "3.823.0",
-        "@aws-sdk/credential-provider-web-identity": "3.823.0",
+        "@aws-sdk/credential-provider-env": "3.825.0",
+        "@aws-sdk/credential-provider-http": "3.825.0",
+        "@aws-sdk/credential-provider-ini": "3.825.0",
+        "@aws-sdk/credential-provider-process": "3.825.0",
+        "@aws-sdk/credential-provider-sso": "3.825.0",
+        "@aws-sdk/credential-provider-web-identity": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/credential-provider-imds": "^4.0.6",
        "@smithy/property-provider": "^4.0.4",
@@ -515,12 +631,12 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-process": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-process/-/credential-provider-process-3.823.0.tgz",
-      "integrity": "sha512-U/A10/7zu2FbMFFVpIw95y0TZf+oYyrhZTBn9eL8zgWcrYRqxrxdqtPj/zMrfIfyIvQUhuJSENN4dx4tfpCMWQ==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-process/-/credential-provider-process-3.825.0.tgz",
+      "integrity": "sha512-QQoOBQAXuBfD6BCg61Hl5EkdrLyFSQCNRHVLjAO5WYQGyiPb9iTZPqo9sPwyOnCMpZE1k2EOwQ+FsnZh0xSa3Q==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/core": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/shared-ini-file-loader": "^4.0.4",
@@ -532,14 +648,14 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-sso": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.823.0.tgz",
-      "integrity": "sha512-ff8IM80Wqz1V7VVMaMUqO2iR417jggfGWLPl8j2l7uCgwpEyop1ZZl5CFVYEwSupRBtwp+VlW1gTCk7ke56MUw==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.825.0.tgz",
+      "integrity": "sha512-ppwsN8tuwwJKvNnllkrhIx7AQv4r5uiNf5FTIkyeJ+3p67wgJeJye+0SP64IEkdmG7YxCaU2YkdSvyHud+D5og==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/client-sso": "3.823.0",
-        "@aws-sdk/core": "3.823.0",
-        "@aws-sdk/token-providers": "3.823.0",
+        "@aws-sdk/client-sso": "3.825.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/token-providers": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/shared-ini-file-loader": "^4.0.4",
@@ -551,13 +667,13 @@
      }
    },
    "node_modules/@aws-sdk/credential-provider-web-identity": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-web-identity/-/credential-provider-web-identity-3.823.0.tgz",
-      "integrity": "sha512-lzoZdJMQq9w7i4lXVka30cVBe/dZoUDZST8Xz/soEd73gg7RTKgG+0szL4xFWgdBDgcJDWLfZfJzlbyIVyAyOA==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-web-identity/-/credential-provider-web-identity-3.825.0.tgz",
+      "integrity": "sha512-cyL5xHqtvBUpflkmdQSkvjD/t+Dl/ZSXvPnc9KF79xDpuraZ5tFP1l0B6rIEu7dUzUh8XG+7m2CZ6TEs6QU33Q==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/core": "3.823.0",
-        "@aws-sdk/nested-clients": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/nested-clients": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/types": "^4.3.1",
@@ -568,25 +684,25 @@
      }
    },
    "node_modules/@aws-sdk/credential-providers": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-providers/-/credential-providers-3.823.0.tgz",
-      "integrity": "sha512-S2iWP7+/lmaGJnGMoAipRlwRqOvd+5aWEJwdCSUCipR7cH+u/biRSbynBGrYvxjqqhyIagxjYn5gGYCX+x1v4g==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/credential-providers/-/credential-providers-3.825.0.tgz",
+      "integrity": "sha512-V4AaXB3oH+1lQS9lMp6+Iu3TPETdqVCktiqop3CknrjlYmtISt/vwcQ6GLWQskm1lsfewlfIsERwu5FDbHokEQ==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/client-cognito-identity": "3.823.0",
-        "@aws-sdk/core": "3.823.0",
-        "@aws-sdk/credential-provider-cognito-identity": "3.823.0",
-        "@aws-sdk/credential-provider-env": "3.823.0",
-        "@aws-sdk/credential-provider-http": "3.823.0",
-        "@aws-sdk/credential-provider-ini": "3.823.0",
-        "@aws-sdk/credential-provider-node": "3.823.0",
-        "@aws-sdk/credential-provider-process": "3.823.0",
-        "@aws-sdk/credential-provider-sso": "3.823.0",
-        "@aws-sdk/credential-provider-web-identity": "3.823.0",
-        "@aws-sdk/nested-clients": "3.823.0",
+        "@aws-sdk/client-cognito-identity": "3.825.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/credential-provider-cognito-identity": "3.825.0",
+        "@aws-sdk/credential-provider-env": "3.825.0",
+        "@aws-sdk/credential-provider-http": "3.825.0",
+        "@aws-sdk/credential-provider-ini": "3.825.0",
+        "@aws-sdk/credential-provider-node": "3.825.0",
+        "@aws-sdk/credential-provider-process": "3.825.0",
+        "@aws-sdk/credential-provider-sso": "3.825.0",
+        "@aws-sdk/credential-provider-web-identity": "3.825.0",
+        "@aws-sdk/nested-clients": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/config-resolver": "^4.1.4",
-        "@smithy/core": "^3.5.1",
+        "@smithy/core": "^3.5.2",
        "@smithy/credential-provider-imds": "^4.0.6",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/property-provider": "^4.0.4",
@@ -642,15 +758,15 @@
      }
    },
    "node_modules/@aws-sdk/middleware-user-agent": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/middleware-user-agent/-/middleware-user-agent-3.823.0.tgz",
-      "integrity": "sha512-TKRQK09ld1LrIPExC9rIDpqnMsWcv+eq8ABKFHVo8mDLTSuWx/IiQ4eCh9T5zDuEZcLY4nNYCSzXKqw6XKcMCA==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/middleware-user-agent/-/middleware-user-agent-3.825.0.tgz",
+      "integrity": "sha512-3ZZOPU3GE5cqKl6VFDwiL8KIvlrrQJ4rgYkeiF+m5kA0eXV2xFOwoLgm3AmPB+6kfo9HQ0N74KKJV0teS5nO6Q==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/core": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@aws-sdk/util-endpoints": "3.821.0",
-        "@smithy/core": "^3.5.1",
+        "@smithy/core": "^3.5.2",
        "@smithy/protocol-http": "^5.1.2",
        "@smithy/types": "^4.3.1",
        "tslib": "^2.6.2"
@@ -660,44 +776,44 @@
      }
    },
    "node_modules/@aws-sdk/nested-clients": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/nested-clients/-/nested-clients-3.823.0.tgz",
-      "integrity": "sha512-/BcyOBubrJnd2gxlbbmNJR1w0Z3OVN/UE8Yz20e+ou+Mijjv7EbtVwmWvio1e3ZjphwdA8tVfPYZKwXmrvHKmQ==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/nested-clients/-/nested-clients-3.825.0.tgz",
+      "integrity": "sha512-OuV2pypFAv52Lty8eXWVWyyOywVmMAsgH6Gq3SA06pHEtcE+ghVIW9ByegecyfMRUpedAiovARKNy0pfGX05Pg==",
      "license": "Apache-2.0",
      "dependencies": {
        "@aws-crypto/sha256-browser": "5.2.0",
        "@aws-crypto/sha256-js": "5.2.0",
-        "@aws-sdk/core": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
        "@aws-sdk/middleware-host-header": "3.821.0",
        "@aws-sdk/middleware-logger": "3.821.0",
        "@aws-sdk/middleware-recursion-detection": "3.821.0",
-        "@aws-sdk/middleware-user-agent": "3.823.0",
+        "@aws-sdk/middleware-user-agent": "3.825.0",
        "@aws-sdk/region-config-resolver": "3.821.0",
        "@aws-sdk/types": "3.821.0",
        "@aws-sdk/util-endpoints": "3.821.0",
        "@aws-sdk/util-user-agent-browser": "3.821.0",
-        "@aws-sdk/util-user-agent-node": "3.823.0",
+        "@aws-sdk/util-user-agent-node": "3.825.0",
        "@smithy/config-resolver": "^4.1.4",
-        "@smithy/core": "^3.5.1",
+        "@smithy/core": "^3.5.2",
        "@smithy/fetch-http-handler": "^5.0.4",
        "@smithy/hash-node": "^4.0.4",
        "@smithy/invalid-dependency": "^4.0.4",
        "@smithy/middleware-content-length": "^4.0.4",
-        "@smithy/middleware-endpoint": "^4.1.9",
-        "@smithy/middleware-retry": "^4.1.10",
+        "@smithy/middleware-endpoint": "^4.1.10",
+        "@smithy/middleware-retry": "^4.1.11",
        "@smithy/middleware-serde": "^4.0.8",
        "@smithy/middleware-stack": "^4.0.4",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/node-http-handler": "^4.0.6",
        "@smithy/protocol-http": "^5.1.2",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.2",
        "@smithy/types": "^4.3.1",
        "@smithy/url-parser": "^4.0.4",
        "@smithy/util-base64": "^4.0.0",
        "@smithy/util-body-length-browser": "^4.0.0",
        "@smithy/util-body-length-node": "^4.0.0",
-        "@smithy/util-defaults-mode-browser": "^4.0.17",
-        "@smithy/util-defaults-mode-node": "^4.0.17",
+        "@smithy/util-defaults-mode-browser": "^4.0.18",
+        "@smithy/util-defaults-mode-node": "^4.0.18",
        "@smithy/util-endpoints": "^3.0.6",
        "@smithy/util-middleware": "^4.0.4",
        "@smithy/util-retry": "^4.0.5",
@@ -789,13 +905,13 @@
      }
    },
    "node_modules/@aws-sdk/token-providers": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/token-providers/-/token-providers-3.823.0.tgz",
-      "integrity": "sha512-vz6onCb/+g4y+owxGGPMEMdN789dTfBOgz/c9pFv0f01840w9Rrt46l+gjQlnXnx+0KG6wNeBIVhFdbCfV3HyQ==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/token-providers/-/token-providers-3.825.0.tgz",
+      "integrity": "sha512-a3HbF6h1Gq2vA+mGlxFe3op65wNK6dBRmp3GFwsPVQ+OFTbZJi86FCljMfBrv+BGYUkp503/IPC49wuRHOdcZA==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/core": "3.823.0",
-        "@aws-sdk/nested-clients": "3.823.0",
+        "@aws-sdk/core": "3.825.0",
+        "@aws-sdk/nested-clients": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/property-provider": "^4.0.4",
        "@smithy/shared-ini-file-loader": "^4.0.4",
@@ -859,12 +975,12 @@
      }
    },
    "node_modules/@aws-sdk/util-user-agent-node": {
-      "version": "3.823.0",
-      "resolved": "https://registry.npmjs.org/@aws-sdk/util-user-agent-node/-/util-user-agent-node-3.823.0.tgz",
-      "integrity": "sha512-WvNeRz7HV3JLBVGTXW4Qr5QvvWY0vtggH5jW/NqHFH+ZEliVQaUIJ/HNLMpMoCSiu/DlpQAyAjRZXAptJ0oqbw==",
+      "version": "3.825.0",
+      "resolved": "https://registry.npmjs.org/@aws-sdk/util-user-agent-node/-/util-user-agent-node-3.825.0.tgz",
+      "integrity": "sha512-RfB0w9YJSsFGsbrzOQ1VE2O4NwR6gxelUvmz8PzuerPCg4iD4JW7hSCmnoAEi51Xnq0bNeCsnhzXJzIlPe04jA==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@aws-sdk/middleware-user-agent": "3.823.0",
+        "@aws-sdk/middleware-user-agent": "3.825.0",
        "@aws-sdk/types": "3.821.0",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/types": "^4.3.1",
@@ -2513,9 +2629,9 @@
      }
    },
    "node_modules/@smithy/core": {
-      "version": "3.5.1",
-      "resolved": "https://registry.npmjs.org/@smithy/core/-/core-3.5.1.tgz",
-      "integrity": "sha512-xSw7bZEFKwOKrm/iv8e2BLt2ur98YZdrRD6nII8ditQeUsY2Q1JmIQ0rpILOhaLKYxxG2ivnoOpokzr9qLyDWA==",
+      "version": "3.5.3",
+      "resolved": "https://registry.npmjs.org/@smithy/core/-/core-3.5.3.tgz",
+      "integrity": "sha512-xa5byV9fEguZNofCclv6v9ra0FYh5FATQW/da7FQUVTic94DfrN/NvmKZjrMyzbpqfot9ZjBaO8U1UeTbmSLuA==",
      "license": "Apache-2.0",
      "dependencies": {
        "@smithy/middleware-serde": "^4.0.8",
@@ -2619,12 +2735,12 @@
      }
    },
    "node_modules/@smithy/middleware-endpoint": {
-      "version": "4.1.9",
-      "resolved": "https://registry.npmjs.org/@smithy/middleware-endpoint/-/middleware-endpoint-4.1.9.tgz",
-      "integrity": "sha512-AjDgX4UjORLltD/LZCBQTwjQqEfyrx/GeDTHcYLzIgf87pIT70tMWnN87NQpJru1K4ITirY2htSOxNECZJCBOg==",
+      "version": "4.1.11",
+      "resolved": "https://registry.npmjs.org/@smithy/middleware-endpoint/-/middleware-endpoint-4.1.11.tgz",
+      "integrity": "sha512-zDogwtRLzKl58lVS8wPcARevFZNBOOqnmzWWxVe9XiaXU2CADFjvJ9XfNibgkOWs08sxLuSr81NrpY4mgp9OwQ==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@smithy/core": "^3.5.1",
+        "@smithy/core": "^3.5.3",
        "@smithy/middleware-serde": "^4.0.8",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/shared-ini-file-loader": "^4.0.4",
@@ -2638,15 +2754,15 @@
      }
    },
    "node_modules/@smithy/middleware-retry": {
-      "version": "4.1.10",
-      "resolved": "https://registry.npmjs.org/@smithy/middleware-retry/-/middleware-retry-4.1.10.tgz",
-      "integrity": "sha512-RyhcA3sZIIvAo6r48b2Nx2qfg0OnyohlaV0fw415xrQyx5HQ2bvHl9vs/WBiDXIP49mCfws5wX4308c9Pi/isw==",
+      "version": "4.1.12",
+      "resolved": "https://registry.npmjs.org/@smithy/middleware-retry/-/middleware-retry-4.1.12.tgz",
+      "integrity": "sha512-wvIH70c4e91NtRxdaLZF+mbLZ/HcC6yg7ySKUiufL6ESp6zJUSnJucZ309AvG9nqCFHSRB5I6T3Ez1Q9wCh0Ww==",
      "license": "Apache-2.0",
      "dependencies": {
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/protocol-http": "^5.1.2",
        "@smithy/service-error-classification": "^4.0.5",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.3",
        "@smithy/types": "^4.3.1",
        "@smithy/util-middleware": "^4.0.4",
        "@smithy/util-retry": "^4.0.5",
@@ -2813,13 +2929,13 @@
      }
    },
    "node_modules/@smithy/smithy-client": {
-      "version": "4.4.1",
-      "resolved": "https://registry.npmjs.org/@smithy/smithy-client/-/smithy-client-4.4.1.tgz",
-      "integrity": "sha512-XPbcHRfd0iwx8dY5XCBCGyI7uweMW0oezYezxXcG8ANgvZ5YPuC6Ylh+n0bTHpdU3SCMZOnhzgVklYz+p3fIhw==",
+      "version": "4.4.3",
+      "resolved": "https://registry.npmjs.org/@smithy/smithy-client/-/smithy-client-4.4.3.tgz",
+      "integrity": "sha512-xxzNYgA0HD6ETCe5QJubsxP0hQH3QK3kbpJz3QrosBCuIWyEXLR/CO5hFb2OeawEKUxMNhz3a1nuJNN2np2RMA==",
      "license": "Apache-2.0",
      "dependencies": {
-        "@smithy/core": "^3.5.1",
-        "@smithy/middleware-endpoint": "^4.1.9",
+        "@smithy/core": "^3.5.3",
+        "@smithy/middleware-endpoint": "^4.1.11",
        "@smithy/middleware-stack": "^4.0.4",
        "@smithy/protocol-http": "^5.1.2",
        "@smithy/types": "^4.3.1",
@@ -2920,13 +3036,13 @@
      }
    },
    "node_modules/@smithy/util-defaults-mode-browser": {
-      "version": "4.0.17",
-      "resolved": "https://registry.npmjs.org/@smithy/util-defaults-mode-browser/-/util-defaults-mode-browser-4.0.17.tgz",
-      "integrity": "sha512-HXq5181qnXmIwB7VrwqwP8rsJybHMoYuJnNoXy4PROs2pfSI4sWDMASF2i+7Lo+u64Y6xowhegcdxczowgJtZg==",
+      "version": "4.0.19",
+      "resolved": "https://registry.npmjs.org/@smithy/util-defaults-mode-browser/-/util-defaults-mode-browser-4.0.19.tgz",
+      "integrity": "sha512-mvLMh87xSmQrV5XqnUYEPoiFFeEGYeAKIDDKdhE2ahqitm8OHM3aSvhqL6rrK6wm1brIk90JhxDf5lf2hbrLbQ==",
      "license": "Apache-2.0",
      "dependencies": {
        "@smithy/property-provider": "^4.0.4",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.3",
        "@smithy/types": "^4.3.1",
        "bowser": "^2.11.0",
        "tslib": "^2.6.2"
@@ -2936,16 +3052,16 @@
      }
    },
    "node_modules/@smithy/util-defaults-mode-node": {
-      "version": "4.0.17",
-      "resolved": "https://registry.npmjs.org/@smithy/util-defaults-mode-node/-/util-defaults-mode-node-4.0.17.tgz",
-      "integrity": "sha512-RfU2A5LjFhEHw4Nwl1GZNitK4AUWu5jGtigAUDoQtfDUvYHpQxcuLw2QGAdKDtKRflIiHSZ8wXBDR36H9R2Ang==",
+      "version": "4.0.19",
+      "resolved": "https://registry.npmjs.org/@smithy/util-defaults-mode-node/-/util-defaults-mode-node-4.0.19.tgz",
+      "integrity": "sha512-8tYnx+LUfj6m+zkUUIrIQJxPM1xVxfRBvoGHua7R/i6qAxOMjqR6CpEpDwKoIs1o0+hOjGvkKE23CafKL0vJ9w==",
      "license": "Apache-2.0",
      "dependencies": {
        "@smithy/config-resolver": "^4.1.4",
        "@smithy/credential-provider-imds": "^4.0.6",
        "@smithy/node-config-provider": "^4.1.3",
        "@smithy/property-provider": "^4.0.4",
-        "@smithy/smithy-client": "^4.4.1",
+        "@smithy/smithy-client": "^4.4.3",
        "@smithy/types": "^4.3.1",
        "tslib": "^2.6.2"
      },
@@ -3109,9 +3225,9 @@
      "license": "MIT"
    },
    "node_modules/@types/node": {
-      "version": "22.15.29",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.15.29.tgz",
-      "integrity": "sha512-LNdjOkUDlU1RZb8e1kOIUpN1qQUlzGkEtbVNo53vbrwDg5om6oduhm4SiUaPW5ASTXhAiP0jInWG8Qx9fVlOeQ==",
+      "version": "22.15.30",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.15.30.tgz",
+      "integrity": "sha512-6Q7lr06bEHdlfplU6YRbgG1SFBdlsfNC4/lX+SkhiTs0cpJkOElmWls8PxDFv4yY/xKb8Y6SO0OmSX4wgqTZbA==",
      "license": "MIT",
      "dependencies": {
        "undici-types": "~6.21.0"
@@ -3131,6 +3247,12 @@
      "dev": true,
      "license": "MIT"
    },
+    "node_modules/@types/uuid": {
+      "version": "9.0.8",
+      "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-9.0.8.tgz",
+      "integrity": "sha512-jg+97EGIcY9AGHJJRaaPVgetKDsrTgbRjQ5Msgjh/DQKEFl0DtyRr/VCOyD1T2R1MNeWPK/u7JoGhlDZnKBAfA==",
+      "license": "MIT"
+    },
    "node_modules/@types/ws": {
      "version": "8.18.1",
      "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz",
--- a/package.json
+++ b/package.json
@@ -46,7 +46,8 @@
    "build:docs": "typedoc"
  },
  "dependencies": {
-    "@aws-sdk/credential-providers": "3.823.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.5",
    "dayjs": "1.11.13",
@@ -56,7 +57,7 @@
    "@eslint/js": "9.28.0",
    "@semantic-release/npm": "12.0.1",
    "@types/lodash": "4.17.17",
-    "@types/node": "22.15.29",
+    "@types/node": "22.15.30",
    "conventional-changelog-conventionalcommits": "9.0.0",
    "dotenv": "16.5.0",
    "eslint": "9.28.0",
--- a/src/api/MysaApiClient.ts
+++ b/src/api/MysaApiClient.ts
@@ -7,6 +7,7 @@ import { InMessageType } from '@/types/mqtt/in/InMessageType';
 import { StartPublishingDeviceStatus } from '@/types/mqtt/in/StartPublishingDeviceStatus';
 import { OutMessageType } from '@/types/mqtt/out/OutMessageType';
 import { Devices, DeviceStates, Firmwares } from '@/types/rest';
+import { DescribeThingCommand, IoTClient } from '@aws-sdk/client-iot';
 import { fromCognitoIdentityPool } from '@aws-sdk/credential-providers';
 import {
  AuthenticationDetails,
@@ -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...`);
@@ -195,6 +225,70 @@ 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...`);

@@ -213,6 +307,13 @@ export class MysaApiClient {
    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...`);

@@ -231,6 +332,31 @@ export class MysaApiClient {
    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}'`);

@@ -285,7 +411,23 @@ 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 real-time updates for device '${deviceId}'`);
@@ -329,7 +471,11 @@ 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}'`);
@@ -350,6 +496,15 @@ export class MysaApiClient {
    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.');
@@ -379,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;
@@ -420,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);
Author	SHA1	Message	Date
Pascal Bourque	17f277e844	docs: Added missing TSDoc comments (#19 )	2025-06-07 10:08:05 -04:00
Pascal Bourque	6a88e52702	feat: Added `getDeviceSerialNumber()` API (#18 )	2025-06-07 09:57:28 -04:00
dependabot[bot]	d6971453d2	chore(deps-dev): Bump @types/node from 22.15.29 to 22.15.30 in the dev-dependencies group (#16 )	2025-06-06 12:21:38 +00:00
dependabot[bot]	8769928622	chore(deps): Bump @aws-sdk/credential-providers from 3.823.0 to 3.825.0 (#17 )	2025-06-06 12:21:26 +00:00