homebridge 2.0.0-alpha.4 → 2.0.0-alpha.40

package/dist/plugin.js

@@ -0,0 +1,182 @@
+import assert from 'node:assert';
+import { join } from 'node:path';
+import process from 'node:process';
+import { pathToFileURL } from 'node:url';
+import { satisfies } from 'semver';
+import { Logger } from './logger.js';
+import { PluginManager } from './pluginManager.js';
+import getVersion from './version.js';
+const log = Logger.internal;
+/**
+ * Represents a loaded Homebridge plugin.
+ */
+export class Plugin {
+    pluginName;
+    scope; // npm package scope
+    pluginPath; // like "/usr/local/lib/node_modules/homebridge-lockitron"
+    disabled = false; // mark the plugin as disabled
+    // ------------------ package.json content ------------------
+    version;
+    main;
+    loadContext;
+    // ----------------------------------------------------------
+    pluginInitializer; // default exported function from the plugin that initializes it
+    registeredAccessories = new Map();
+    registeredPlatforms = new Map();
+    activeDynamicPlatforms = new Map();
+    constructor(name, path, packageJSON, scope) {
+        this.pluginName = name;
+        this.scope = scope;
+        this.pluginPath = path;
+        this.version = packageJSON.version || '0.0.0';
+        this.main = '';
+        // figure out the main module
+        // exports is available - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_package_entry_points
+        if (packageJSON.exports) {
+            // main entrypoint - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_main_entry_point_export
+            if (typeof packageJSON.exports === 'string') {
+                this.main = packageJSON.exports;
+            }
+            else { // subpath export - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_subpath_exports
+                // conditional exports - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_conditional_exports
+                const exports = packageJSON.exports.import || packageJSON.exports.require || packageJSON.exports.node || packageJSON.exports.default || packageJSON.exports['.'];
+                // check if conditional export is nested
+                if (typeof exports !== 'string') {
+                    if (exports.import) {
+                        this.main = exports.import;
+                    }
+                    else {
+                        this.main = exports.require || exports.node || exports.default;
+                    }
+                }
+                else {
+                    this.main = exports;
+                }
+            }
+        }
+        // exports search was not successful, fallback to package.main, using index.js as fallback
+        if (!this.main) {
+            this.main = packageJSON.main || './index.js';
+        }
+        // very temporary fix for first wave of plugins
+        if (packageJSON.peerDependencies && (!packageJSON.engines || !packageJSON.engines.homebridge)) {
+            packageJSON.engines = packageJSON.engines || {};
+            packageJSON.engines.homebridge = packageJSON.peerDependencies.homebridge;
+        }
+        this.loadContext = {
+            engines: packageJSON.engines,
+            dependencies: packageJSON.dependencies,
+        };
+    }
+    getPluginIdentifier() {
+        return (this.scope ? `${this.scope}/` : '') + this.pluginName;
+    }
+    getPluginPath() {
+        return this.pluginPath;
+    }
+    registerAccessory(name, constructor) {
+        if (this.registeredAccessories.has(name)) {
+            throw new Error(`Plugin '${this.getPluginIdentifier()}' tried to register an accessory '${name}' which has already been registered!`);
+        }
+        if (!this.disabled) {
+            log.info('Registering accessory \'%s\'', `${this.getPluginIdentifier()}.${name}`);
+        }
+        this.registeredAccessories.set(name, constructor);
+    }
+    registerPlatform(name, constructor) {
+        if (this.registeredPlatforms.has(name)) {
+            throw new Error(`Plugin '${this.getPluginIdentifier()}' tried to register a platform '${name}' which has already been registered!`);
+        }
+        if (!this.disabled) {
+            log.info('Registering platform \'%s\'', `${this.getPluginIdentifier()}.${name}`);
+        }
+        this.registeredPlatforms.set(name, constructor);
+    }
+    getAccessoryConstructor(accessoryIdentifier) {
+        const name = PluginManager.getAccessoryName(accessoryIdentifier);
+        const constructor = this.registeredAccessories.get(name);
+        if (!constructor) {
+            throw new Error(`The requested accessory '${name}' was not registered by the plugin '${this.getPluginIdentifier()}'.`);
+        }
+        return constructor;
+    }
+    getPlatformConstructor(platformIdentifier) {
+        const name = PluginManager.getPlatformName(platformIdentifier);
+        const constructor = this.registeredPlatforms.get(name);
+        if (!constructor) {
+            throw new Error(`The requested platform '${name}' was not registered by the plugin '${this.getPluginIdentifier()}'.`);
+        }
+        // If it's a dynamic platform plugin, ensure it's not enabled multiple times.
+        if (this.activeDynamicPlatforms.has(name)) {
+            throw new Error(`The dynamic platform ${name} from the plugin ${this.getPluginIdentifier()} is configured `
+                + 'times in your config.json.');
+        }
+        return constructor;
+    }
+    assignDynamicPlatform(platformIdentifier, platformPlugin) {
+        const name = PluginManager.getPlatformName(platformIdentifier);
+        let platforms = this.activeDynamicPlatforms.get(name);
+        if (!platforms) {
+            platforms = [];
+            this.activeDynamicPlatforms.set(name, platforms);
+        }
+        // the last platform published should be at the first position for easy access
+        // we just try to mimic pre 1.0.0 behavior
+        platforms.unshift(platformPlugin);
+    }
+    getActiveDynamicPlatform(platformName) {
+        const platforms = this.activeDynamicPlatforms.get(platformName);
+        // we always use the last registered
+        return platforms && platforms[0];
+    }
+    async load() {
+        const context = this.loadContext;
+        assert(context, 'Reached illegal state. Plugin state is undefined!');
+        this.loadContext = undefined; // free up memory
+        // pluck out the Homebridge version requirement
+        if (!context.engines || !context.engines.homebridge) {
+            throw new Error(`Plugin ${this.pluginPath} does not contain the 'homebridge' package in 'engines'.`);
+        }
+        const versionRequired = context.engines.homebridge;
+        const nodeVersionRequired = context.engines.node;
+        // make sure the version is satisfied by the currently running version of Homebridge
+        if (!satisfies(getVersion(), versionRequired, { includePrerelease: true })) {
+            // TODO - change this back to an error
+            log.warn(`The plugin "${this.pluginName}" requires a Homebridge version of ${versionRequired} which does \
+not satisfy the current Homebridge version of v${getVersion()}. You may need to update this plugin (or Homebridge) to a newer version. \
+You may face unexpected issues or stability problems running this plugin.`);
+        }
+        // make sure the version is satisfied by the currently running version of Node
+        if (nodeVersionRequired && !satisfies(process.version, nodeVersionRequired)) {
+            log.warn(`The plugin "${this.pluginName}" requires a Node.js version of ${nodeVersionRequired} which does \
+not satisfy the current Node.js version of ${process.version}. You may need to upgrade your installation of Node.js - see https://homebridge.io/w/JTKEF`);
+        }
+        const dependencies = context.dependencies || {};
+        if (dependencies.homebridge || dependencies['hap-nodejs']) {
+            log.error(`The plugin "${this.pluginName}" defines 'homebridge' and/or 'hap-nodejs' in their 'dependencies' section, \
+meaning they carry an additional copy of homebridge and hap-nodejs. This not only wastes disk space, but also can cause \
+major incompatibility issues and thus is considered bad practice. Please inform the developer to update their plugin!`);
+        }
+        const mainPath = join(this.pluginPath, this.main);
+        // try to import it and grab the exported initialization hook
+        // pathToFileURL(specifier).href to turn a path into a "file url"
+        // see https://github.com/nodejs/node/issues/31710
+        const pluginModules = (await import(pathToFileURL(mainPath).href)).default;
+        if (typeof pluginModules === 'function') {
+            this.pluginInitializer = pluginModules;
+        }
+        else if (pluginModules && typeof pluginModules.default === 'function') {
+            this.pluginInitializer = pluginModules.default;
+        }
+        else {
+            throw new Error(`Plugin ${this.pluginPath} does not export a initializer function from main.`);
+        }
+    }
+    initialize(api) {
+        if (!this.pluginInitializer) {
+            throw new Error('Tried to initialize a plugin which hasn\'t been loaded yet!');
+        }
+        return this.pluginInitializer(api);
+    }
+}
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAeA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAElC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,UAAU,MAAM,cAAc,CAAA;AAErC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAA;AAE3B;;GAEG;AACH,MAAM,OAAO,MAAM;IACA,UAAU,CAAY;IACtB,KAAK,CAAS,CAAC,oBAAoB;IACnC,UAAU,CAAQ,CAAC,0DAA0D;IACvF,QAAQ,GAAG,KAAK,CAAA,CAAC,8BAA8B;IAEtD,6DAA6D;IACpD,OAAO,CAAQ;IACP,IAAI,CAAQ;IACrB,WAAW,CAGlB;IACD,6DAA6D;IAErD,iBAAiB,CAAoB,CAAC,gEAAgE;IAC7F,qBAAqB,GAAmD,IAAI,GAAG,EAAE,CAAA;IACjF,mBAAmB,GAAiD,IAAI,GAAG,EAAE,CAAA;IAC7E,sBAAsB,GAA+C,IAAI,GAAG,EAAE,CAAA;IAE/F,YAAY,IAAgB,EAAE,IAAY,EAAE,WAAwB,EAAE,KAAc;QAClF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,OAAO,CAAA;QAC7C,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,6BAA6B;QAC7B,mHAAmH;QACnH,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,iHAAiH;YACjH,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC5C,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,OAAO,CAAA;YACjC,CAAC;iBAAM,CAAC,CAAC,wGAAwG;gBAC/G,iHAAiH;gBACjH,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBAEhK,wCAAwC;gBACxC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;oBAChC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;wBACnB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,CAAA;oBAC5B,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,CAAA;oBAChE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,IAAI,GAAG,OAAO,CAAA;gBACrB,CAAC;YACH,CAAC;QACH,CAAC;QAED,0FAA0F;QAC1F,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,YAAY,CAAA;QAC9C,CAAC;QAED,+CAA+C;QAC/C,IAAI,WAAW,CAAC,gBAAgB,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9F,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,EAAE,CAAA;YAC/C,WAAW,CAAC,OAAO,CAAC,UAAU,GAAG,WAAW,CAAC,gBAAgB,CAAC,UAAU,CAAA;QAC1E,CAAC;QAED,IAAI,CAAC,WAAW,GAAG;YACjB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,YAAY,EAAE,WAAW,CAAC,YAAY;SACvC,CAAA;IACH,CAAC;IAEM,mBAAmB;QACxB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;IAC/D,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAEM,iBAAiB,CAAC,IAAmB,EAAE,WAAuC;QACnF,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,CAAC,mBAAmB,EAAE,qCAAqC,IAAI,sCAAsC,CAAC,CAAA;QACvI,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,GAAG,CAAC,IAAI,CAAC,8BAA8B,EAAE,GAAG,IAAI,CAAC,mBAAmB,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;QACnF,CAAC;QAED,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACnD,CAAC;IAEM,gBAAgB,CAAC,IAAkB,EAAE,WAAsC;QAChF,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,CAAC,mBAAmB,EAAE,mCAAmC,IAAI,sCAAsC,CAAC,CAAA;QACrI,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,GAAG,IAAI,CAAC,mBAAmB,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;QAClF,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACjD,CAAC;IAEM,uBAAuB,CAAC,mBAAwD;QACrF,MAAM,IAAI,GAAkB,aAAa,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAA;QAE/E,MAAM,WAAW,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACxD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,uCAAuC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAA;QACxH,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAEM,sBAAsB,CAAC,kBAAqD;QACjF,MAAM,IAAI,GAAiB,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAA;QAE5E,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACtD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,uCAAuC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAA;QACvH,CAAC;QAED,6EAA6E;QAC7E,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,oBAAoB,IAAI,CAAC,mBAAmB,EAAE,iBAAiB;kBACvG,4BAA4B,CAAC,CAAA;QACnC,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAEM,qBAAqB,CAAC,kBAAqD,EAAE,cAAqC;QACvH,MAAM,IAAI,GAAiB,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAA;QAE5E,IAAI,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACrD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,EAAE,CAAA;YACd,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAClD,CAAC;QAED,8EAA8E;QAC9E,0CAA0C;QAC1C,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IACnC,CAAC;IAEM,wBAAwB,CAAC,YAA0B;QACxD,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QAC/D,oCAAoC;QACpC,OAAO,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,WAAY,CAAA;QACjC,MAAM,CAAC,OAAO,EAAE,mDAAmD,CAAC,CAAA;QACpE,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA,CAAC,iBAAiB;QAE9C,+CAA+C;QAC/C,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,CAAC,UAAU,0DAA0D,CAAC,CAAA;QACtG,CAAC;QAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAA;QAClD,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAA;QAEhD,oFAAoF;QACpF,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,eAAe,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YAC3E,sCAAsC;YACtC,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,UAAU,sCAAsC,eAAe;iDACjD,UAAU,EAAE;0EACa,CAAC,CAAA;QACvE,CAAC;QAED,8EAA8E;QAC9E,IAAI,mBAAmB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,EAAE,CAAC;YAC5E,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,UAAU,mCAAmC,mBAAmB;6CACtD,OAAO,CAAC,OAAO,4FAA4F,CAAC,CAAA;QACrJ,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,EAAE,CAAA;QAC/C,IAAI,YAAY,CAAC,UAAU,IAAI,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1D,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,UAAU;;sHAEwE,CAAC,CAAA;QACnH,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAEjD,6DAA6D;QAC7D,iEAAiE;QACjE,kDAAkD;QAClD,MAAM,aAAa,GAAG,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAA;QAE1E,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;YACxC,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAA;QACxC,CAAC;aAAM,IAAI,aAAa,IAAI,OAAO,aAAa,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACxE,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAA;QAChD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,CAAC,UAAU,oDAAoD,CAAC,CAAA;QAChG,CAAC;IACH,CAAC;IAEM,UAAU,CAAC,GAAQ;QACxB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;QAChF,CAAC;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;IACpC,CAAC;CACF"}

