homebridge-plugin-utils 1.15.3 → 1.17.0

package/dist/util.d.ts

@@ -1,35 +1,133 @@
 /**
- * @internal
+ * TypeScript Utilities.
  *
- * A utility type that recursively makes all properties of an object, including nested objects, optional. This should only be used on JSON objects only. Otherwise,
- * you're going to end up with class methods marked as optional as well. Credit for this belongs to: https://github.com/joonhocho/tsdef.
+ * @module
+ */
+/**
+ * A utility type that recursively makes all properties of an object, including nested objects, optional.
+ *
+ * This should only be used on JSON objects. If used on classes, class methods will also be marked as optional.
+ *
+ * @remarks Credit for this type goes to: https://github.com/joonhocho/tsdef.
+ *
+ * @typeParam T - The type to make recursively partial.
+ *
+ * @example
+ *
+ * ```ts
+ * type Original = {
+ *
+ *   id: string;
+ *   nested: { value: number };
+ * };
+ *
+ * // All properties, including nested ones, are optional.
+ * type PartialObj = DeepPartial<Original>;
  *
- * @template T - The type to make recursively partial.
+ * const obj: PartialObj = { nested: {} };
+ * ```
+ *
+ * @category Utilities
  */
 export type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends Array<infer I> ? Array<DeepPartial<I>> : DeepPartial<T[P]>;
 };
 /**
- * @internal
+ * A utility type that recursively makes all properties of an object, including nested objects, readonly.
+ *
+ * This should only be used on JSON objects. If used on classes, class methods will also be marked as readonly.
+ *
+ * @remarks Credit for this type goes to: https://github.com/joonhocho/tsdef.
+ *
+ * @typeParam T - The type to make recursively readonly.
+ *
+ * @example
+ *
+ * ```ts
+ * type Original = {
+ *   id: string;
+ *   nested: { value: number };
+ * };
+ *
+ * // All properties, including nested ones, are readonly.
+ * type ReadonlyObj = DeepReadonly<Original>;
  *
- * A utility type that recursively makes all properties of an object, including nested objects, optional. This should only be used on JSON objects only. Otherwise,
- * you're going to end up with class methods marked as optional as well. Credit for this belongs to: https://github.com/joonhocho/tsdef.
+ * const obj: ReadonlyObj = { id: "a", nested: { value: 1 } };
+ * // obj.id = "b"; // Error: cannot assign to readonly property.
+ * ```
  *
- * @template T - The type to make recursively partial.
+ * @category Utilities
  */
 export type DeepReadonly<T> = {
     readonly [P in keyof T]: T[P] extends Array<infer I> ? Array<DeepReadonly<I>> : DeepReadonly<T[P]>;
 };
 /**
- * @internal
+ * Utility type that allows a value to be either the given type or `null`.
+ *
+ * This type is used to explicitly indicate that a variable, property, or return value may be either a specific type or `null`.
+ *
+ * @typeParam T - The type to make nullable.
+ *
+ * @example
  *
- * A utility type that makes a given type assignable to it's type or null.
+ * ```ts
+ * let id: Nullable<string> = null;
+ *
+ * // Later...
+ * id = "device-001";
+ * ```
+ *
+ * @category Utilities
  */
 export type Nullable<T> = T | null;
