@mp-consulting/homebridge-lg-thinq 1.0.0

package/dist/lib/DeviceModel.js

@@ -0,0 +1,321 @@
+export var ValueType;
+(function (ValueType) {
+    ValueType["Bit"] = "Bit";
+    ValueType["Enum"] = "Enum";
+    ValueType["Range"] = "Range";
+    ValueType["Reference"] = "Reference";
+    ValueType["StringComment"] = "StringComment";
+})(ValueType || (ValueType = {}));
+/**
+ * Represents the model of a device, including its metadata, values, and monitoring data.
+ * This class provides methods to retrieve and decode device-specific information.
+ */
+export class DeviceModel {
+    data;
+    /**
+     * Creates a new `DeviceModel` instance.
+     *
+     * @param data - The raw model data for the device.
+     */
+    constructor(data) {
+        this.data = data;
+    }
+    /**
+     * Retrieves the monitoring values defined in the device model.
+     */
+    get monitoringValue() {
+        return this.data.MonitoringValue;
+    }
+    /**
+     * Retrieves the value definition for a given key in the device model.
+     * Supports ThinQ2 protocol mappings for monitoring values.
+     *
+     * @param name - The key to retrieve the value definition for.
+     * @returns The value definition or `null` if not found.
+     */
+    value(name) {
+        if (this.data.Value === undefined) {
+            return null;
+        }
+        let data = this.data.Value[name];
+        // Handle ThinQ2 protocol mappings
+        if (data === undefined && this.data.Monitoring?.type === 'THINQ2') {
+            const protocol = this.data.Monitoring?.protocol;
+            /**
+             * sample: "protocol": {
+             * 			"state": "State",
+             * 			"process": "Process",
+             * 			"error": "Error",
+             * 			"initialTimeHour": "Initial_Time_H",
+             * 			"initialTimeMinute": "Initial_Time_M",
+             * 			"course": "Course",
+             * 			"courseType": "CourseType",
+             * 			"remainTimeHour": "Remain_Time_H",
+             * 			"remainTimeMinute": "Remain_Time_M",
+             * 			"reserveTimeHour": "Reserve_Time_H",
+             * 			"reserveTimeMinute": "Reserve_Time_M",
+             * 			"childLock": "ChildLock",
+             * 			"door": "Door",
+             * 			"rinseRefill": "RinseRefill",
+             * 			"saltRefill": "SaltRefill",
+             * 			"signalLevel": "SignalLevel",
+             * 			"mcReminderSetting": "MCReminderSetting",
+             * 			"cleanLReminder": "CleanLReminder",
+             * 			"nightDry": "NightDry",
+             * 			"delayStart": "DelayStart",
+             * 			"energySaver": "EnergySaver",
+             * 			"extraDry": "ExtraDry",
+             * 			"highTemp": "HighTemp",
+             * 			"dualZone": "DualZone",
+             * 			"halfLoad": "HalfLoad",
+             * 			"autoDoor": "AutoDoor",
+             * 			"preSteam": "PreSteam",
+             * 			"steam": "Steam",
+             * 			"rinseLevel": "RinseLevel",
+             * 			"softeningLevel": "SofteningLevel",
+             * 			"smartCourse": "SmartCourse",
+             * 			"currentDownloadCourse": "CurrentDownloadCourse",
+             * 			"tclCount": "TclCount"
+             * 		}
+             */
+            if (protocol.constructor.name === 'Object' && protocol[name] !== undefined) {
+                data = this.data.Value[this.data.Monitoring?.protocol[name]];
+                /**
+                 * sample: "protocol": [{
+                 * 				"_comment": "Hood Operation State(1byte)",
+                 * 				"superSet": "hoodState.hoodState",
+                 * 				"value": "HoodState"
+                 * 			},
+                 *      {
+                 * 				"_comment": "VentState",
+                 * 				"superSet": "hoodState.ventLevel",
+                 * 				"value": "VentLevel"
+                 * 			},
+                 *      {
+                 * 				"_comment": "VentMode",
+                 * 				"superSet": "hoodState.ventMode",
+                 * 				"value": "VentMode"
+                 * 			},
+                 *      {
+                 * 				"_comment": "TimerMin",
+                 * 				"superSet": "hoodState.remainTimeMinute",
+                 * 				"value": "TimerMin"
+                 * 			},
+                 *      {
+                 * 				"_comment": "TimerSec",
+                 * 				"superSet": "hoodState.remainTimeSecond",
+                 * 				"value": "TimerSec"
+                 * 			},
+                 *      {
+                 * 				"_comment": "LightState",
+                 * 				"superSet": "hoodState.lampLevel",
+                 * 				"value": "LampLevel"
+                 * 			},
+                 *      {
+                 * 				"_comment": "Dummy-meaningless",
+                 * 				"superSet": "hoodState.dummyData",
+                 * 				"value": "Dummy"
+                 * 			},
+                 *      {
+                 * 				"_comment": "HoodStateInfo",
+                 * 				"superSet": null,
+                 * 				"value": "HoodStateInfo"
+                 * 			},
+                 *      {
+                 * 				"_comment": "WiFi Access Enable",
+                 * 				"superSet": null,
+                 * 				"value": "WiFiAccess"
+                 * 			}
+                 *    ]
+                 */
+            }
+            else if (protocol.constructor.name === 'Array' && protocol.find((p) => p.superSet === name) !== undefined) {
+                data = this.data.Value[protocol.find((p) => p.superSet === name).value];
+            }
+        }
+        if (data === undefined) {
+            return null;
+        }
+        // Determine the type of the value and return the appropriate structure
+        const type = data.type || data.data_type;
+        switch (type.toLowerCase()) {
+            case 'enum':
+                return {
+                    type: ValueType.Enum,
+                    options: data.option || data.value_mapping,
+                };
+            case 'range':
+                return {
+                    type: ValueType.Range,
+                    min: (data.option || data.value_validation)?.min,
+                    max: (data.option || data.value_validation)?.max,
+                    step: (data.option || data.value_validation)?.step || 1,
+                };
+            case 'bit': {
+                const bitValues = Object.values(data.option).reduce((obj, value) => ({
+                    ...obj,
+                    [value.startbit]: value.values,
+                }), {});
+                return { type: ValueType.Bit, options: bitValues };
+            }
+            case 'reference': {
+                const [ref] = data.option;
+                return { type: ValueType.Reference, reference: this.data[ref] };
+            }
+            case 'string':
+                if (typeof data._comment === 'string') {
+                    return { type: ValueType.StringComment, comment: data._comment };
+                }
+                return null;
+            default:
+                throw new Error(`Unsupported value type: ${data.type}`);
+        }
+    }
+    /**
+     * Retrieves the default value for a given key in the device model.
+     *
+     * @param name - The key to retrieve the default value for.
+     * @returns The default value or `undefined` if not found.
+     */
+    default(name) {
+        return this.data?.Value[name]?.default;
+    }
+    /**
+     * Retrieves the enum value for a given key and name.
+     *
+     * @param key - The key to retrieve the enum value for.
+     * @param name - The name of the enum **value**.
+     * @returns The enum value or `undefined` if not found.
+     */
+    enumValue(key, name) {
+        const value = this.value(key);
+        if (value?.type !== ValueType.Enum) {
+            return null;
+        }
+        const options = value.options;
+        // getting the key where value is equal to name
+        const keyByValue = Object.keys(options).find(k => options[k] === name);
+        return keyByValue || null;
+    }
+    /**
+     * Retrieves the enum name for a given key and value.
+     *
+     * @param key - The key to retrieve the enum name for.
+     * @param value - The value of the enum.
+     * @returns The enum name or `null` if not found.
+     */
+    enumName(key, value) {
+        if (this.value(key)?.type !== ValueType.Enum) {
+            return null;
+        }
+        const options = this.value(key).options;
+        return options[value] || null;
+    }
+    /**
+     * Retrieves the monitoring value mapping for a given key.
+     *
+     * @param key - The key to retrieve the monitoring value mapping for.
+     * @returns The monitoring value mapping or `null` if not found.
+     */
+    monitoringValueMapping(key) {
+        if (this.monitoringValue === undefined || !(key in this.monitoringValue)) {
+            return null;
+        }
+        return this.monitoringValue[key].valueMapping || null;
+    }
+    /**
+     * Looks up a monitor value based on a given key and name, with an optional default value.
+     *
+     * @param key - The key used to identify the monitoring value mapping.
+     * @param name - The name of the specific value to look up within the mapping.
+     * @param default_value - An optional default value to return if the lookup fails. Defaults to `null`.
+     * @returns The label of the monitoring value if found, or the `default_value` if not found.
+     */
+    lookupMonitorValue(key, name) {
+        if (this.data.Value) {
+            return this.enumName(key, name);
+        }
+        const monitoringValue = this.monitoringValueMapping(key);
+        if (monitoringValue === null || !(name in monitoringValue)) {
+            return null;
+        }
+        return monitoringValue[name].label || null;
+    }
+    /**
+     * Looks up a monitor value based on a given key and name, with an optional default value.
+     *
+     * @param key - The key used to identify the monitoring value mapping.
+     * @param name - The name of the specific value to look up within the mapping.
+     * @param default_value - An optional default value to return if the lookup fails. Defaults to `null`.
+     * @returns The label of the monitoring value if found, or the `default_value` if not found.
+     */
+    lookupMonitorValue2(key, name, default_value) {
+        if (this.data.Value) {
+            return this.enumName(key, name) || default_value;
+        }
+        const monitoringValue = this.monitoringValueMapping(key);
+        if (monitoringValue === null || !(name in monitoringValue)) {
+            return default_value;
+        }
+        return monitoringValue[name].label || default_value;
+    }
+    /**
+     * Looks up a monitor name based on a given key and label.
+     *
+     * @param key - The key used to identify the monitoring value mapping.
+     * @param label - The label of the specific value to look up within the mapping.
+     * @returns The name of the monitoring value if found, or `null` if not found.
+     */
+    lookupMonitorName(key, label) {
+        if (this.data.Value) {
+            return this.enumValue(key, label);
+        }
+        if (this.monitoringValue === undefined || !(key in this.monitoringValue)) {
+            return null;
+        }
+        const getKeyByValue = (obj, value) => Object.keys(obj).find(k => obj[k].label === value);
+        return getKeyByValue(this.monitoringValue[key].valueMapping, label) || null;
+    }
+    /**
+     * Decodes the monitoring data for the device.
+     *
+     * @param data - The raw monitoring data to decode.
+     * @returns The decoded monitoring data.
+     */
+    decodeMonitor(data) {
+        if (this.data.Monitoring?.type === 'BINARY(BYTE)') {
+            return this.decodeMonitorBinary(data);
+        }
+        else if (this.data.Monitoring?.type === 'BINARY(HEX)') {
+            return this.decodeMonitorBinary(data, 16);
+        }
+        try {
+            return JSON.parse(data.toString());
+        }
+        catch (err) {
+            return data;
+        }
+    }
+    /**
+     * Decodes binary monitoring data for the device.
+     *
+     * @param data - The raw binary monitoring data to decode.
+     * @param length - The length of each binary segment (default: 8).
+     * @returns The decoded monitoring data.
+     */
+    decodeMonitorBinary(data, length = 8) {
+        const decoded = {};
+        for (const item of this.data.Monitoring.protocol) {
+            const key = item.value;
+            let value = 0;
+            // Decode binary data segment by segment
+            for (let i = item.startByte; i < item.startByte + item.length; i++) {
+                const v = data[i];
+                value = (value << length) + v;
+                decoded[key] = isNaN(value) ? null : String(value);
+            }
+        }
+        return decoded;
+    }
+}
+//# sourceMappingURL=DeviceModel.js.map

