matterbridge 3.5.0-dev-20260117-88ddbe4 → 3.5.0

package/dist/utils/inspector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspector.js","sourceRoot":"","sources":["../../src/utils/inspector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,+BAA+B;AAE/B,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IAAE,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;AAElI,OAAO,YAAY,MAAM,aAAa,CAAC;AAGvC,OAAO,EAAE,UAAU,EAA6B,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAkB1G,MAAM,OAAO,SAAU,SAAQ,YAA6B;IAQvC;IACA;IACA;IATX,OAAO,CAAsB;IAC7B,gBAAgB,CAAkB;IAElC,kBAAkB,GAAG,KAAK,CAAC;IAC3B,GAAG,CAAa;IAExB,YACmB,OAAe,WAAW,EAC1B,QAAiB,KAAK,EACtB,UAAmB,KAAK;QAEzC,KAAK,EAAE,CAAC;QAJS,SAAI,GAAJ,IAAI,CAAsB;QAC1B,UAAK,GAAL,KAAK,CAAiB;QACtB,YAAO,GAAP,OAAO,CAAiB;QAGzC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5E,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,8BAAgB,CAAC,2BAAc,EAAE,CAAC,CAAC;QAC1J,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,MAAM,CAAC;QAE/B,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACnB,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;YACvB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE;YACjB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YACnD,OAAO;QACT,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAE5C,yDAAyD;QACzD,SAAS,CAAC,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEhD,0DAA0D;QAC1D,SAAS,CAAC,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjD,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC1C,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,4BAA4B,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAExC,yCAAyC;YACzC,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;YAC7D,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;YACrD,IAAI,QAAQ,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;gBAClC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,IAAI,GAAG,QAAQ,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC/E,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACrC,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;oBAC7C,IAAI,CAAC;wBACH,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;4BAC5B,IAAI,IAAI,CAAC,KAAK;gCAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;4BAC1F,OAAO;wBACT,CAAC;wBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;wBAC7C,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAChC,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;oBACtG,CAAC;gBACH,CAAC,EAAE,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;YAC7F,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,OAAO;QACT,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAE5C,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACrD,2CAA2C;YAC3C,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACrC,6CAA6C;YAC7C,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAsC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACxF,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,2BAA2B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1G,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;YAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,aAAa,cAAc,CAAC,CAAC;YAC5E,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAEjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,IAAI,GAAG,QAAQ,GAAG,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QAC9F,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAC/E,OAAO;QACT,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAE/B,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;QACvC,MAAM,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,aAAa,eAAe,CAAC,CAAC;QAE9E,0EAA0E;QAC1E,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE3C,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,IAAI,GAAG,QAAQ,GAAG,EAAE,KAAK,CAAC,CAAC;QAErF,MAAM,MAAM,GAAG,iBAAiB,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QAC3D,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,MAAM,aAAa,GAAG,CAAC,GAAY,EAAE,EAAE;YACrC,aAAa,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QAC5F,CAAC,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpC,MAAM,cAAc,GAAG,CAAC,YAAmF,EAAE,EAAE;YAC7G,sEAAsE;YACtE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7C,uGAAuG;YACzG,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,mCAAmC,EAAE,cAAc,CAAC,CAAC;QACrE,IAAI,CAAC;YACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAClC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,+BAA+B,EAAE,CAAC,GAAG,EAAE,EAAE;oBAC1D,wEAAwE;oBACxE,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,mCAAmC,EAAE,cAAc,CAAC,CAAC;oBACvE,MAAM,QAAQ,GAAG,GAAG,EAAE;wBACpB,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;4BAC3B,IAAI,IAAI,CAAC,KAAK;gCAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,IAAI,GAAG,QAAQ,GAAG,EAAE,EAAE,CAAC,CAAC;4BAC1F,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;4BAC3C,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;4BAC3C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC7B,CAAC;6BAAM,IAAI,GAAG,EAAE,CAAC;4BACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;4BAC5F,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;4BAC3C,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;wBAC7C,CAAC;wBACD,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC;oBACF,0CAA0C;oBAC1C,IAAI,CAAC;wBACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC/B,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;wBAC/F,QAAQ,EAAE,CAAC;oBACb,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,OAA0B,OAAO,EAAE,YAA8B,OAAO;QAC1F,IAAI,MAAM,CAAC,EAAE,IAAI,OAAO,MAAM,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;YACjD,IAAI,CAAC;gBACH,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC/B,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,uBAAuB,IAAI,IAAI,SAAS,kBAAkB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;gBAChK,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,CAAC,EAAE,EAAE,CAAC;gBACZ,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,iDAAiD,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;gBACvJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,MAAM,sGAAsG,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;QACrK,CAAC;IACH,CAAC;CACF"}