+/**
+ * Logging interface for Homebridge plugins.
+ *
+ * This interface defines the standard logging methods (`debug`, `info`, `warn`, `error`) that plugins should use to output log messages at different severity levels. It
+ * is intended to be compatible with Homebridge's builtin logger and can be implemented by any custom logger used within Homebridge plugins.
+ *
+ * @example
+ *
+ * ```ts
+ * function example(log: HomebridgePluginLogging) {
+ *
+ *   log.debug("Debug message: %s", "details");
+ *   log.info("Informational message.");
+ *   log.warn("Warning message!");
+ *   log.error("Error message: %s", "problem");
+ * }
+ * ```
+ *
+ * @category Utilities
+ */
 export interface HomebridgePluginLogging {
+    /**
+     * Logs a debug-level message.
+     *
+     * @param message    - The message string, with optional format specifiers.
+     * @param parameters - Optional parameters for message formatting.
+     */
     debug: (message: string, ...parameters: unknown[]) => void;
+    /**
+     * Logs an error-level message.
+     *
+     * @param message    - The message string, with optional format specifiers.
+     * @param parameters - Optional parameters for message formatting.
+     */
     error: (message: string, ...parameters: unknown[]) => void;
+    /**
+     * Logs an info-level message.
+     *
+     * @param message    - The message string, with optional format specifiers.
+     * @param parameters - Optional parameters for message formatting.
+     */
     info: (message: string, ...parameters: unknown[]) => void;
+    /**
+     * Logs a warning-level message.
+     *
+     * @param message    - The message string, with optional format specifiers.
+     * @param parameters - Optional parameters for message formatting.
+     */
     warn: (message: string, ...parameters: unknown[]) => void;
 }
 /**
@@ -38,10 +136,20 @@ export interface HomebridgePluginLogging {
  * @param value           - The bitrate value to convert.
  *
  * @returns Returns the value as a human-readable string.
+ * @example
+ *
+ * ```ts
+ * formatBps(500);        // "500 bps".
+ * formatBps(2000);       // "2.0 kbps".
+ * formatBps(15000);      // "15.0 kbps".
+ * formatBps(1000000);    // "1.0 Mbps".
+ * formatBps(2560000);    // "2.6 Mbps".
+ * ```
  */
 export declare function formatBps(value: number): string;
 /**
  * A utility method that retries an operation at a specific interval for up to an absolute total number of retries.
+ *
  * @param operation       - The operation callback to try until successful.
  * @param retryInterval   - Interval to retry, in milliseconds.
  * @param totalRetries    - Optionally, specify the total number of retries.
@@ -50,18 +158,101 @@ export declare function formatBps(value: number): string;
  *
  * @remarks `operation` must be an asynchronous function that returns `true` when successful, and `false` otherwise.
  *
+ * @example
+ * ```ts
+ * // Example: Retry an async operation up to 5 times, waiting 1 second between each try.
+ * let attempt = 0;
+ * const result = await retry(async () => {
+ *
+ *   attempt++;
+ *
+ *   // Simulate a 50% chance of success
+ *   return Math.random() > 0.5 || attempt === 5;
+ * }, 1000, 5);
+ *
+ * console.log(result); // true if operation succeeded within 5 tries, otherwise false.
+ * ```
+ *
  * @category Utilities
  */
 export declare function retry(operation: () => Promise<boolean>, retryInterval: number, totalRetries?: number): Promise<boolean>;
+/**
+ * Run a promise with a guaranteed timeout to complete.
+ *
+ * @typeParam T           - The type of value the promise resolves with.
+ * @param promise         - The promise you want to run.
+ * @param timeout         - The amount of time, in milliseconds, to wait for the promise to resolve.
+ *
+ * @returns Returns the result of resolving the promise it's been passed if it completes before timeout, or null if the timeout expires.
+ *
+ * @example
+ * ```ts
+ * // Resolves in 100ms, timeout is 500ms, so it resolves to 42.
+ * const result = await runWithTimeout(Promise.resolve(42), 500);
+ * console.log(result); // 42
+ *
+ * // Resolves in 1000ms, timeout is 500ms, so it resolves to null.
+ * const slowPromise = new Promise<number>(resolve => setTimeout(() => resolve(42), 1000));
+ * const result2 = await runWithTimeout(slowPromise, 500);
+ * console.log(result2); // null
+ * ```
+ *
+ * @category Utilities
+ */
 export declare function runWithTimeout<T>(promise: Promise<T>, timeout: number): Promise<Nullable<T>>;
+/**
+ * Emulate a sleep function.
+ *
+ * @param sleepTimer      - The amount of time to sleep, in milliseconds.
+ *
+ * @returns Returns a promise that resolves after the specified time elapses.
+ *
+ * @example
+ * To sleep for 3 seconds before continuing execute:
+ *
+ * ```ts
+ * await sleep(3000)
+ * ```
+ *
+ * @category Utilities
+ */
 export declare function sleep(sleepTimer: number): Promise<NodeJS.Timeout>;
 /**
- * A utility method that camel case's a string.
- * @param string       - The string to camel case.
+ * Camel case a string.
+ *
+ * @param input           - The string to camel case.
  *
  * @returns Returns the camel cased string.
  *
+ * @example
+ * ```ts
+ * toCamelCase(This is a test)
+ * ```
+ *
+ * Returns: `This Is A Test`, capitalizing the first letter of each word.
  * @category Utilities
  */
 export declare function toCamelCase(input: string): string;