package/dist/lib/DeviceModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceModel.js","sourceRoot":"","sources":["../../src/lib/DeviceModel.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,4CAA+B,CAAA;AACjC,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAiED;;;GAGG;AACH,MAAM,OAAO,WAAW;IAOb;IANT;;;;OAIG;IACH,YACS,IAAe;QAAf,SAAI,GAAJ,IAAI,CAAW;IACpB,CAAC;IAEL;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAY;QACvB,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEjC,kCAAkC;QAClC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;YAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAoCG;YACH,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC3E,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA+CG;YACH,CAAC;iBAAM,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACjH,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;QAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,uEAAuE;QACvE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC;QACzC,QAAQ,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC7B,KAAK,MAAM;gBACT,OAAO;oBACL,IAAI,EAAE,SAAS,CAAC,IAAI;oBACpB,OAAO,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa;iBAC9B,CAAC;YAEjB,KAAK,OAAO;gBACV,OAAO;oBACL,IAAI,EAAE,SAAS,CAAC,KAAK;oBACrB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,GAAG;oBAChD,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,GAAG;oBAChD,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,IAAI,CAAC;iBAC1C,CAAC;YAElB,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;oBACxE,GAAG,GAAG;oBACN,CAAE,KAAa,CAAC,QAAQ,CAAC,EAAG,KAAa,CAAC,MAAM;iBACjD,CAAC,EAAE,EAAE,CAAC,CAAC;gBACR,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAc,CAAC;YACjE,CAAC;YAED,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC1B,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAoB,CAAC;YACpF,CAAC;YAED,KAAK,QAAQ;gBACX,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBACtC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAwB,CAAC;gBACzF,CAAC;gBACD,OAAO,IAAI,CAAC;YAEd;gBACE,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,IAAY;QACzB,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,GAAW,EAAE,IAAY;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,KAAK,EAAE,IAAI,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,+CAA+C;QAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QACvE,OAAO,UAAU,IAAI,IAAI,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,GAAW,EAAE,KAAa;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAe,CAAC,OAAO,CAAC;QACvD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACI,sBAAsB,CAAC,GAAW;QAEvC,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACzE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,GAAW,EAAE,IAAY;QACjD,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,eAAe,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,eAAe,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAC,GAAW,EAAE,IAAY,EAAE,aAAoB;QACxE,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,aAAa,CAAC;QACnD,CAAC;QACD,MAAM,eAAe,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,eAAe,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,EAAE,CAAC;YAC3D,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,aAAa,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACI,iBAAiB,CAAC,GAAW,EAAE,KAAa;QACjD,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACzE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,aAAa,GAAG,CAAC,GAAQ,EAAE,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QAEtG,OAAO,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,IAAS;QAC5B,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,KAAK,cAAc,EAAE,CAAC;YAClD,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,mBAAmB,CAAC,IAAS,EAAE,MAAM,GAAG,CAAC;QAC/C,MAAM,OAAO,GAAwB,EAAE,CAAC;QAExC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YACjD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,IAAI,KAAK,GAAG,CAAC,CAAC;YAEd,wCAAwC;YACxC,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACnE,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBAClB,KAAK,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC9B,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/dist/lib/DeviceModel.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/DeviceModel.spec.js