package/dist/pluginManager.d.ts

@@ -0,0 +1,77 @@
+import type { AccessoryIdentifier, AccessoryName, HomebridgeAPI, PlatformIdentifier, PlatformName, PluginIdentifier, PluginName } from './api.js';
+import { Plugin } from './plugin.js';
+export interface PackageJSON {
+    name: string;
+    version: string;
+    keywords?: string[];
+    exports?: string | Record<string, string | Record<string, string>>;
+    main?: string;
+    /**
+     * When set as module, it marks .js file to be treated as ESM.
+     * See https://nodejs.org/dist/latest-v14.x/docs/api/esm.html#esm_enabling
+     */
+    type?: 'module' | 'commonjs';
+    engines?: Record<string, string>;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+}
+export interface PluginManagerOptions {
+    /**
+     * Additional path to search for plugins in. Specified relative to the current working directory.
+     */
+    customPluginPath?: string;
+    /**
+     * If set, only load plugins from the customPluginPath, if set, otherwise only from the primary global node_modules.
+     */
+    strictPluginResolution?: boolean;
+    /**
+     * When defined, only plugins specified here will be initialized.
+     */
+    activePlugins?: PluginIdentifier[];
+    /**
+     * Plugins that are marked as disabled and whose corresponding config blocks should be ignored
+     */
+    disabledPlugins?: PluginIdentifier[];
+}
+/**
+ * Utility which exposes methods to search for installed Homebridge plugins
+ */
+export declare class PluginManager {
+    private static readonly PLUGIN_IDENTIFIER_PATTERN;
+    private readonly api;
+    private readonly searchPaths;
+    private readonly strictPluginResolution;
+    private readonly activePlugins?;
+    private readonly disabledPlugins?;
+    private readonly plugins;
+    private readonly pluginIdentifierTranslation;
+    private readonly accessoryToPluginMap;
+    private readonly platformToPluginMap;
+    private currentInitializingPlugin?;
+    constructor(api: HomebridgeAPI, options?: PluginManagerOptions);
+    static isQualifiedPluginIdentifier(identifier: string): boolean;
+    static extractPluginName(name: string): PluginName;
+    static extractPluginScope(name: string): string;
+    static getAccessoryName(identifier: AccessoryIdentifier): AccessoryName;
+    static getPlatformName(identifier: PlatformIdentifier): PlatformIdentifier;
+    static getPluginIdentifier(identifier: AccessoryIdentifier | PlatformIdentifier): PluginIdentifier;
+    initializeInstalledPlugins(): Promise<void>;
+    initializePlugin(plugin: Plugin, identifier: string): Promise<void>;
+    private handleRegisterAccessory;
+    private handleRegisterPlatform;
+    getPluginForAccessory(accessoryIdentifier: AccessoryIdentifier | AccessoryName): Plugin;
+    getPluginForPlatform(platformIdentifier: PlatformIdentifier | PlatformName): Plugin;
+    hasPluginRegistered(pluginIdentifier: PluginIdentifier): boolean;
+    getPlugin(pluginIdentifier: PluginIdentifier): Plugin | undefined;
+    getPluginByActiveDynamicPlatform(platformName: PlatformName): Plugin | undefined;
+    /**
+     * Gets all plugins installed on the local system
+     */
+    private loadInstalledPlugins;
+    loadPlugin(absolutePath: string): Plugin;
+    private static loadPackageJSON;
+    private loadDefaultPaths;
+    private addNpmPrefixToSearchPaths;
+}
+//# sourceMappingURL=pluginManager.d.ts.map

