homebridge-plugin-utils 1.2.0 → 1.4.0

package/build/eslint-rules.mjs

@@ -141,8 +141,12 @@ const tsRules = {
   "@typescript-eslint/no-explicit-any": "warn",
   "@typescript-eslint/no-floating-promises": ["warn", { "ignoreIIFE": true }],
   "@typescript-eslint/no-non-null-assertion": "warn",
+  "@typescript-eslint/no-unused-expressions": "warn",
+  "@typescript-eslint/no-unused-vars": "warn",
+  "@typescript-eslint/promise-function-async": "warn",
   "no-dupe-class-members": "off",
   "no-undef": "off",
+  "no-unused-expressions": "off",
   "no-unused-vars": "off"
 };
 
@@ -150,7 +154,8 @@ const tsRules = {
 const jsRules = {
 
   ...tsEslint.configs.disableTypeChecked,
-  "@typescript-eslint/no-floating-promises": "off"
+  "@typescript-eslint/no-floating-promises": "off",
+  "require-await": "warn"
 };
 
 // Rules that exist across both JavaScript and TypeScript files.
@@ -209,6 +214,7 @@ const commonRules = {
   "no-await-in-loop": "warn",
   "no-console": "warn",
   "prefer-arrow-callback": "warn",
+  "prefer-const": "warn",
   "quotes": ["warn", "double", { "avoidEscape": true }],
   "sort-imports": "warn",
   "sort-keys": "warn",

package/dist/ui/webUi-featureoptions.mjs

@@ -336,7 +336,7 @@ export class webUiFeatureOptions {
   }
 
   // Show feature option information for a specific device, controller, or globally.
-  async showDeviceOptions(deviceId) {
+  showDeviceOptions(deviceId) {
 
     homebridge.showSpinner();
 
@@ -742,7 +742,7 @@ export class webUiFeatureOptions {
   }
 
   // Default method for enumerating the device list in the sidebar.
-  async #showSidebarDevices() {
+  #showSidebarDevices() {
 
     // Show the devices list only if we have actual devices to show.
     if(!this.devices?.length) {

package/dist/utils.d.ts

@@ -28,4 +28,4 @@ export interface HomebridgePluginLogging {
     warn: (message: string, ...parameters: unknown[]) => void;
 }
 export declare function sleep(sleepTimer: number): Promise<NodeJS.Timeout>;
-export declare function retry(operation: () => Promise<boolean>, retryInterval: number): Promise<boolean>;
+export declare function retry(operation: () => Promise<boolean>, retryInterval: number, totalRetries?: number): Promise<boolean>;

package/dist/utils.js

@@ -3,16 +3,19 @@
  * utils.ts: Useful utility functions when writing TypeScript.
  */
 // Emulate a sleep function.
-export function sleep(sleepTimer) {
+export async function sleep(sleepTimer) {
     return new Promise(resolve => setTimeout(resolve, sleepTimer));
 }
 // Retry an operation until we're successful.
-export async function retry(operation, retryInterval) {
+export async function retry(operation, retryInterval, totalRetries) {
+    if ((totalRetries !== undefined) && (totalRetries < 0)) {
+        return false;
+    }
     // Try the operation that was requested.
     if (!(await operation())) {
         // If the operation wasn't successful, let's sleep for the requested interval and try again.
         await sleep(retryInterval);
-        return retry(operation, retryInterval);
+        return retry(operation, retryInterval, (totalRetries === undefined) ? undefined : totalRetries--);
     }
     // We were successful - we're done.
     return true;

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA4CH,4BAA4B;AAC5B,MAAM,UAAU,KAAK,CAAC,UAAkB;IAEtC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,6CAA6C;AAC7C,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,SAAiC,EAAE,aAAqB;IAElF,wCAAwC;IACxC,IAAG,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,EAAE,CAAC;QAExB,4FAA4F;QAC5F,MAAM,KAAK,CAAC,aAAa,CAAC,CAAC;QAE3B,OAAO,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IACzC,CAAC;IAED,mCAAmC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA4CH,4BAA4B;AAC5B,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,UAAkB;IAE5C,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,6CAA6C;AAC7C,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,SAAiC,EAAE,aAAqB,EAAE,YAAqB;IAEzG,IAAG,CAAC,YAAY,KAAK,SAAS,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wCAAwC;IACxC,IAAG,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,EAAE,CAAC;QAExB,4FAA4F;QAC5F,MAAM,KAAK,CAAC,aAAa,CAAC,CAAC;QAE3B,OAAO,KAAK,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC;IACpG,CAAC;IAED,mCAAmC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-plugin-utils",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "displayName": "Homebridge Plugin Utilities",
   "description": "Opinionated utilities to provide common capabilities and create rich configuration webUI experiences for Homebridge plugins.",
   "author": {
@@ -40,11 +40,11 @@
   "main": "dist/index.js",
   "devDependencies": {
     "@stylistic/eslint-plugin": "2.1.0",
-    "@types/node": "20.13.0",
+    "@types/node": "20.14.2",
     "eslint": "8.57.0",
     "shx": "^0.3.4",
     "typescript": "5.4.5",
-    "typescript-eslint": "^7.11.0"
+    "typescript-eslint": "^7.12.0"
   },
   "dependencies": {
     "mqtt": "^5.7.0"