@@ -0,0 +1,90 @@
+import { DeviceModel } from './DeviceModel.js';
+import { describe, test, beforeEach, expect } from '@jest/globals';
+import Fs from 'fs';
+import Path from 'path';
+const mockModelDataJson = JSON.parse(Fs.readFileSync(Path.resolve(process.cwd(), 'sample/airconditioner-model.json'), 'utf8'));
+describe('DeviceModel', () => {
+    let deviceModel;
+    const mockModelData = mockModelDataJson;
+    beforeEach(() => {
+        deviceModel = new DeviceModel(mockModelData);
+    });
+    test('should retrieve monitoring values', () => {
+        const monitoringValues = deviceModel.monitoringValue;
+        expect(monitoringValues).toEqual(mockModelData.MonitoringValue);
+    });
+    test('should retrieve value definition for a given key', () => {
+        const value = deviceModel.value('temperature');
+        expect(value).toBeDefined();
+    });
+    test('should return null for undefined value key', () => {
+        const value = deviceModel.value('undefinedKey');
+        expect(value).toBeNull();
+    });
+    test('should retrieve default value for a given key', () => {
+        const mockModelDataWithDefault = {
+            ...mockModelData,
+            Value: {
+                ...mockModelData.Value,
+                temperature: {
+                    ...mockModelData.Value.temperature,
+                    default: 350,
+                },
+            },
+        };
+        deviceModel = new DeviceModel(mockModelDataWithDefault);
+        const defaultValue = deviceModel.default('temperature');
+        expect(defaultValue).toBe(350);
+    });
+    test('should retrieve enum value for a given key and name', () => {
+        const enumValue = deviceModel.enumValue('mode', 'Bake');
+        expect(enumValue).toBeDefined();
+    });
+    test('should return null for invalid enum key or name', () => {
+        const invalidEnumValue = deviceModel.enumValue('mode', 'Invalid');
+        expect(invalidEnumValue).toBeNull();
+    });
+    test('should retrieve enum name for a given key and value', () => {
+        const enumName = deviceModel.enumName('mode', 'bake');
+        expect(enumName).toBeDefined();
+    });
+    test('should return null for invalid enum key or value', () => {
+        const invalidEnumName = deviceModel.enumName('mode', 'invalid');
+        expect(invalidEnumName).toBeNull();
+    });
+    test('should retrieve monitoring value mapping for a given key', () => {
+        const mapping = deviceModel.monitoringValueMapping('door');
+        expect(mapping).toBeDefined();
+    });
+    test('should return null for invalid monitoring value key', () => {
+        const invalidMapping = deviceModel.monitoringValueMapping('invalidKey');
+        expect(invalidMapping).toBeNull();
+    });
+    test('should lookup monitor value by key and name', () => {
+        const label = deviceModel.lookupMonitorValue('door', 'open');
+        expect(label).toBeDefined();
+    });
+    test('should return default value for invalid monitor value lookup', () => {
+        const defaultValue = deviceModel.lookupMonitorValue2('door', 'invalid', 'Default');
+        expect(defaultValue).toBe('Default');
+    });
+    test('should lookup monitor name by key and label', () => {
+        const name = deviceModel.lookupMonitorName('door', 'Open');
+        expect(name).toBeDefined();
+    });
+    test('should return null for invalid monitor name lookup', () => {
+        const invalidName = deviceModel.lookupMonitorName('door', 'Invalid');
+        expect(invalidName).toBeNull();
+    });
+    test('should decode monitoring data as JSON', () => {
+        const rawData = '{"key":"value"}';
+        const decodedData = deviceModel.decodeMonitor(rawData);
+        expect(decodedData).toEqual({ key: 'value' });
+    });
+    test('should return raw data if JSON decoding fails', () => {
+        const rawData = 'invalidJSON';
+        const decodedData = deviceModel.decodeMonitor(rawData);
+        expect(decodedData).toBe(rawData);
+    });
+});
+//# sourceMappingURL=DeviceModel.spec.js.map