package/dist/pluginManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginManager.d.ts","sourceRoot":"","sources":["../src/pluginManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,aAAa,EAEb,aAAa,EACb,kBAAkB,EAClB,YAAY,EAEZ,gBAAgB,EAChB,UAAU,EACX,MAAM,UAAU,CAAA;AAUjB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAMpC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IAGnB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAClE,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;IAE5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,EAAE,CAAA;CACrC;AAED;;GAEG;AACH,qBAAa,aAAa;IAExB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAmD;IAEpG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IAEnC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyB;IACrD,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAiB;IACxD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAoB;IACnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAoB;IAErD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2C;IAEnE,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAqD;IACjG,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA0C;IAC/E,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAyC;IAE7E,OAAO,CAAC,yBAAyB,CAAC,CAAQ;gBAE9B,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,oBAAoB;WAkBhD,2BAA2B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;WAIxD,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;WAI3C,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;WAIxC,gBAAgB,CAAC,UAAU,EAAE,mBAAmB,GAAG,aAAa;WAQhE,eAAe,CAAC,UAAU,EAAE,kBAAkB,GAAG,kBAAkB;WAQnE,mBAAmB,CAAC,UAAU,EAAE,mBAAmB,GAAG,kBAAkB,GAAG,gBAAgB;IAI5F,0BAA0B,IAAI,OAAO,CAAC,IAAI,CAAC;IAoC3C,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAchF,OAAO,CAAC,uBAAuB;IAoB/B,OAAO,CAAC,sBAAsB;IAoBvB,qBAAqB,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,aAAa,GAAG,MAAM;IAgCvF,oBAAoB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,YAAY,GAAG,MAAM;IAgCnF,mBAAmB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,OAAO;IAIhE,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,MAAM,GAAG,SAAS;IAcjE,gCAAgC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAcvF;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAoErB,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAiB/C,OAAO,CAAC,MAAM,CAAC,eAAe;IA0B9B,OAAO,CAAC,gBAAgB;IAsCxB,OAAO,CAAC,yBAAyB;CAYlC"}