package/dist/utils/isValid.d.ts

@@ -1,10 +1,103 @@
+/**
+ * This file contains the validation functions.
+ *
+ * @file isValid.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.1
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Checks if a given string is a valid IPv4 address.
+ *
+ * @param {string} ipv4Address - The string to be checked.
+ * @returns {boolean} - Returns true if the string is a valid IPv4 address, otherwise returns false.
+ */
 export declare function isValidIpv4Address(ipv4Address: string): boolean;
+/**
+ * Checks if a value is a valid number within the specified range.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} min - The minimum value allowed (optional).
+ * @param {number} max - The maximum value allowed (optional).
+ * @returns {value is number} Returns true if the value is a valid number within the specified range, otherwise false.
+ */
 export declare function isValidNumber(value: unknown, min?: number, max?: number): value is number;
+/**
+ * Checks if a value is a valid boolean.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @returns {value is boolean} `true` if the value is a valid boolean, `false` otherwise.
+ */
 export declare function isValidBoolean(value: unknown): value is boolean;
+/**
+ * Checks if a value is a valid string.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} minLength - The min string length (optional).
+ * @param {number} maxLength - The max string length (optional).
+ * @returns {value is string} A boolean indicating whether the value is a valid string.
+ */
 export declare function isValidString(value: unknown, minLength?: number, maxLength?: number): value is string;
+/**
+ * Checks if a value is a valid RegExp.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @returns {value is RegExp} A boolean indicating whether the value is a valid RegExp.
+ */
 export declare function isValidRegExp(value: unknown): value is RegExp;
+/**
+ * Checks if a value is a valid object.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} minLength - The min number of keys (optional).
+ * @param {number} maxLength - The max number of keys (optional).
+ * @returns {value is object} A boolean indicating whether the value is a valid object.
+ */
 export declare function isValidObject(value: unknown, minLength?: number, maxLength?: number): value is object;
+/**
+ * Checks if a value is a valid array.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} minLength - The min number of elements (optional).
+ * @param {number} maxLength - The max number of elements (optional).
+ * @returns {value is unknown[]} A boolean indicating whether the value is a valid array.
+ */
 export declare function isValidArray(value: unknown, minLength?: number, maxLength?: number): value is unknown[];
+/**
+ * Checks if the given value is null.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is null} `true` if the value is null, `false` otherwise.
+ */
 export declare function isValidNull(value: unknown): value is null;
+/**
+ * Checks if a value is undefined.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is undefined} `true` if the value is undefined, `false` otherwise.
+ */
 export declare function isValidUndefined(value: unknown): value is undefined;
+/**
+ * Converts a semantic version string like "6.11.0-1011-raspi" to a numeric version code like 61100.
+ * Format: major * 10000 + minor * 100 + patch
+ *
+ * @param {string} versionString The version string to parse
+ * @returns {number | undefined} A numeric version code or undefined if parsing fails
+ */
 export declare function parseVersionString(versionString: string): number | undefined;
+//# sourceMappingURL=isValid.d.ts.map

package/dist/utils/isValid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValid.d.ts","sourceRoot":"","sources":["../../src/utils/isValid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAG/D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKzF;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE/D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKrG;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE7D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAMrG;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,EAAE,CAKvG;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEzD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAEnE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB5E"}

package/dist/utils/isValid.js

@@ -1,7 +1,44 @@
+/**
+ * This file contains the validation functions.
+ *
+ * @file isValid.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.1
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Checks if a given string is a valid IPv4 address.
+ *
+ * @param {string} ipv4Address - The string to be checked.
+ * @returns {boolean} - Returns true if the string is a valid IPv4 address, otherwise returns false.
+ */
 export function isValidIpv4Address(ipv4Address) {
     const ipv4Regex = /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
     return ipv4Regex.test(ipv4Address);
 }
