homebridge-plugin-utils 1.0.0

package/dist/ui/featureoptions.js

@@ -0,0 +1,366 @@
+export class FeatureOptions {
+    _categories;
+    _configuredOptions;
+    _groups;
+    _options;
+    defaultReturnValue;
+    defaults;
+    valueOptions;
+    // Create a feature option instance.
+    constructor(categories, options, configuredOptions) {
+        // Initialize our defaults.
+        this._categories = [];
+        this._configuredOptions = [];
+        this._groups = {};
+        this._options = {};
+        this.defaultReturnValue = false;
+        this.defaults = {};
+        this.valueOptions = {};
+        this.categories = categories ?? [];
+        this.configuredOptions = configuredOptions;
+        this.options = options ?? {};
+    }
+    color(option, device) {
+        switch (this.scope(option, device)) {
+            case "device":
+                return "text-info";
+            case "controller":
+                return "text-success";
+            case "global":
+                return device ? "text-warning" : "text-info";
+            default:
+                return "";
+        }
+    }
+    /**
+     * Return the default value for an option.
+     *
+     * @param option        - Feature option to check.
+     *
+     * @returns Returns true or false, depending on the option default.
+     */
+    defaultValue(option) {
+        // Value-centric feature options don't have default values.
+        if (this.isValue(option)) {
+            return this.defaultReturnValue;
+        }
+        const value = this.defaults[option.toLowerCase()];
+        // If it's unknown to us, assume it's true.
+        if (value === undefined) {
+            return this.defaultReturnValue;
+        }
+        return value;
+    }
+    /**
+     * Return whether the option explicitly exists in the list of configured options.
+     *
+     * @param option        - Feature option to check.
+     * @param id            - Optional device or controller scope identifier to check.
+     *
+     * @returns Returns true if the option has been explicitly configured, false otherwise.
+     */
+    exists(option, id) {
+        const regex = this.isValue(option) ? this.valueRegex(option, id) : this.optionRegex(option, id);
+        return this.configuredOptions.some(x => regex.test(x));
+    }
+    /**
+     * Return a fully formed feature option string.
+     *
+     * @param category      - Feature option category entry or category name string.
+     * @param option        - Feature option entry of option name string.
+     *
+     * @returns Returns a fully formed feature option in the form of `category.option`.
+     */
+    expandOption(category, option) {
+        const categoryName = (typeof category === "string") ? category : category.name;
+        const optionName = (typeof option === "string") ? option : option.name;
+        if (!categoryName || !categoryName.length) {
+            return "";
+        }
+        return (!optionName || !optionName.length) ? categoryName : categoryName + "." + optionName;
+    }
+    /**
+     * Parse a floating point feature option value.
+     *
+     * @param value        - Value to parse.
+     *
+     * @returns Returns a floating point number from a string, or `undefined` if it couldn't be parsed.
+     */
+    getFloat(value) {
+        // We don't have the value configured -- we're done.
+        if (value === undefined) {
+            return undefined;
+        }
+        // Parse the number and return the value.
+        return this.parseOptionNumeric(value, parseFloat);
+    }
+    /**
+     * Parse an integer feature option value.
+     *
+     * @param value        - Value to parse.
+     *
+     * @returns Returns an integer from a string, or `undefined` if it couldn't be parsed.
+     */
+    getInteger(value) {
+        // We don't have the value configured -- we're done.
+        if (value === undefined) {
+            return undefined;
+        }
+        // Parse the number and return the value.
+        return this.parseOptionNumeric(value, parseInt);
+    }
+    /**
+     * Return whether an option has been set in either the device or controller scope context.
+     *
+     * @param option        - Feature option to check.
+     *
+     * @returns Returns true if the option is set at the device or controller level and false otherwise.
+     */
+    isScopeDevice(option, device) {
+        const value = this.exists(option, device);
+        // Return the value if it's set, or the default value for this option.
+        return (value !== undefined) ? value : this.defaultValue(option);
+    }
+    /**
+     * Return whether an option has been set in the global scope context.
+     *
+     * @param option        - Feature option to check.
+     *
+     * @returns Returns true if the option is set globally and false otherwise.
+     */
+    isScopeGlobal(option) {
+        const value = this.exists(option);
+        // Return the value if it's set, or the default value for this option.
+        return (value !== undefined) ? value : this.defaultValue(option);
+    }
+    /**
+     * Return whether an option is value-centric or not.
+     *
+     * @param option        - Feature option entry or string to check.
+     *
+     * @returns Returns true if it is a value-centric option and false otherwise.
+     */
+    isValue(option) {
+        return this.valueOptions[option?.toLowerCase()] === true;
+    }
+    /**
+     * Return the scope hierarchy location of an option.
+     *
+     * @param option        - Feature option to check.
+     * @param device        - Optional device scope identifier.
+     * @param controller    - Optional controller scope identifier.
+     *
+     * @returns Returns an object containing the location in the scope hierarchy of an `option` as well as the current value associated with the option.
+     */
+    scope(option, device, controller) {
+        return this.getOptionInfo(option, device, controller).scope;
+    }
+    /**
+     * Return the current state of a feature option, traversing the scope hierarchy.
+     *
+     * @param option        - Feature option to check.
+     * @param device        - Optional device scope identifier.
+     * @param controller    - Optional controller scope identifier.
+     *
+     * @returns Returns true if the option is enabled, and false otherwise.
+     */
+    test(option, device, controller) {
+        return this.getOptionInfo(option, device, controller).value;
+    }
+    /**
+     * Return the value associated with a value-centric feature option, traversing the scope hierarchy.
+     *
+     * @param option        - Feature option to check.
+     * @param device        - Optional device scope identifier.
+     * @param controller    - Optional controller scope identifier.
+     *
+     * @returns Returns the current value associated with `option` or `undefined` if none.
+     */
+    value(option, device, controller) {
+        const getValue = (checkOption, checkId) => {
+            const regex = this.valueRegex(checkOption, checkId);
+            // Get the option value, if we have one.
+            for (const entry of this.configuredOptions) {
+                const regexMatch = regex.exec(entry);
+                if (regexMatch) {
+                    return regexMatch[1];
+                }
+            }
+            return undefined;
+        };
+        // Check to see if we have a device-level value first.
+        if (device) {
+            const value = getValue(option, device);
+            if (value) {
+                return value;
+            }
+        }
+        // Now check to see if we have an controller-level value.
+        if (controller) {
+            const value = getValue(option, controller);
+            if (value) {
+                return value;
+            }
+        }
+        // Finally, we check for a global-level value.
+        return getValue(option);
+    }
+    /**
+     * Return the list of available feature option categories.
+     *
+     * @returns Returns the current list of available feature option categories.
+     */
+    get categories() {
+        return this._categories;
+    }
+    /**
+     * Set the list of available feature option categories.
+     *
+     * @param options       - Array of available feature options.
+     */
+    set categories(category) {
+        this._categories = category;
+    }
+    /**
+     * Return the list of currently configured feature options.
+     *
+     * @returns Returns the currently configured list of feature options.
+     */
+    get configuredOptions() {
+        return this._configuredOptions;
+    }
+    /**
+     * Set the list of currently configured feature options.
+     *
+     * @param options       - Array of configured feature options.
+     */
+    set configuredOptions(options) {
+        this._configuredOptions = options ?? [];
+    }
+    /**
+     * Return the list of available feature option groups.
+     *
+     * @returns Returns the current list of available feature option groups.
+     */
+    get groups() {
+        return this._groups;
+    }
+    /**
+     * Return the list of available feature options.
+     *
+     * @returns Returns the current list of available feature options.
+     */
+    get options() {
+        return this._options;
+    }
+    /**
+     * Set the list of available feature options.
+     *
+     * @param options       - Array of available feature options.
+     */
+    set options(options) {
+        this._options = options ?? {};
+        // Regenerate our defaults.
+        this.generateDefaults();
+    }
+    // Build our list of default values for our feature options.
+    generateDefaults() {
+        this.defaults = {};
+        this._groups = {};
+        this.valueOptions = {};
+        for (const category of this.categories) {
+            // Now enumerate all the feature options for a given device and add then to the full list.
+            for (const option of this.options[category.name]) {
+                // Expand the entry.
+                const entry = this.expandOption(category, option);
+                // Index the default value.
+                this.defaults[entry.toLowerCase()] = option.default;
+                // Track value-centric options.
+                this.valueOptions[entry.toLowerCase()] = "defaultValue" in option;
+                // Cross reference the feature option group it belongs to, if any.
+                if (option.group !== undefined) {
+                    const expandedGroup = category.name + (option.group.length ? ("." + option.group) : "");
+                    // Initialize the group entry if needed and add the entry.
+                    (this._groups[expandedGroup] ??= []).push(entry);
+                }
+            }
+        }
+    }
+    // Utility function to return the setting of a particular option and it's position in the scoping hierarchy.
+    getOptionInfo(option, device, controller) {
+        // There are a couple of ways to enable and disable options. The rules of the road are:
+        //
+        // 1. Explicitly disabling, or enabling an option on the controller propogates to all the devices that are managed by that controller. Why might you want to do this?
+        //    Because...
+        //
+        // 2. Explicitly disabling, or enabling an option on a device always override the above. This means that it's possible to disable an option for a controller, and all
+        //    the devices that are managed by it, and then override that behavior on a single device that it's managing.
+        // Check to see if we have a device-level option first.
+        if (device && this.exists(option, device)) {
+            const value = this.isOptionEnabled(option, device);
+            if (value !== undefined) {
+                return { scope: "device", value: value };
+            }
+        }
+        // Now check to see if we have an controller-level option.
+        if (controller && this.exists(option, controller)) {
+            const value = this.isOptionEnabled(option, controller);
+            if (value !== undefined) {
+                return { scope: "controller", value: value };
+            }
+        }
+        // Finally, we check for a global-level value.
+        if (this.exists(option)) {
+            const value = this.isOptionEnabled(option);
+            if (value !== undefined) {
+                return { scope: "global", value: value };
+            }
+        }
+        // The option hasn't been set at any scope, return our default value.
+        return { scope: "none", value: this.defaultValue(option) };
+    }
+    // Utility to test whether an option is set in a given scope.
+    // We return true if an option is enabled, false for disabled, undefined otherwise. For value-centric options, we return true if a value exists.
+    isOptionEnabled(option, id) {
+        // Deal with value-centric options uniquely.
+        if (this.isValue(option)) {
+            return this.exists(option, id);
+        }
+        const regex = this.optionRegex(option, id);
+        // Get the option value, if we have one.
+        for (const entry of this.configuredOptions) {
+            const regexMatch = regex.exec(entry);
+            if (regexMatch) {
+                return regexMatch[1].toLowerCase() === "enable";
+            }
+        }
+        return undefined;
+    }
+    // Regular expression test for feature options.
+    optionRegex(option, id) {
+        // This regular expression is a bit more intricate than you might think it should be due to the need to ensure we capture values at the very end of the option. We
+        // also need to escape out our option to ensure we have no inadvertent issues in matching the regular expression.
+        return new RegExp("^(Enable|Disable)\\." + option.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") + (!id ? "" : "\\." + id) + "$", "gi");
+    }
+    // Utility function to parse and return a numeric configuration parameter.
+    parseOptionNumeric(option, convert) {
+        // We don't have the option configured -- we're done.
+        if (option === undefined) {
+            return undefined;
+        }
+        // Convert it to a number, if needed.
+        const convertedValue = convert(option);
+        // Let's validate to make sure it's really a number.
+        if (isNaN(convertedValue) || (convertedValue < 0)) {
+            return undefined;
+        }
+        // Return the value.
+        return convertedValue;
+    }
+    // Regular expression test for value-centric feature options.
+    valueRegex(option, id) {
+        // This regular expression is a bit more intricate than you might think it should be due to the need to ensure we capture values at the very end of the option.
+        return new RegExp("^Enable\\." + option.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") + (!id ? "" : "\\." + id) + "\\.([^\\.]+)$", "gi");
+    }
+}
+//# sourceMappingURL=featureoptions.js.map

package/dist/ui/featureoptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureoptions.js","sourceRoot":"","sources":["../src/featureoptions.ts"],"names":[],"mappings":"AA8BA,MAAM,OAAO,cAAc;IAEjB,WAAW,CAAyB;IACpC,kBAAkB,CAAW;IAC7B,OAAO,CAAgC;IACvC,QAAQ,CAA4C;IACrD,kBAAkB,CAAU;IAC3B,QAAQ,CAA+B;IACvC,YAAY,CAA+B;IAEnD,oCAAoC;IACpC,YAAY,UAAkC,EAAE,OAAkD,EAAE,iBAA2B;QAE7H,2BAA2B;QAC3B,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QAEvB,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,MAAc,EAAE,MAAe;QAE1C,QAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;YAElC,KAAK,QAAQ;gBAEX,OAAO,WAAW,CAAC;YAErB,KAAK,YAAY;gBAEf,OAAO,cAAc,CAAC;YAExB,KAAK,QAAQ;gBAEX,OAAO,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC;YAE/C;gBAEE,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,YAAY,CAAC,MAAc;QAEhC,2DAA2D;QAC3D,IAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAExB,OAAO,IAAI,CAAC,kBAAkB,CAAC;QACjC,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAElD,2CAA2C;QAC3C,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YAEvB,OAAO,IAAI,CAAC,kBAAkB,CAAC;QACjC,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAc,EAAE,EAAW;QAEvC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEhG,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CAAC,QAAuC,EAAE,MAAmC;QAE9F,MAAM,YAAY,GAAG,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/E,MAAM,UAAU,GAAG,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAEvE,IAAG,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAEzC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,CAAC,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,GAAG,GAAG,GAAG,UAAU,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,KAAyB;QAEvC,oDAAoD;QACpD,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YAEvB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,yCAAyC;QACzC,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,KAAyB;QAEzC,oDAAoD;QACpD,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YAEvB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,yCAAyC;QACzC,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,MAAc,EAAE,MAAc;QAEjD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE1C,sEAAsE;QACtE,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,MAAc;QAEjC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAElC,sEAAsE;QACtE,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,MAAc;QAE3B,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,KAAK,IAAI,CAAC;IAC3D,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAc,EAAE,MAAe,EAAE,UAAmB;QAE/D,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,KAAK,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACI,IAAI,CAAC,MAAc,EAAE,MAAe,EAAE,UAAmB;QAE9D,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,KAAK,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAc,EAAE,MAAe,EAAE,UAAmB;QAE/D,MAAM,QAAQ,GAAG,CAAC,WAAmB,EAAE,OAAgB,EAAsB,EAAE;YAE7E,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAEpD,wCAAwC;YACxC,KAAI,MAAM,KAAK,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAE1C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAErC,IAAG,UAAU,EAAE,CAAC;oBAEd,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QAEF,sDAAsD;QACtD,IAAG,MAAM,EAAE,CAAC;YAEV,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAEvC,IAAG,KAAK,EAAE,CAAC;gBAET,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,yDAAyD;QACzD,IAAG,UAAU,EAAE,CAAC;YAEd,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAE3C,IAAG,KAAK,EAAE,CAAC;gBAET,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,8CAA8C;QAC9C,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QAEnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU,CAAC,QAAgC;QAEpD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAW,iBAAiB;QAE1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAW,iBAAiB,CAAC,OAAiB;QAE5C,IAAI,CAAC,kBAAkB,GAAG,OAAO,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,IAAW,MAAM;QAEf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAW,OAAO;QAEhB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAW,OAAO,CAAC,OAAkD;QAEnE,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,EAAE,CAAC;QAE9B,2BAA2B;QAC3B,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAED,4DAA4D;IACpD,gBAAgB;QAEtB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QAEvB,KAAI,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAEtC,0FAA0F;YAC1F,KAAI,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAEhD,oBAAoB;gBACpB,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAElD,2BAA2B;gBAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC;gBAEpD,+BAA+B;gBAC/B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,GAAG,cAAc,IAAI,MAAM,CAAC;gBAElE,kEAAkE;gBAClE,IAAG,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAE9B,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBAExF,0DAA0D;oBAC1D,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,4GAA4G;IACpG,aAAa,CAAC,MAAc,EAAE,MAAe,EAAE,UAAmB;QAExE,uFAAuF;QACvF,EAAE;QACF,qKAAqK;QACrK,gBAAgB;QAChB,EAAE;QACF,qKAAqK;QACrK,gHAAgH;QAEhH,uDAAuD;QACvD,IAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;YAEzC,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAEnD,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;gBAEvB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,0DAA0D;QAC1D,IAAG,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;YAEjD,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAEvD,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;gBAEvB,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAC/C,CAAC;QACH,CAAC;QAED,8CAA8C;QAC9C,IAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAEvB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YAE3C,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;gBAEvB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,qEAAqE;QACrE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;IAC7D,CAAC;IAED,6DAA6D;IAC7D,gJAAgJ;IACxI,eAAe,CAAC,MAAc,EAAE,EAAW;QAEjD,4CAA4C;QAC5C,IAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAExB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACjC,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAE3C,wCAAwC;QACxC,KAAI,MAAM,KAAK,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAE1C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAErC,IAAG,UAAU,EAAE,CAAC;gBAEd,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC;YAClD,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,+CAA+C;IACvC,WAAW,CAAC,MAAc,EAAE,EAAW;QAE7C,kKAAkK;QAClK,iHAAiH;QACjH,OAAO,IAAI,MAAM,CAAC,sBAAsB,GAAG,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,IAAI,CAAC,CAAC;IAClI,CAAC;IAED,0EAA0E;IAClE,kBAAkB,CAAC,MAA0B,EAAE,OAAkC;QAEvF,qDAAqD;QACrD,IAAG,MAAM,KAAK,SAAS,EAAE,CAAC;YAExB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,qCAAqC;QACrC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAEvC,oDAAoD;QACpD,IAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC;YAEjD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,oBAAoB;QACpB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,6DAA6D;IACrD,UAAU,CAAC,MAAc,EAAE,EAAW;QAE5C,+JAA+J;QAC/J,OAAO,IAAI,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,eAAe,EAAE,IAAI,CAAC,CAAC;IACpI,CAAC;CACF"}

package/dist/ui/webUi.mjs

@@ -0,0 +1,155 @@
+/* Copyright(C) 2017-2024, HJD (https://github.com/hjdhjd). All rights reserved.
+ *
+ * webUi.mjs: Plugin webUI.
+ */
+"use strict";
+
+export class webUi {
+
+  // Feature options class instance.
+  #featureOptions;
+
+  // Homebridge class instance.
+  #homebridge;
+
+  // Plugin name.
+  #name;
+
+  constructor({ name, featureOptions, homebridge } = {}) {
+
+    this.homebridge = homebridge;
+    this.featureOptions = featureOptions;
+    this.name = name;
+
+    // Fire off our UI, catching errors along the way.
+    try {
+
+      this.#launchWebUI();
+    } catch(err) {
+
+      // If we had an error instantiating or updating the UI, notify the user.
+      this.homebridge.toast.error(err.message, "Error");
+    } finally {
+
+      // Always leave the UI in a usable place for the end user.
+      this.homebridge.hideSpinner();
+    }
+  }
+
+  // Show the first run user experience if we don't have valid login credentials.
+  async #showFirstRun() {
+
+    const buttonFirstRun = document.getElementById("firstRun");
+
+    // First run user experience.
+    buttonFirstRun.addEventListener("click", async () => {
+
+      // Show the beachball while we setup.
+      this.homebridge.showSpinner();
+
+      // Get the list of devices the plugin knows about.
+      const devices = await this.homebridge.getCachedAccessories();
+
+      // Sort it for posterity.
+      devices?.sort((a, b) => {
+
+        const aCase = (a.displayName ?? "").toLowerCase();
+        const bCase = (b.displayName ?? "").toLowerCase();
+
+        return aCase > bCase ? 1 : (bCase > aCase ? -1 : 0);
+      });
+
+      // Create our UI.
+      document.getElementById("pageFirstRun").style.display = "none";
+      document.getElementById("menuWrapper").style.display = "inline-flex";
+      this.featureOptions.showUI();
+
+      // All done. Let the user interact with us, although in practice, we shouldn't get here.
+      // this.homebridge.hideSpinner();
+    });
+
+    document.getElementById("pageFirstRun").style.display = "block";
+  }
+
+  // Show the main plugin configuration tab.
+  #showSettings() {
+
+    // Show the beachball while we setup.
+    this.homebridge.showSpinner();
+
+    // Create our UI.
+    document.getElementById("menuHome").classList.remove("btn-elegant");
+    document.getElementById("menuHome").classList.add("btn-primary");
+    document.getElementById("menuFeatureOptions").classList.remove("btn-elegant");
+    document.getElementById("menuFeatureOptions").classList.add("btn-primary");
+    document.getElementById("menuSettings").classList.add("btn-elegant");
+    document.getElementById("menuSettings").classList.remove("btn-primary");
+
+    document.getElementById("pageSupport").style.display = "none";
+    document.getElementById("pageFeatureOptions").style.display = "none";
+
+    this.homebridge.showSchemaForm();
+
+    // All done. Let the user interact with us.
+    this.homebridge.hideSpinner();
+  }
+
+  // Show the support tab.
+  #showSupport() {
+
+    // Show the beachball while we setup.
+    this.homebridge.showSpinner();
+    this.homebridge.hideSchemaForm();
+
+    // Create our UI.
+    document.getElementById("menuHome").classList.add("btn-elegant");
+    document.getElementById("menuHome").classList.remove("btn-primary");
+    document.getElementById("menuFeatureOptions").classList.remove("btn-elegant");
+    document.getElementById("menuFeatureOptions").classList.add("btn-primary");
+    document.getElementById("menuSettings").classList.remove("btn-elegant");
+    document.getElementById("menuSettings").classList.add("btn-primary");
+
+    document.getElementById("pageSupport").style.display = "block";
+    document.getElementById("pageFeatureOptions").style.display = "none";
+
+    // All done. Let the user interact with us.
+    this.homebridge.hideSpinner();
+  }
+
+  // Launch our webUI.
+  async #launchWebUI() {
+
+    // Retrieve the current plugin configuration.
+    this.featureOptions.currentConfig = await this.homebridge.getPluginConfig();
+
+    // Add our event listeners to animate the UI.
+    document.getElementById("menuHome").addEventListener("click", () => this.#showSupport());
+    document.getElementById("menuFeatureOptions").addEventListener("click", () => this.featureOptions.showUI());
+    document.getElementById("menuSettings").addEventListener("click", () => this.#showSettings());
+
+    // Get the list of devices the plugin knows about.
+    const devices = await this.homebridge.getCachedAccessories();
+
+    // If we've got devices detected, we launch our feature option UI. Otherwise, we launch our first run UI.
+    if(this.featureOptions.currentConfig.length && devices?.length) {
+
+      document.getElementById("menuWrapper").style.display = "inline-flex";
+      this.featureOptions.showUI();
+      return;
+    }
+
+    // If we have no configuration, let's create one.
+    if(!this.featureOptions.currentConfig.length) {
+
+      this.featureOptions.currentConfig.push({ name: this.name });
+    } else if(!("name" in this.featureOptions.currentConfig[0])) {
+
+      // If we haven't set the name, let's do so now.
+      this.featureOptions.currentConfig[0].name = this.name;
+    }
+
+    // Update the plugin configuration and launch the first run UI.
+    await this.homebridge.updatePluginConfig(this.featureOptions.currentConfig);
+    this.#showFirstRun();
+  }
+}