package/dist/pluginManager.js

@@ -0,0 +1,375 @@
+import { execSync } from 'node:child_process';
+import { existsSync, readdirSync, readFileSync, statSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { delimiter, join, resolve } from 'node:path';
+import process from 'node:process';
+import { Logger } from './logger.js';
+import { Plugin } from './plugin.js';
+const log = Logger.internal;
+const require = createRequire(import.meta.url);
+const paths = require.resolve.paths('');
+/**
+ * Utility which exposes methods to search for installed Homebridge plugins
+ */
+export class PluginManager {
+    // name must be prefixed with 'homebridge-' or '@scope/homebridge-'
+    static PLUGIN_IDENTIFIER_PATTERN = /^((@[\w-]+(\.[\w-]+)*)\/)?(homebridge-[\w-]+)$/;
+    api;
+    searchPaths = new Set(); // unique set of search paths we will use to discover installed plugins
+    strictPluginResolution = false;
+    activePlugins;
+    disabledPlugins;
+    plugins = new Map();
+    // we have some plugins which simply pass a wrong or misspelled plugin name to the api calls, this translation tries to mitigate this
+    pluginIdentifierTranslation = new Map();
+    accessoryToPluginMap = new Map();
+    platformToPluginMap = new Map();
+    currentInitializingPlugin; // used to match registering plugins, see handleRegisterAccessory and handleRegisterPlatform
+    constructor(api, options) {
+        this.api = api;
+        if (options) {
+            if (options.customPluginPath) {
+                this.searchPaths.add(resolve(process.cwd(), options.customPluginPath));
+            }
+            this.strictPluginResolution = options.strictPluginResolution || false;
+            this.activePlugins = options.activePlugins;
+            this.disabledPlugins = Array.isArray(options.disabledPlugins) ? options.disabledPlugins : undefined;
+        }
+        this.api.on("registerAccessory" /* InternalAPIEvent.REGISTER_ACCESSORY */, this.handleRegisterAccessory.bind(this));
+        this.api.on("registerPlatform" /* InternalAPIEvent.REGISTER_PLATFORM */, this.handleRegisterPlatform.bind(this));
+    }
+    static isQualifiedPluginIdentifier(identifier) {
+        return PluginManager.PLUGIN_IDENTIFIER_PATTERN.test(identifier);
+    }
+    static extractPluginName(name) {
+        return name.match(PluginManager.PLUGIN_IDENTIFIER_PATTERN)[4];
+    }
+    static extractPluginScope(name) {
+        return name.match(PluginManager.PLUGIN_IDENTIFIER_PATTERN)[2];
+    }
+    static getAccessoryName(identifier) {
+        if (!identifier.includes('.')) {
+            return identifier;
+        }
+        return identifier.split('.')[1];
+    }
+    static getPlatformName(identifier) {
+        if (!identifier.includes('.')) {
+            return identifier;
+        }
+        return identifier.split('.')[1];
+    }
+    static getPluginIdentifier(identifier) {
+        return identifier.split('.')[0];
+    }
+    async initializeInstalledPlugins() {
+        log.info('---');
+        this.loadInstalledPlugins();
+        for (const [identifier, plugin] of this.plugins) {
+            try {
+                await plugin.load();
+            }
+            catch (error) {
+                log.error('====================');
+                log.error(`ERROR LOADING PLUGIN ${identifier}:`);
+                log.error(error.stack);
+                log.error('====================');
+                this.plugins.delete(identifier);
+                continue;
+            }
+            if (this.disabledPlugins && this.disabledPlugins.includes(plugin.getPluginIdentifier())) {
+                plugin.disabled = true;
+            }
+            if (plugin.disabled) {
+                log.warn(`Disabled plugin: ${identifier}@${plugin.version}`);
+            }
+            else {
+                log.info(`Loaded plugin: ${identifier}@${plugin.version}`);
+            }
+            await this.initializePlugin(plugin, identifier);
+            log.info('---');
+        }
+        this.currentInitializingPlugin = undefined;
+    }
+    async initializePlugin(plugin, identifier) {
+        try {
+            this.currentInitializingPlugin = plugin;
+            await plugin.initialize(this.api); // call the plugin's initializer and pass it our API instance
+        }
+        catch (error) {
+            log.error('====================');
+            log.error(`ERROR INITIALIZING PLUGIN ${identifier}:`);
+            log.error(error.stack);
+            log.error('====================');
+            this.plugins.delete(identifier);
+        }
+    }
+    handleRegisterAccessory(name, constructor, pluginIdentifier) {
+        if (!this.currentInitializingPlugin) {
+            throw new Error(`Unexpected accessory registration. Plugin ${pluginIdentifier ? `'${pluginIdentifier}' ` : ''}tried to register outside the initializer function!`);
+        }
+        if (pluginIdentifier && pluginIdentifier !== this.currentInitializingPlugin.getPluginIdentifier()) {
+            log.info(`Plugin '${this.currentInitializingPlugin.getPluginIdentifier()}' tried to register with an incorrect plugin identifier: '${pluginIdentifier}'. Please report this to the developer!`);
+            this.pluginIdentifierTranslation.set(pluginIdentifier, this.currentInitializingPlugin.getPluginIdentifier());
+        }
+        this.currentInitializingPlugin.registerAccessory(name, constructor);
+        let plugins = this.accessoryToPluginMap.get(name);
+        if (!plugins) {
+            plugins = [];
+            this.accessoryToPluginMap.set(name, plugins);
+        }
+        plugins.push(this.currentInitializingPlugin);
+    }
+    handleRegisterPlatform(name, constructor, pluginIdentifier) {
+        if (!this.currentInitializingPlugin) {
+            throw new Error(`Unexpected platform registration. Plugin ${pluginIdentifier ? `'${pluginIdentifier}' ` : ''}tried to register outside the initializer function!`);
+        }
+        if (pluginIdentifier && pluginIdentifier !== this.currentInitializingPlugin.getPluginIdentifier()) {
+            log.debug(`Plugin '${this.currentInitializingPlugin.getPluginIdentifier()}' tried to register with an incorrect plugin identifier: '${pluginIdentifier}'. Please report this to the developer!`);
+            this.pluginIdentifierTranslation.set(pluginIdentifier, this.currentInitializingPlugin.getPluginIdentifier());
+        }
+        this.currentInitializingPlugin.registerPlatform(name, constructor);
+        let plugins = this.platformToPluginMap.get(name);
+        if (!plugins) {
+            plugins = [];
+            this.platformToPluginMap.set(name, plugins);
+        }
+        plugins.push(this.currentInitializingPlugin);
+    }
+    getPluginForAccessory(accessoryIdentifier) {
+        let plugin;
+        if (!accessoryIdentifier.includes('.')) { // see if it matches exactly one accessory
+            let found = this.accessoryToPluginMap.get(accessoryIdentifier);
+            if (!found) {
+                throw new Error(`No plugin was found for the accessory "${accessoryIdentifier}" in your config.json. Please make sure the corresponding plugin is installed correctly.`);
+            }
+            if (found.length > 1) {
+                const options = found.map(plugin => `${plugin.getPluginIdentifier()}.${accessoryIdentifier}`).join(', ');
+                // check if only one of the multiple platforms is not disabled
+                found = found.filter(plugin => !plugin.disabled);
+                if (found.length !== 1) {
+                    throw new Error(`The requested accessory '${accessoryIdentifier}' has been registered multiple times. Please be more specific by writing one of: ${options}`);
+                }
+            }
+            plugin = found[0];
+            accessoryIdentifier = `${plugin.getPluginIdentifier()}.${accessoryIdentifier}`;
+        }
+        else {
+            const pluginIdentifier = PluginManager.getPluginIdentifier(accessoryIdentifier);
+            if (!this.hasPluginRegistered(pluginIdentifier)) {
+                throw new Error(`The requested plugin '${pluginIdentifier}' was not registered.`);
+            }
+            plugin = this.getPlugin(pluginIdentifier);
+        }
+        return plugin;
+    }
+    getPluginForPlatform(platformIdentifier) {
+        let plugin;
+        if (!platformIdentifier.includes('.')) { // see if it matches exactly one platform
+            let found = this.platformToPluginMap.get(platformIdentifier);
+            if (!found) {
+                throw new Error(`No plugin was found for the platform "${platformIdentifier}" in your config.json. Please make sure the corresponding plugin is installed correctly.`);
+            }
+            if (found.length > 1) {
+                const options = found.map(plugin => `${plugin.getPluginIdentifier()}.${platformIdentifier}`).join(', ');
+                // check if only one of the multiple platforms is not disabled
+                found = found.filter(plugin => !plugin.disabled);
+                if (found.length !== 1) {
+                    throw new Error(`The requested platform '${platformIdentifier}' has been registered multiple times. Please be more specific by writing one of: ${options}`);
+                }
+            }
+            plugin = found[0];
+            platformIdentifier = `${plugin.getPluginIdentifier()}.${platformIdentifier}`;
+        }
+        else {
+            const pluginIdentifier = PluginManager.getPluginIdentifier(platformIdentifier);
+            if (!this.hasPluginRegistered(pluginIdentifier)) {
+                throw new Error(`The requested plugin '${pluginIdentifier}' was not registered.`);
+            }
+            plugin = this.getPlugin(pluginIdentifier);
+        }
+        return plugin;
+    }
+    hasPluginRegistered(pluginIdentifier) {
+        return this.plugins.has(pluginIdentifier) || this.pluginIdentifierTranslation.has(pluginIdentifier);
+    }
+    getPlugin(pluginIdentifier) {
+        const plugin = this.plugins.get(pluginIdentifier);
+        if (plugin) {
+            return plugin;
+        }
+        else {
+            const translation = this.pluginIdentifierTranslation.get(pluginIdentifier);
+            if (translation) {
+                return this.plugins.get(translation);
+            }
+        }
+        return undefined;
+    }
+    getPluginByActiveDynamicPlatform(platformName) {
+        const found = (this.platformToPluginMap.get(platformName) || [])
+            .filter(plugin => !!plugin.getActiveDynamicPlatform(platformName));
+        if (found.length === 0) {
+            return undefined;
+        }
+        else if (found.length > 1) {
+            const plugins = found.map(plugin => plugin.getPluginIdentifier()).join(', ');
+            throw new Error(`'${platformName}' is an ambiguous platform name. It was registered by multiple plugins: ${plugins}`);
+        }
+        else {
+            return found[0];
+        }
+    }
+    /**
+     * Gets all plugins installed on the local system
+     */
+    loadInstalledPlugins() {
+        this.loadDefaultPaths();
+        this.searchPaths.forEach((searchPath) => {
+            if (!existsSync(searchPath)) { // just because this path is in require.main.paths doesn't mean it necessarily exists!
+                return;
+            }
+            if (existsSync(join(searchPath, 'package.json'))) { // does this path point inside a single plugin and not a directory containing plugins?
+                try {
+                    this.loadPlugin(searchPath);
+                }
+                catch (error) {
+                    log.warn(error.message);
+                }
+            }
+            else { // read through each directory in this node_modules folder
+                const relativePluginPaths = readdirSync(searchPath) // search for directories only
+                    .filter((relativePath) => {
+                    try {
+                        return statSync(resolve(searchPath, relativePath)).isDirectory();
+                    }
+                    catch (error) {
+                        log.debug(`Ignoring path ${resolve(searchPath, relativePath)} - ${error.message}`);
+                        return false;
+                    }
+                });
+                // expand out @scoped plugins
+                relativePluginPaths.slice()
+                    .filter(path => path.charAt(0) === '@') // is it a scope directory?
+                    .forEach((scopeDirectory) => {
+                    // remove scopeDirectory from the path list
+                    const index = relativePluginPaths.indexOf(scopeDirectory);
+                    relativePluginPaths.splice(index, 1);
+                    const absolutePath = join(searchPath, scopeDirectory);
+                    readdirSync(absolutePath)
+                        .filter(name => PluginManager.isQualifiedPluginIdentifier(name))
+                        .filter((name) => {
+                        try {
+                            return statSync(resolve(absolutePath, name)).isDirectory();
+                        }
+                        catch (error) {
+                            log.debug(`Ignoring path ${resolve(absolutePath, name)} - ${error.message}`);
+                            return false;
+                        }
+                    })
+                        .forEach(name => relativePluginPaths.push(`${scopeDirectory}/${name}`));
+                });
+                relativePluginPaths
+                    .filter((pluginIdentifier) => {
+                    return PluginManager.isQualifiedPluginIdentifier(pluginIdentifier) // needs to be a valid homebridge plugin name
+                        && (!this.activePlugins || this.activePlugins.includes(pluginIdentifier)); // check if activePlugins is restricted and if so is the plugin is contained
+                })
+                    .forEach((pluginIdentifier) => {
+                    try {
+                        const absolutePath = resolve(searchPath, pluginIdentifier);
+                        this.loadPlugin(absolutePath);
+                    }
+                    catch (error) {
+                        log.warn(error.message);
+                    }
+                });
+            }
+        });
+        if (this.plugins.size === 0) {
+            log.warn('No plugins found.');
+        }
+    }
+    loadPlugin(absolutePath) {
+        const packageJson = PluginManager.loadPackageJSON(absolutePath);
+        const identifier = packageJson.name;
+        const name = PluginManager.extractPluginName(identifier);
+        const scope = PluginManager.extractPluginScope(identifier); // possibly undefined
+        const alreadyInstalled = this.plugins.get(identifier); // check if there is already a plugin with the same Identifier
+        if (alreadyInstalled) {
+            throw new Error(`Warning: skipping plugin found at '${absolutePath}' since we already loaded the same plugin from '${alreadyInstalled.getPluginPath()}'.`);
+        }
+        const plugin = new Plugin(name, absolutePath, packageJson, scope);
+        this.plugins.set(identifier, plugin);
+        return plugin;
+    }
+    static loadPackageJSON(pluginPath) {
+        const packageJsonPath = join(pluginPath, 'package.json');
+        let packageJson;
+        if (!existsSync(packageJsonPath)) {
+            throw new Error(`Plugin ${pluginPath} does not contain a package.json.`);
+        }
+        try {
+            packageJson = JSON.parse(readFileSync(packageJsonPath, { encoding: 'utf8' })); // attempt to parse package.json
+        }
+        catch (error) {
+            throw new Error(`Plugin ${pluginPath} contains an invalid package.json. Error: ${error}`);
+        }
+        if (!packageJson.name || !PluginManager.isQualifiedPluginIdentifier(packageJson.name)) {
+            throw new Error(`Plugin ${pluginPath} does not have a package name that begins with 'homebridge-' or '@scope/homebridge-.`);
+        }
+        // verify that it's tagged with the correct keyword
+        if (!packageJson.keywords || !packageJson.keywords.includes('homebridge-plugin')) {
+            throw new Error(`Plugin ${pluginPath} package.json does not contain the keyword 'homebridge-plugin'.`);
+        }
+        return packageJson;
+    }
+    loadDefaultPaths() {
+        if (this.strictPluginResolution) {
+            // if strict plugin resolution is enabled:
+            // * only use custom plugin path, if set;
+            // * otherwise add the current npm global prefix (e.g. /usr/local/lib/node_modules)
+            if (this.searchPaths.size === 0) {
+                this.addNpmPrefixToSearchPaths();
+            }
+            return;
+        }
+        if (paths) {
+            // add the paths used by require()
+            paths.forEach(path => this.searchPaths.add(path));
+        }
+        // THIS SECTION FROM: https://github.com/yeoman/environment/blob/master/lib/resolver.js
+        // Adding global npm directories
+        // We tried using npm to get the global modules path, but it hasn't work out
+        // because of bugs in the parsable implementation of `ls` command and mostly
+        // performance issues. So, we go with our best bet for now.
+        if (process.env.NODE_PATH) {
+            process.env
+                .NODE_PATH
+                .split(delimiter)
+                .filter(path => !!path) // trim out empty values
+                .forEach(path => this.searchPaths.add(path));
+        }
+        else {
+            // Default paths for non-windows systems
+            if (process.platform !== 'win32') {
+                this.searchPaths.add('/usr/local/lib/node_modules');
+                this.searchPaths.add('/usr/lib/node_modules');
+            }
+            this.addNpmPrefixToSearchPaths();
+        }
+    }
+    addNpmPrefixToSearchPaths() {
+        if (process.platform === 'win32') {
+            this.searchPaths.add(join(process.env.APPDATA, 'npm/node_modules'));
+        }
+        else {
+            this.searchPaths.add(execSync('/bin/echo -n "$(npm -g prefix)/lib/node_modules"', {
+                env: Object.assign({
+                    npm_config_loglevel: 'silent',
+                    npm_update_notifier: 'false',
+                }, process.env),
+            }).toString('utf8'));
+        }
+    }
+}
+//# sourceMappingURL=pluginManager.js.map