+/**
+ * Validate an accessory name according to HomeKit naming conventions.
+ *
+ * @param name            - The name to validate.
+ *
+ * @returns Returns the HomeKit-validated version of the name, replacing invalid characters with a space and squashing multiple spaces.
+ *
+ * @remarks This validates names using [HomeKit's naming rulesets](https://developer.apple.com/design/human-interface-guidelines/homekit#Help-people-choose-useful-names):
+ *
+ * - Use only alphanumeric, space, and apostrophe characters.
+ * - Start and end with an alphabetic or numeric character.
+ * - Don’t include emojis.
+ *
+ * @example
+ * ```ts
+ * validateName("Test.Switch")
+ * ```ts
+ *
+ * Returns: `Test Switch`, replacing the period (an invalid character in HomeKit's naming ruleset) with a space.
+ *
+ * @category Utilities
+ */
 export declare function validateName(name: string): string;

package/dist/util.js

@@ -8,6 +8,15 @@
  * @param value           - The bitrate value to convert.
  *
  * @returns Returns the value as a human-readable string.
+ * @example
+ *
+ * ```ts
+ * formatBps(500);        // "500 bps".
+ * formatBps(2000);       // "2.0 kbps".
+ * formatBps(15000);      // "15.0 kbps".
+ * formatBps(1000000);    // "1.0 Mbps".
+ * formatBps(2560000);    // "2.6 Mbps".
+ * ```
  */
 export function formatBps(value) {
     // Return the bitrate as-is.
@@ -25,6 +34,7 @@ export function formatBps(value) {
 }
 /**
  * A utility method that retries an operation at a specific interval for up to an absolute total number of retries.
+ *
  * @param operation       - The operation callback to try until successful.
  * @param retryInterval   - Interval to retry, in milliseconds.
  * @param totalRetries    - Optionally, specify the total number of retries.
@@ -33,6 +43,21 @@ export function formatBps(value) {
  *
  * @remarks `operation` must be an asynchronous function that returns `true` when successful, and `false` otherwise.
  *
+ * @example
+ * ```ts
+ * // Example: Retry an async operation up to 5 times, waiting 1 second between each try.
+ * let attempt = 0;
+ * const result = await retry(async () => {
+ *
+ *   attempt++;
+ *
+ *   // Simulate a 50% chance of success
+ *   return Math.random() > 0.5 || attempt === 5;
+ * }, 1000, 5);
+ *
+ * console.log(result); // true if operation succeeded within 5 tries, otherwise false.
+ * ```
+ *
  * @category Utilities
  */
 export async function retry(operation, retryInterval, totalRetries) {
@@ -48,35 +73,93 @@ export async function retry(operation, retryInterval, totalRetries) {
     // We were successful - we're done.
     return true;
 }
-// Run a promise with a guaranteed timeout to complete.
+/**
+ * Run a promise with a guaranteed timeout to complete.
+ *
+ * @typeParam T           - The type of value the promise resolves with.
+ * @param promise         - The promise you want to run.
+ * @param timeout         - The amount of time, in milliseconds, to wait for the promise to resolve.
+ *
+ * @returns Returns the result of resolving the promise it's been passed if it completes before timeout, or null if the timeout expires.
+ *
+ * @example
+ * ```ts
+ * // Resolves in 100ms, timeout is 500ms, so it resolves to 42.
+ * const result = await runWithTimeout(Promise.resolve(42), 500);
+ * console.log(result); // 42
+ *
+ * // Resolves in 1000ms, timeout is 500ms, so it resolves to null.
+ * const slowPromise = new Promise<number>(resolve => setTimeout(() => resolve(42), 1000));
+ * const result2 = await runWithTimeout(slowPromise, 500);
+ * console.log(result2); // null
+ * ```
+ *
+ * @category Utilities
+ */
 export async function runWithTimeout(promise, timeout) {
     const timeoutPromise = new Promise((resolve) => setTimeout(() => resolve(null), timeout));
     return Promise.race([promise, timeoutPromise]);
 }
-// Emulate a sleep function.
+/**
+ * Emulate a sleep function.
+ *
+ * @param sleepTimer      - The amount of time to sleep, in milliseconds.
+ *
+ * @returns Returns a promise that resolves after the specified time elapses.
+ *
+ * @example
+ * To sleep for 3 seconds before continuing execute:
+ *
+ * ```ts
+ * await sleep(3000)
+ * ```
+ *
+ * @category Utilities
+ */
 export async function sleep(sleepTimer) {
     return new Promise(resolve => setTimeout(resolve, sleepTimer));
 }
 /**
- * A utility method that camel case's a string.
- * @param string       - The string to camel case.
+ * Camel case a string.
+ *
+ * @param input           - The string to camel case.
  *
  * @returns Returns the camel cased string.
  *
+ * @example
+ * ```ts
+ * toCamelCase(This is a test)
+ * ```
+ *
+ * Returns: `This Is A Test`, capitalizing the first letter of each word.
  * @category Utilities
  */
 export function toCamelCase(input) {
     return input.replace(/(^\w|\s+\w)/g, match => match.toUpperCase());
 }
-// Validate a name according to HomeKit naming conventions.
+/**
+ * Validate an accessory name according to HomeKit naming conventions.
+ *
+ * @param name            - The name to validate.
+ *
+ * @returns Returns the HomeKit-validated version of the name, replacing invalid characters with a space and squashing multiple spaces.
+ *
+ * @remarks This validates names using [HomeKit's naming rulesets](https://developer.apple.com/design/human-interface-guidelines/homekit#Help-people-choose-useful-names):
+ *
+ * - Use only alphanumeric, space, and apostrophe characters.
+ * - Start and end with an alphabetic or numeric character.
+ * - Don’t include emojis.
+ *
+ * @example
+ * ```ts
+ * validateName("Test.Switch")
+ * ```ts
+ *
+ * Returns: `Test Switch`, replacing the period (an invalid character in HomeKit's naming ruleset) with a space.
+ *
+ * @category Utilities
+ */
 export function validateName(name) {
-    // Validate our names using [HomeKit's naming rulesets](https://developer.apple.com/design/human-interface-guidelines/homekit#Help-people-choose-useful-names):
-    //
-    // - Use only alphanumeric, space, and apostrophe characters.
-    // - Start and end with an alphabetic or numeric character.
-    // - Don’t include emojis.
-    //
-    // Invalid characters will be replaced by a space, and multiple spaces will be squashed.
     return name.replace(/[^\p{L}\p{N} ']+/gu, " ").replace(/\s+/g, " ").trim();
 }
 //# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2CH;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IAErC,4BAA4B;IAC5B,IAAG,KAAK,GAAG,IAAI,EAAE,CAAC;QAEhB,OAAO,KAAK,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC;IACnC,CAAC;IAED,kCAAkC;IAClC,IAAG,KAAK,GAAG,OAAO,EAAE,CAAC;QAEnB,MAAM,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC;QAE1B,OAAO,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IAC1E,CAAC;IAED,kCAAkC;IAClC,MAAM,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC;IAE7B,OAAO,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAC1E,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,SAAiC,EAAE,aAAqB,EAAE,YAAqB;IAEzG,IAAG,CAAC,YAAY,KAAK,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,EAAE,CAAC;QAEvD,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,EAAE,YAAY,CAAC,CAAC;IACpG,CAAC;IAED,mCAAmC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,uDAAuD;AACvD,MAAM,CAAC,KAAK,UAAU,cAAc,CAAI,OAAmB,EAAE,OAAe;IAE1E,MAAM,cAAc,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAEhG,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC;AACjD,CAAC;AAED,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;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AACrE,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,YAAY,CAAC,IAAY;IAEvC,+JAA+J;IAC/J,EAAE;IACF,6DAA6D;IAC7D,2DAA2D;IAC3D,0BAA0B;IAC1B,EAAE;IACF,wFAAwF;IACxF,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAC7E,CAAC"}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiJH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IAErC,4BAA4B;IAC5B,IAAG,KAAK,GAAG,IAAI,EAAE,CAAC;QAEhB,OAAO,KAAK,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC;IACnC,CAAC;IAED,kCAAkC;IAClC,IAAG,KAAK,GAAG,OAAO,EAAE,CAAC;QAEnB,MAAM,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC;QAE1B,OAAO,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IAC1E,CAAC;IAED,kCAAkC;IAClC,MAAM,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC;IAE7B,OAAO,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,SAAiC,EAAE,aAAqB,EAAE,YAAqB;IAEzG,IAAG,CAAC,YAAY,KAAK,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,EAAE,CAAC;QAEvD,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,EAAE,YAAY,CAAC,CAAC;IACpG,CAAC;IAED,mCAAmC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAI,OAAmB,EAAE,OAAe;IAE1E,MAAM,cAAc,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAEhG,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,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;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IAEvC,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAC7E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-plugin-utils",
-  "version": "1.15.3",
+  "version": "1.17.0",
   "displayName": "Homebridge Plugin Utilities",
   "description": "Opinionated utilities to provide common capabilities and create rich configuration webUI experiences for Homebridge plugins.",
   "author": {
@@ -31,23 +31,27 @@
   ],
   "scripts": {
     "build": "npm run clean && tsc && shx cp dist/featureoptions.js{,.map} dist/ui",
+    "build-docs": "shx rm -f ./docs/[^CO]*.md ./docs/ffmpeg/*.md && npx typedoc",
     "build-ui": "shx mkdir -p dist/ui && shx cp ui/**.mjs dist/ui",
     "clean": "shx rm -rf dist && npm run build-ui",
-    "lint": "eslint --max-warnings=${ESLINT_MAX_WARNINGS:-\"-1\"} eslint.config.mjs build/**.mjs src/**.ts \"ui/**/*.@(js|mjs)\"",
+    "lint": "eslint --max-warnings=${ESLINT_MAX_WARNINGS:-\"-1\"} eslint.config.mjs build/**.mjs src \"ui/**/*.@(js|mjs)\"",
     "postpublish": "npm run clean",
     "prepublishOnly": "npm run lint && npm run build"
   },
   "main": "dist/index.js",
   "devDependencies": {
-    "@stylistic/eslint-plugin": "4.2.0",
-    "@types/node": "22.13.10",
-    "eslint": "^9.22.0",
-    "homebridge": "1.8.4",
-    "shx": "0.3.4",
-    "typescript": "5.8.2",
-    "typescript-eslint": "^8.26.1"
+    "@stylistic/eslint-plugin": "4.4.0",
+    "@types/node": "22.15.21",
+    "@types/ws": "^8.18.1",
+    "eslint": "^9.27.0",
+    "homebridge": "1.9.0",
+    "shx": "0.4.0",
+    "typedoc": "0.28.4",
+    "typedoc-plugin-markdown": "4.6.3",
+    "typescript": "5.8.3",
+    "typescript-eslint": "^8.32.1"
   },
   "dependencies": {
-    "mqtt": "5.10.4"
+    "mqtt": "5.13.0"
   }
 }

package/dist/rtp.d.ts

@@ -1,32 +0,0 @@
-import { EventEmitter } from "node:events";
-import { HomebridgePluginLogging } from "./util.js";
-/**
- * Here's the problem this class solves: FFmpeg doesn't support multiplexing RTP and RTCP data on a single UDP port (RFC 5761). If it did, we wouldn't need this
- * workaround for HomeKit compatibility, which does multiplex RTP and RTCP over a single UDP port.
- *
- * This class inspects all packets coming in from inputPort and demultiplexes RTP and RTCP traffic to rtpPort and rtcpPort, respectively.
- *
- * Credit to @dgreif and @brandawg93 who graciously shared their code as a starting point, and their collaboration in answering the questions needed to bring all this
- * together. A special thank you to @Sunoo for the many hours of discussion and brainstorming on this and other topics.
- */
-export declare class RtpDemuxer extends EventEmitter {
-    private heartbeatTimer;
-    private heartbeatMsg;
-    private _isRunning;
-    private log?;
-    private inputPort;
-    readonly socket: import("dgram").Socket;
-    constructor(ipFamily: ("ipv4" | "ipv6"), inputPort: number, rtcpPort: number, rtpPort: number, log: HomebridgePluginLogging);
-    private heartbeat;
-    close(): void;
-    private getPayloadType;
-    private isRtpMessage;
-    get isRunning(): boolean;
-}
-export declare class RtpPortAllocator {
-    private portsInUse;
-    constructor();
-    private getPort;
-    reserve(ipFamily?: ("ipv4" | "ipv6"), portCount?: (1 | 2), attempts?: number): Promise<number>;
-    cancel(port: number): void;
-}