+/**
+ * Checks if a value is a valid number within the specified range.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} min - The minimum value allowed (optional).
+ * @param {number} max - The maximum value allowed (optional).
+ * @returns {value is number} Returns true if the value is a valid number within the specified range, otherwise false.
+ */
 export function isValidNumber(value, min, max) {
     if (value === undefined || value === null || typeof value !== 'number' || Number.isNaN(value) || !Number.isFinite(value))
         return false;
@@ -11,9 +48,23 @@ export function isValidNumber(value, min, max) {
         return false;
     return true;
 }
+/**
+ * Checks if a value is a valid boolean.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @returns {value is boolean} `true` if the value is a valid boolean, `false` otherwise.
+ */
 export function isValidBoolean(value) {
     return value !== undefined && value !== null && typeof value === 'boolean';
 }
+/**
+ * Checks if a value is a valid string.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} minLength - The min string length (optional).
+ * @param {number} maxLength - The max string length (optional).
+ * @returns {value is string} A boolean indicating whether the value is a valid string.
+ */
 export function isValidString(value, minLength, maxLength) {
     if (value === undefined || value === null || typeof value !== 'string')
         return false;
@@ -23,9 +74,23 @@ export function isValidString(value, minLength, maxLength) {
         return false;
     return true;
 }
+/**
+ * Checks if a value is a valid RegExp.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @returns {value is RegExp} A boolean indicating whether the value is a valid RegExp.
+ */
 export function isValidRegExp(value) {
     return value !== undefined && value !== null && value instanceof RegExp;
 }
+/**
+ * Checks if a value is a valid object.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} minLength - The min number of keys (optional).
+ * @param {number} maxLength - The max number of keys (optional).
+ * @returns {value is object} A boolean indicating whether the value is a valid object.
+ */
 export function isValidObject(value, minLength, maxLength) {
     if (value === undefined || value === null || typeof value !== 'object' || Array.isArray(value))
         return false;
@@ -36,6 +101,14 @@ export function isValidObject(value, minLength, maxLength) {
         return false;
     return true;
 }
+/**
+ * Checks if a value is a valid array.
+ *
+ * @param {unknown} value - The value to be checked.
+ * @param {number} minLength - The min number of elements (optional).
+ * @param {number} maxLength - The max number of elements (optional).
+ * @returns {value is unknown[]} A boolean indicating whether the value is a valid array.
+ */
 export function isValidArray(value, minLength, maxLength) {
     if (value === undefined || value === null || !Array.isArray(value))
         return false;
@@ -45,12 +118,31 @@ export function isValidArray(value, minLength, maxLength) {
         return false;
     return true;
 }
+/**
+ * Checks if the given value is null.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is null} `true` if the value is null, `false` otherwise.
+ */
 export function isValidNull(value) {
     return value === null;
 }
+/**
+ * Checks if a value is undefined.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is undefined} `true` if the value is undefined, `false` otherwise.
+ */
 export function isValidUndefined(value) {
     return value === undefined;
 }
+/**
+ * Converts a semantic version string like "6.11.0-1011-raspi" to a numeric version code like 61100.
+ * Format: major * 10000 + minor * 100 + patch
+ *
+ * @param {string} versionString The version string to parse
+ * @returns {number | undefined} A numeric version code or undefined if parsing fails
+ */
 export function parseVersionString(versionString) {
     if (!isValidString(versionString))
         return undefined;
@@ -67,3 +159,4 @@ export function parseVersionString(versionString) {
     }
     return major * 10000 + minor * 100 + patch;
 }
+//# sourceMappingURL=isValid.js.map

package/dist/utils/isValid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValid.js","sourceRoot":"","sources":["../../src/utils/isValid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,WAAmB;IACpD,MAAM,SAAS,GAAG,kKAAkK,CAAC;IACrL,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,GAAY,EAAE,GAAY;IACtE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACvI,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,KAAK,CAAC;IACnD,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,KAAK,CAAC;IACnD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,SAAkB,EAAE,SAAkB;IAClF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACrF,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,YAAY,MAAM,CAAC;AAC1E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,SAAkB,EAAE,SAAkB;IAClF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7G,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACrE,IAAI,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACrE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc,EAAE,SAAkB,EAAE,SAAkB;IACjF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACjF,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,KAAK,KAAK,IAAI,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,aAAqB;IACtD,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,aAAa,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC;IACrC,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAE7B,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAErC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;QACrG,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,GAAG,GAAG,KAAK,CAAC;AAC7C,CAAC"}

package/dist/utils/network.d.ts

@@ -1,15 +1,116 @@
+/**
+ * @description This file contains the network functions.
+ * @file network.ts
+ * @author Luca Liguori
+ * @created 2024-02-17
+ * @version 1.0.2
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Retrieves the first non-internal network interface details.
+ *
+ * @returns {os.NetworkInterfaceInfo | undefined} The details of the selected network interface, or undefined if not found.
+ */
 export declare function getInterfaceDetails(): {
     interfaceName: string;
     ipv4Address: string | undefined;
     ipv6Address: string | undefined;
     macAddress: string | undefined;
 } | undefined;
+/**
+ * Retrieves the first non-internal network interface name.
+ *
+ * @returns {string | undefined} The name of the selected network interface, or undefined if not found.
+ */
 export declare function getInterfaceName(): string | undefined;
+/**
+ * Retrieves the IPv4 address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
+ *
+ * @remarks
+ * Type of ipv4 addresses:
+ * - 192.168.x.x, 10.x.x.x, 172.16–31.x.x: RFC 1918 = Private networks
+ * - 172.16.0.0 → 172.31.255.255: RFC 1918 = Private IP address used inside local networks, VMs, WSL2 and containers
+ * - 169.254.0.0 → 169.254.255.255: APIPA = Automatic Private IP Addressing used when a device fails to obtain an IP address via DHCP
+ * - 100.64.0.0 → 100.127.255.255: CGNAT = Carrier-Grade NAT RFC 6598 = Shared Address Space
+ */
 export declare function getIpv4InterfaceAddress(): string | undefined;
+/**
+ * Retrieves the IPv6 address of the first non-internal network interface.
+ *
+ * If `scope` is true, appends a zone id (scope) for link-local addresses when
+ * available:
+ * - On Windows: uses `%<scopeid>` (e.g. `...%11`)
+ * - On other platforms: uses `%<interfaceName>` (e.g. `...%eth0`)
+ *
+ * @param {boolean} [scope] - Whether to append a zone id when available.
+ * @returns {string | undefined} The IPv6 address of the selected network interface, or undefined if not found.
+ *
+ * @remarks
+ * Type of IPv6 addresses (preferred order for Matter)
+ *
+ * fd00::/8
+ *   - IPv6 ULA (Unique Local Address)
+ *   - Private IPv6 networks (RFC 4193)
+ *   - ✔ PREFERRED
+ *
+ * 2000::/3
+ *   - Global Unicast IPv6
+ *   - Publicly routable IPv6
+ *   - ⚠ OPTIONAL (advanced setups only)
+ *
+ * fe80::/10
+ *   - IPv6 Link-Local
+ *   - Interface-scoped only, non-routable
+ */
 export declare function getIpv6InterfaceAddress(scope?: boolean): string | undefined;
+/**
+ * Retrieves the mac address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The mac address, or undefined if not found.
+ */
 export declare function getMacAddress(): string | undefined;
+/**
+ * Logs the available network interfaces and their details.
+ *
+ * @returns {void}
+ */
 export declare function logInterfaces(): void;
+/**
+ * Resolves the given hostname to an IP address.
+ *
+ * @param {string} hostname - The hostname to resolve.
+ * @param {0 | 4 | 6} [family] - The address family to use (0 for any, 4 for IPv4, 6 for IPv6). Default is 4.
+ * @returns {Promise<string | null>} - A promise that resolves to the IP address or null if not found.
+ *
+ * @remarks
+ * This function uses DNS lookup to resolve the hostname, which can take some time to complete.
+ */
 export declare function resolveHostname(hostname: string, family?: 0 | 4 | 6): Promise<string | null>;
+/**
+ * Retrieves the version of an npm package from the npm registry.
+ *
+ * @param {string} packageName - The name of the npm package.
+ * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<string>} A promise that resolves to the version string of the package.
+ * @throws {Error} If the request fails or the tag is not found.
+ */
 export declare function getNpmPackageVersion(packageName: string, tag?: string, timeout?: number): Promise<string>;
 export type UpdateJson = {
     latest: string;
@@ -21,5 +122,20 @@ export type UpdateJson = {
     devMessage: string;
     devMessageSeverity: 'info' | 'warning' | 'error' | 'success';
 };
+/**
+ * Retrieves a file from the public directory of the Matterbridge GitHub repository.
+ *
+ * @param {string} branch - The branch from which to fetch the file.
+ * @param {string} file - The file path to fetch.
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<Record<string, boolean | string | number>>} A promise that resolves to the parsed JSON object from the file.
+ * @throws {Error} If the request fails or the JSON parsing fails.
+ */
 export declare function getGitHubUpdate(branch: 'main' | 'dev', file: string, timeout?: number): Promise<UpdateJson>;
+/**
+ * Retrieves the path to the global Node.js modules directory.
+ *
+ * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
+ */
 export declare function getGlobalNodeModules(): Promise<string>;
+//# sourceMappingURL=network.d.ts.map

package/dist/utils/network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAUH;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,CAa7K;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAOrD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAO5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,GAAE,OAAe,GAAG,MAAM,GAAG,SAAS,CAoBlF;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAmBpC;AAED;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,CAAC,GAAG,CAAC,GAAG,CAAK,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAQrG;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,GAAE,MAAiB,EAAE,OAAO,GAAE,MAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CA8ChI;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IAChE,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;CAC9D,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,MAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAyCxH;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CAW5D"}

package/dist/utils/network.js

@@ -1,5 +1,34 @@
+/**
+ * @description This file contains the network functions.
+ * @file network.ts
+ * @author Luca Liguori
+ * @created 2024-02-17
+ * @version 1.0.2
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// Node.js modules
 import os from 'node:os';
+// AnsiLogger module
 import { AnsiLogger, BLUE, CYAN, nf } from 'node-ansi-logger';
+/**
+ * Retrieves the first non-internal network interface details.
+ *
+ * @returns {os.NetworkInterfaceInfo | undefined} The details of the selected network interface, or undefined if not found.
+ */
 export function getInterfaceDetails() {
     const result = { interfaceName: '', ipv4Address: undefined, ipv6Address: undefined, macAddress: undefined };
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
@@ -21,6 +50,11 @@ export function getInterfaceDetails() {
     if (result.interfaceName)
         return result;
 }
+/**
+ * Retrieves the first non-internal network interface name.
+ *
+ * @returns {string | undefined} The name of the selected network interface, or undefined if not found.
+ */
 export function getInterfaceName() {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -31,6 +65,18 @@ export function getInterfaceName() {
         }
     }
 }
+/**
+ * Retrieves the IPv4 address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
+ *
+ * @remarks
+ * Type of ipv4 addresses:
+ * - 192.168.x.x, 10.x.x.x, 172.16–31.x.x: RFC 1918 = Private networks
+ * - 172.16.0.0 → 172.31.255.255: RFC 1918 = Private IP address used inside local networks, VMs, WSL2 and containers
+ * - 169.254.0.0 → 169.254.255.255: APIPA = Automatic Private IP Addressing used when a device fails to obtain an IP address via DHCP
+ * - 100.64.0.0 → 100.127.255.255: CGNAT = Carrier-Grade NAT RFC 6598 = Shared Address Space
+ */
 export function getIpv4InterfaceAddress() {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -41,6 +87,34 @@ export function getIpv4InterfaceAddress() {
         }
     }
 }
+/**
+ * Retrieves the IPv6 address of the first non-internal network interface.
+ *
+ * If `scope` is true, appends a zone id (scope) for link-local addresses when
+ * available:
+ * - On Windows: uses `%<scopeid>` (e.g. `...%11`)
+ * - On other platforms: uses `%<interfaceName>` (e.g. `...%eth0`)
+ *
+ * @param {boolean} [scope] - Whether to append a zone id when available.
+ * @returns {string | undefined} The IPv6 address of the selected network interface, or undefined if not found.
+ *
+ * @remarks
+ * Type of IPv6 addresses (preferred order for Matter)
+ *
+ * fd00::/8
+ *   - IPv6 ULA (Unique Local Address)
+ *   - Private IPv6 networks (RFC 4193)
+ *   - ✔ PREFERRED
+ *
+ * 2000::/3
+ *   - Global Unicast IPv6
+ *   - Publicly routable IPv6
+ *   - ⚠ OPTIONAL (advanced setups only)
+ *
+ * fe80::/10
+ *   - IPv6 Link-Local
+ *   - Interface-scoped only, non-routable
+ */
 export function getIpv6InterfaceAddress(scope = false) {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -50,6 +124,7 @@ export function getIpv6InterfaceAddress(scope = false) {
                 const address = detail.address;
                 if (!scope)
                     return address;
+                // Defensive check: if already has a zone id, keep it. Should never happen from os.networkInterfaces().
                 if (address.includes('%'))
                     return address;
                 const isWindows = os.platform() === 'win32';
@@ -62,6 +137,11 @@ export function getIpv6InterfaceAddress(scope = false) {
         }
     }
 }
+/**
+ * Retrieves the mac address of the first non-internal network interface.
+ *
+ * @returns {string | undefined} The mac address, or undefined if not found.
+ */
 export function getMacAddress() {
     for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
         if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
@@ -72,9 +152,14 @@ export function getMacAddress() {
         }
     }
 }
+/**
+ * Logs the available network interfaces and their details.
+ *
+ * @returns {void}
+ */
 export function logInterfaces() {
-    const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4, logLevel: "info" });
-    log.logLevel = "info";
+    const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
+    log.logLevel = "info" /* LogLevel.INFO */;
     log.logName = 'LogInterfaces';
     log.info('Available Network Interfaces:');
     const availableAddresses = Object.entries(os.networkInterfaces());
@@ -88,16 +173,35 @@ export function logInterfaces() {
         }
     }
 }