package/dist/lib/DeviceModel.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceModel.spec.js","sourceRoot":"","sources":["../../src/lib/DeviceModel.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAyB,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kCAAkC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAE/H,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,WAAwB,CAAC;IAC7B,MAAM,aAAa,GAAc,iBAAyC,CAAC;IAC3E,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,GAAG,IAAI,WAAW,CAAC,aAAqC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC7C,MAAM,gBAAgB,GAAG,WAAW,CAAC,eAAe,CAAC;QACrD,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC5D,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,aAAa,CAAe,CAAC;QAC7D,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACtD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACzD,MAAM,wBAAwB,GAAG;YAC/B,GAAG,aAAa;YAChB,KAAK,EAAE;gBACL,GAAG,aAAa,CAAC,KAAK;gBACtB,WAAW,EAAE;oBACX,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW;oBAClC,OAAO,EAAE,GAAG;iBACb;aACF;SACF,CAAC;QACF,WAAW,GAAG,IAAI,WAAW,CAAC,wBAAgD,CAAC,CAAC;QAEhF,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACxD,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC/D,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;QAC3D,MAAM,gBAAgB,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC/D,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtD,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC5D,MAAM,eAAe,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChE,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QACpE,MAAM,OAAO,GAAG,WAAW,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC/D,MAAM,cAAc,GAAG,WAAW,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;QACxE,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAG,WAAW,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACxE,MAAM,YAAY,GAAG,WAAW,CAAC,mBAAmB,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACnF,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACvD,MAAM,IAAI,GAAG,WAAW,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC9D,MAAM,WAAW,GAAG,WAAW,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACrE,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;QACjD,MAAM,OAAO,GAAG,iBAAiB,CAAC;QAClC,MAAM,WAAW,GAAG,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACzD,MAAM,OAAO,GAAG,aAAa,CAAC;QAC9B,MAAM,WAAW,GAAG,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/lib/Gateway.d.ts