+/**
+ * Resolves the given hostname to an IP address.
+ *
+ * @param {string} hostname - The hostname to resolve.
+ * @param {0 | 4 | 6} [family] - The address family to use (0 for any, 4 for IPv4, 6 for IPv6). Default is 4.
+ * @returns {Promise<string | null>} - A promise that resolves to the IP address or null if not found.
+ *
+ * @remarks
+ * This function uses DNS lookup to resolve the hostname, which can take some time to complete.
+ */
 export async function resolveHostname(hostname, family = 4) {
     const dns = await import('node:dns');
     try {
-        const addresses = await dns.promises.lookup(hostname.toLowerCase(), { family });
+        const addresses = await dns.promises.lookup(hostname.toLowerCase() /* + '.local'*/, { family });
         return addresses.address;
     }
     catch (_error) {
         return null;
     }
 }
+/**
+ * Retrieves the version of an npm package from the npm registry.
+ *
+ * @param {string} packageName - The name of the npm package.
+ * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<string>} A promise that resolves to the version string of the package.
+ * @throws {Error} If the request fails or the tag is not found.
+ */
 export async function getNpmPackageVersion(packageName, tag = 'latest', timeout = 10000) {
     const https = await import('node:https');
     return new Promise((resolve, reject) => {
@@ -111,7 +215,7 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
             let data = '';
             if (res.statusCode !== 200) {
                 clearTimeout(timeoutId);
-                res.resume();
+                res.resume(); // Discard response data to close the socket properly
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
@@ -122,6 +226,7 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
                 clearTimeout(timeoutId);
                 try {
                     const jsonData = JSON.parse(data);
+                    // console.log(`Package ${packageName} tag ${tag}`, jsonData);
                     const version = jsonData['dist-tags']?.[tag];
                     if (version) {
                         resolve(version);
@@ -141,6 +246,15 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
         });
     });
 }
+/**
+ * Retrieves a file from the public directory of the Matterbridge GitHub repository.
+ *
+ * @param {string} branch - The branch from which to fetch the file.
+ * @param {string} file - The file path to fetch.
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
+ * @returns {Promise<Record<string, boolean | string | number>>} A promise that resolves to the parsed JSON object from the file.
+ * @throws {Error} If the request fails or the JSON parsing fails.
+ */
 export async function getGitHubUpdate(branch, file, timeout = 10000) {
     const https = await import('node:https');
     return new Promise((resolve, reject) => {
@@ -154,7 +268,7 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
             let data = '';
             if (res.statusCode !== 200) {
                 clearTimeout(timeoutId);
-                res.resume();
+                res.resume(); // Discard response data to close the socket properly
                 reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
                 return;
             }
@@ -172,12 +286,18 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
                 }
             });
         });
+        // istanbul ignore next cause it's just a precaution for network errors
         req.on('error', (error) => {
             clearTimeout(timeoutId);
             reject(new Error(`Request failed: ${error instanceof Error ? error.message : error}`));
         });
     });
 }
+/**
+ * Retrieves the path to the global Node.js modules directory.
+ *
+ * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
+ */
 export async function getGlobalNodeModules() {
     const { exec } = await import('node:child_process');
     return new Promise((resolve, reject) => {
@@ -191,3 +311,4 @@ export async function getGlobalNodeModules() {
         });
     });
 }
+//# sourceMappingURL=network.js.map