@@ -0,0 +1,18 @@
+export interface GatewayData {
+    empTermsUri: string;
+    empSpxUri: string;
+    thinq2Uri: string;
+    thinq1Uri: string;
+    countryCode: string;
+    languageCode: string;
+}
+export declare class Gateway {
+    data: GatewayData;
+    constructor(data: GatewayData);
+    get emp_base_url(): string;
+    get login_base_url(): string;
+    get thinq2_url(): string;
+    get thinq1_url(): string;
+    get country_code(): string;
+    get language_code(): string;
+}

package/dist/lib/Gateway.js

@@ -0,0 +1,25 @@
+export class Gateway {
+    data;
+    constructor(data) {
+        this.data = data;
+    }
+    get emp_base_url() {
+        return this.data.empTermsUri + '/';
+    }
+    get login_base_url() {
+        return this.data.empSpxUri + '/';
+    }
+    get thinq2_url() {
+        return this.data.thinq2Uri + '/';
+    }
+    get thinq1_url() {
+        return this.data.thinq1Uri + '/';
+    }
+    get country_code() {
+        return this.data.countryCode;
+    }
+    get language_code() {
+        return this.data.languageCode;
+    }
+}
+//# sourceMappingURL=Gateway.js.map

package/dist/lib/Gateway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Gateway.js","sourceRoot":"","sources":["../../src/lib/Gateway.ts"],"names":[],"mappings":"AASA,MAAM,OAAO,OAAO;IACC;IAAnB,YAAmB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;IAAG,CAAC;IAExC,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IACrC,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;IACnC,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;IACnC,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;IACnC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/B,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAChC,CAAC;CACF"}

package/dist/lib/Gateway.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/Gateway.spec.js

@@ -0,0 +1,35 @@
+import { Gateway } from './Gateway.js';
+import { describe, test, expect, beforeEach } from '@jest/globals';
+describe('Gateway', () => {
+    const mockData = {
+        empTermsUri: 'https://example.com/terms',
+        empSpxUri: 'https://example.com/login',
+        thinq2Uri: 'https://example.com/thinq2',
+        thinq1Uri: 'https://example.com/thinq1',
+        countryCode: 'US',
+        languageCode: 'en-US',
+    };
+    let gateway;
+    beforeEach(() => {
+        gateway = new Gateway(mockData);
+    });
+    test('should return the correct emp_base_url', () => {
+        expect(gateway.emp_base_url).toBe('https://example.com/terms/');
+    });
+    test('should return the correct login_base_url', () => {
+        expect(gateway.login_base_url).toBe('https://example.com/login/');
+    });
+    test('should return the correct thinq2_url', () => {
+        expect(gateway.thinq2_url).toBe('https://example.com/thinq2/');
+    });
+    test('should return the correct thinq1_url', () => {
+        expect(gateway.thinq1_url).toBe('https://example.com/thinq1/');
+    });
+    test('should return the correct country_code', () => {
+        expect(gateway.country_code).toBe('US');
+    });
+    test('should return the correct language_code', () => {
+        expect(gateway.language_code).toBe('en-US');
+    });
+});
+//# sourceMappingURL=Gateway.spec.js.map

package/dist/lib/Gateway.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Gateway.spec.js","sourceRoot":"","sources":["../../src/lib/Gateway.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAe,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEnE,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,MAAM,QAAQ,GAAgB;QAC5B,WAAW,EAAE,2BAA2B;QACxC,SAAS,EAAE,2BAA2B;QACtC,SAAS,EAAE,4BAA4B;QACvC,SAAS,EAAE,4BAA4B;QACvC,WAAW,EAAE,IAAI;QACjB,YAAY,EAAE,OAAO;KACtB,CAAC;IAEF,IAAI,OAAgB,CAAC;IAErB,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/lib/Persist.d.ts

@@ -0,0 +1,101 @@
+/**
+ * A utility class for managing persistent storage using `node-persist`.
+ * This class provides methods for storing, retrieving, and caching data with optional expiration.
+ *
+ * @example
+ * ```typescript
+ * const persist = new Persist('./storage');
+ * await persist.init();
+ * await persist.setItem('key', 'value');
+ * const value = await persist.getItem('key');
+ * console.log(value); // Output: 'value'
+ * ```
+ */
+export default class Persist {
+    /**
+     * The `node-persist` instance used for managing storage.
+     */
+    protected persist: any | null;
+    protected dir: string;
+    /**
+     * Creates a new `Persist` instance.
+     *
+     * @param dir - The directory where the persistent storage files will be stored.
+     */
+    constructor(dir: string);
+    /**
+     * Generates a SHA-256 hash of the given input string.
+     *
+     * @param input - The input string to hash.
+     * @returns The SHA-256 hash of the input string.
+     */
+    protected sha256(input: string): string;
+    /**
+     * Detect and migrate legacy plain JSON files in the storage directory.
+     * Legacy files are assumed to be named by the original key (not sha256(key))
+     * and contain raw JSON for the value. Migrated files are written as
+     * JSON datum { key, value, ttl } into filename sha256(key).
+     */
+    protected migrateLegacyFiles(): Promise<void>;
+    /**
+     * Initializes the persistent storage.
+     *
+     * @returns A promise that resolves when the storage is initialized.
+     */
+    init(): Promise<any>;
+    /**
+     * Retrieves an item from storage by its key.
+     *
+     * @param key - The key of the item to retrieve.
+     * @returns A promise that resolves with the value of the item, or `null` if the item does not exist.
+     */
+    getItem(key: string): Promise<any>;
+    /**
+     * Stores an item in storage with the specified key and value.
+     *
+     * @param key - The key to associate with the item.
+     * @param value - The value to store.
+     * @returns A promise that resolves when the item is stored.
+     */
+    setItem(key: string, value: any): Promise<any>;
+    /**
+     * Caches a value indefinitely. If the value does not exist in storage, it is retrieved using the provided callable function.
+     *
+     * @param key - The key to associate with the cached value.
+     * @param callable - A function that returns a promise resolving to the value to cache.
+     * @returns A promise that resolves with the cached value.
+     */
+    cacheForever(key: string, callable: () => Promise<any>): Promise<any>;
+    /**
+     * Caches a value with a time-to-live (TTL). If the value does not exist or is expired, it is retrieved using the provided callable function.
+     *
+     * @param key - The key to associate with the cached value.
+     * @param ttl - The time-to-live for the cached value, in milliseconds.
+     * @param callable - A function that returns a promise resolving to the value to cache.
+     * @returns A promise that resolves with the cached value.
+     */
+    cache(key: string, ttl: number, callable: () => Promise<any>): Promise<any>;
+    /**
+     * Stores an item in storage with an expiration time.
+     *
+     * @param key - The key to associate with the item.
+     * @param value - The value to store.
+     * @param ttl - The time-to-live for the item, in milliseconds.
+     * @returns A promise that resolves when the item is stored.
+     */
+    setWithExpiry(key: string, value: any, ttl: number): Promise<void>;
+    /**
+     * Retrieves an item from storage by its key, considering its expiration time.
+     *
+     * @param key - The key of the item to retrieve.
+     * @returns A promise that resolves with the value of the item, or `null` if the item does not exist or is expired.
+     */
+    getWithExpiry(key: string): Promise<any>;
+    /**
+     * Removes an item from storage by its key.
+     *
+     * @param key - The key of the item to remove.
+     * @returns A promise that resolves when the item is removed.
+     */
+    removeItem(key: string): Promise<any>;
+}