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

package/README.md

@@ -16,7 +16,7 @@
 
 <img src="https://media.giphy.com/media/10l79ICohTu4iQ/giphy.gif" align="right" alt="Unlocking Door">
 
-**Homebridge** is a lightweight Node.js server you can run on your home network that emulates the iOS HomeKit API. It supports Plugins, which are community-contributed modules that provide a basic bridge from HomeKit to various 3rd-party APIs provided by manufacturers of "smart home" devices.
+**Homebridge** is a lightweight Node.js server you can run on your home network to emulate the HomeKit Accessory Protocol (HAP). It supports plugins, which are community-contributed modules that provide a basic bridge from HomeKit to various 3rd-party APIs provided by manufacturers of "smart home" devices.
 
 Since Siri supports devices added through HomeKit, this means that with Homebridge you can ask Siri to control devices that don't have any support for HomeKit at all. For instance, using just some of the available plugins, you can say:
 

package/bin/homebridge.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+//
+// This executable sets up the environment and runs the Homebridge CLI.
+//
+
+import { realpathSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import process from 'node:process'
+import { fileURLToPath, pathToFileURL } from 'node:url'
+
+process.title = 'homebridge'
+
+// Find the Homebridge lib
+const __filename = fileURLToPath(import.meta.url)
+const lib = join(dirname(realpathSync(__filename)), '../dist')
+
+// Convert the path to a file URL
+const libUrl = pathToFileURL(join(lib, 'cli.js')).href
+
+// Run Homebridge
+import(libUrl).then(({ default: run }) => run())

package/config-sample.json

@@ -7,7 +7,18 @@
     "port": 51826,
     "pin": "031-45-154"
   },
-
+  "matter": {
+    "_comment": "Optional Matter protocol support for Homebridge. When enabled, accessories can be published via both HomeKit HAP and Matter protocols simultaneously.",
+    "enabled": false,
+    "port": 5540,
+    "discriminator": 3840,
+    "passcode": 20202021,
+    "vendorId": 65521,
+    "productId": 32769,
+    "deviceName": "Homebridge Matter Bridge",
+    "deviceType": 22,
+    "_note": "Set 'enabled' to true to enable Matter support. Accessories will be available via both HomeKit and Matter protocols. Plugins can use api.publishMatterAccessories() to publish accessories to Matter."
+  },
   "description": "This is an example configuration file with one fake accessory and one fake platform. You can use this as a template for creating your own configuration file containing devices you actually own.",
   "ports": {
     "start": 52100,

package/dist/api.d.ts

@@ -0,0 +1,226 @@
+import type { Controller, Service } from 'hap-nodejs';
+import type { AccessoryConfig, PlatformConfig } from './bridgeService.js';
+import type { Logging } from './logger.js';
+import { EventEmitter } from 'node:events';
+import hapNodeJs from 'hap-nodejs';
+import { getMatterClustersForHAPService, getMatterDeviceTypeForHAPService, HAPToMatterClusterMapping, HAPToMatterDeviceMapping, MatterClusters, MatterDeviceTypes } from './matterTypes.js';
+import { PlatformAccessory } from './platformAccessory.js';
+import { User } from './user.js';
+export type HAP = typeof hapNodeJs;
+export type HAPLegacyTypes = typeof hapNodeJs.LegacyTypes;
+export type PluginIdentifier = PluginName | ScopedPluginName;
+export type PluginName = string;
+export type ScopedPluginName = string;
+export type AccessoryName = string;
+export type PlatformName = string;
+export type AccessoryIdentifier = string;
+export type PlatformIdentifier = string;
+export declare const enum PluginType {
+    ACCESSORY = "accessory",
+    PLATFORM = "platform"
+}
+/**
+ * The {PluginInitializer} is a method which must be the default export for every homebridge plugin.
+ * It is called once the plugin is loaded from disk.
+ */
+export interface PluginInitializer {
+    /**
+     * When the initializer is called the plugin must use the provided api instance and call the appropriate
+     * register methods - {@link API.registerAccessory} or {@link API.registerPlatform} - in order to
+     * correctly register for the following startup sequence.
+     *
+     * @param {API} api
+     */
+    (api: API): void | Promise<void>;
+}
+export interface AccessoryPluginConstructor {
+    new (logger: Logging, config: AccessoryConfig, api: API): AccessoryPlugin;
+}
+export interface AccessoryPlugin {
+    /**
+     * Optional method which will be called if an 'identify' of an Accessory is requested by HomeKit.
+     */
+    identify?: () => void;
+    /**
+     * This method will be called once on startup, to query all services to be exposed by the Accessory.
+     * All event handlers for characteristics should be set up before the array is returned.
+     *
+     * @returns {Service[]} services - returned services will be added to the Accessory
+     */
+    getServices: () => Service[];
+    /**
+     * This method will be called once on startup, to query all controllers to be exposed by the Accessory.
+     * It is optional to implement.
+     *
+     * This includes controllers like the RemoteController or the CameraController.
+     * Any necessary controller specific setup should have been done when returning the array.
+     * In most cases the plugin will only return an array of the size 1.
+     *
+     * In the case that the Plugin does not add any additional services (returned by {@link getServices}) the
+     * method {@link getServices} must be defined in any way and should just return an empty array.
+     *
+     * @returns {Controller[]} controllers - returned controllers will be configured for the Accessory
+     */
+    getControllers?: () => Controller[];
+}
+export interface PlatformPluginConstructor<Config extends PlatformConfig = PlatformConfig> {
+    new (logger: Logging, config: Config, api: API): DynamicPlatformPlugin | StaticPlatformPlugin | IndependentPlatformPlugin;
+}
+export interface PlatformPlugin {
+}
+/**
+ * Platform that is able to dynamically add or remove accessories.
+ * All configured accessories are stored to disk and recreated on startup.
+ * Accessories can be added or removed by using {@link API.registerPlatformAccessories} or {@link API.unregisterPlatformAccessories}.
+ */
+export interface DynamicPlatformPlugin extends PlatformPlugin {
+    /**
+     * This method is called for every PlatformAccessory, which is recreated from disk on startup.
+     * It should be used to properly initialize the Accessory and setup all event handlers for
+     * all services and their characteristics.
+     *
+     * @param {PlatformAccessory} accessory which needs to be configured
+     */
+    configureAccessory: (accessory: PlatformAccessory) => void;
+}
+/**
+ * Platform that exposes all available characteristics at the start of the plugin.
+ * The set of accessories can not change at runtime.
+ * The bridge waits for all callbacks to return before it is published and accessible by HomeKit controllers.
+ */
+export interface StaticPlatformPlugin extends PlatformPlugin {
+    /**
+     * This method is called once at startup. The Platform should pass all accessories which need to be created
+     * to the callback in form of a {@link AccessoryPlugin}.
+     * The Platform must respond in a timely manner as otherwise the startup of the bridge would be unnecessarily delayed.
+     *
+     * @param {(foundAccessories: AccessoryPlugin[]) => void} callback
+     */
+    accessories: (callback: (foundAccessories: AccessoryPlugin[]) => void) => void;
+}
+/**
+ * Platform that does not aim to add any accessories to the main bridge accessory.
+ * This platform should be used if for example a plugin aims to only expose external accessories.
+ * It should also be used when the platform doesn't intend to expose any accessories at all, like plugins
+ * providing a UI for homebridge.
+ */
+export interface IndependentPlatformPlugin extends PlatformPlugin {
+}
+export declare const enum APIEvent {
+    /**
+     * Event is fired once homebridge has finished with booting up and initializing all components and plugins.
+     * When this event is fired it is possible that the Bridge accessory isn't published yet, if homebridge still needs
+     * to wait for some {@see StaticPlatformPlugin | StaticPlatformPlugins} to finish accessory creation.
+     */
+    DID_FINISH_LAUNCHING = "didFinishLaunching",
+    /**
+     * This event is fired when homebridge gets shutdown. This could be a regular shutdown or an unexpected crash.
+     * At this stage all Accessories are already unpublished and all PlatformAccessories are already saved to disk!
+     */
+    SHUTDOWN = "shutdown"
+}
+export declare const enum InternalAPIEvent {
+    REGISTER_ACCESSORY = "registerAccessory",
+    REGISTER_PLATFORM = "registerPlatform",
+    PUBLISH_EXTERNAL_ACCESSORIES = "publishExternalAccessories",
+    REGISTER_PLATFORM_ACCESSORIES = "registerPlatformAccessories",
+    UPDATE_PLATFORM_ACCESSORIES = "updatePlatformAccessories",
+    UNREGISTER_PLATFORM_ACCESSORIES = "unregisterPlatformAccessories",
+    PUBLISH_MATTER_ACCESSORIES = "publishMatterAccessories",
+    UNPUBLISH_MATTER_ACCESSORIES = "unpublishMatterAccessories"
+}
+export interface API {
+    /**
+     * The homebridge API version as a floating point number.
+     */
+    readonly version: number;
+    /**
+     * The current homebridge semver version.
+     */
+    readonly serverVersion: string;
+    readonly user: typeof User;
+    readonly hap: HAP;
+    readonly hapLegacyTypes: HAPLegacyTypes;
+    readonly platformAccessory: typeof PlatformAccessory;
+    readonly matter: {
+        readonly clusters: typeof MatterClusters;
+        readonly deviceTypes: typeof MatterDeviceTypes;
+        readonly hapToMatterClusterMapping: typeof HAPToMatterClusterMapping;
+        readonly hapToMatterDeviceMapping: typeof HAPToMatterDeviceMapping;
+        readonly getMatterDeviceTypeForHAPService: typeof getMatterDeviceTypeForHAPService;
+        readonly getMatterClustersForHAPService: typeof getMatterClustersForHAPService;
+    };
+    /**
+     * Returns true if the current running homebridge version is greater or equal to the
+     * passed version string.
+     *
+     * Example:
+     *
+     * We assume the homebridge version 1.3.0-beta.12 ({@link serverVersion}) and the following example calls below
+     * ```
+     *  versionGreaterOrEqual("1.2.0"); // will return true
+     *  versionGreaterOrEqual("1.3.0"); // will return false (the RELEASE version 1.3.0 is bigger than the BETA version 1.3.0-beta.12)
+     *  versionGreaterOrEqual("1.3.0-beta.8); // will return true
+     * ```
+     *
+     * @param version
+     */
+    versionGreaterOrEqual: (version: string) => boolean;
+    registerAccessory: ((accessoryName: AccessoryName, constructor: AccessoryPluginConstructor) => void) & ((pluginIdentifier: PluginIdentifier, accessoryName: AccessoryName, constructor: AccessoryPluginConstructor) => void);
+    registerPlatform: (<Config extends PlatformConfig>(platformName: PlatformName, constructor: PlatformPluginConstructor<Config>) => void) & (<Config extends PlatformConfig>(pluginIdentifier: PluginIdentifier, platformName: PlatformName, constructor: PlatformPluginConstructor<Config>) => void);
+    registerPlatformAccessories: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: PlatformAccessory[]) => void;
+    updatePlatformAccessories: (accessories: PlatformAccessory[]) => void;
+    unregisterPlatformAccessories: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: PlatformAccessory[]) => void;
+    /**
+     * Publish accessories via Matter protocol in addition to HomeKit HAP
+     * @param pluginIdentifier - Plugin identifier
+     * @param accessories - Array of accessories to publish via Matter
+     */
+    publishMatterAccessories: (pluginIdentifier: PluginIdentifier, accessories: PlatformAccessory[]) => void;
+    /**
+     * Unpublish accessories from Matter protocol
+     * @param pluginIdentifier - Plugin identifier
+     * @param accessories - Array of accessories to unpublish from Matter
+     */
+    unpublishMatterAccessories: (pluginIdentifier: PluginIdentifier, accessories: PlatformAccessory[]) => void;
+    publishExternalAccessories: (pluginIdentifier: PluginIdentifier, accessories: PlatformAccessory[]) => void;
+    on: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this);
+}
+export declare interface HomebridgeAPI {
+    on: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this) & ((event: InternalAPIEvent.REGISTER_ACCESSORY, listener: (accessoryName: AccessoryName, accessoryConstructor: AccessoryPluginConstructor, pluginIdentifier?: PluginIdentifier) => void) => this) & ((event: InternalAPIEvent.REGISTER_PLATFORM, listener: (platformName: PlatformName, platformConstructor: PlatformPluginConstructor, pluginIdentifier?: PluginIdentifier) => void) => this) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.REGISTER_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.UPDATE_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.UNREGISTER_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.PUBLISH_MATTER_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.UNPUBLISH_MATTER_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this);
+    emit: ((event: 'didFinishLaunching') => boolean) & ((event: 'shutdown') => boolean) & ((event: InternalAPIEvent.REGISTER_ACCESSORY, accessoryName: AccessoryName, accessoryConstructor: AccessoryPluginConstructor, pluginIdentifier?: PluginIdentifier) => boolean) & ((event: InternalAPIEvent.REGISTER_PLATFORM, platformName: PlatformName, platformConstructor: PlatformPluginConstructor, pluginIdentifier?: PluginIdentifier) => boolean) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.REGISTER_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.UPDATE_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.UNREGISTER_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.PUBLISH_MATTER_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.UNPUBLISH_MATTER_ACCESSORIES, accessories: PlatformAccessory[]) => boolean);
+}
+export declare class HomebridgeAPI extends EventEmitter implements API {
+    readonly version = 2.7;
+    readonly serverVersion: string;
+    readonly user: typeof User;
+    readonly hap: typeof hapNodeJs;
+    readonly hapLegacyTypes: typeof hapNodeJs.LegacyTypes;
+    readonly platformAccessory: typeof PlatformAccessory;
+    readonly matter: {
+        clusters: Record<string, unknown>;
+        deviceTypes: Record<string, unknown>;
+        hapToMatterClusterMapping: Record<string, string[]>;
+        hapToMatterDeviceMapping: Record<string, string>;
+        getMatterDeviceTypeForHAPService: typeof getMatterDeviceTypeForHAPService;
+        getMatterClustersForHAPService: typeof getMatterClustersForHAPService;
+    };
+    constructor();
+    versionGreaterOrEqual(version: string): boolean;
+    static isDynamicPlatformPlugin(platformPlugin: PlatformPlugin): platformPlugin is DynamicPlatformPlugin;
+    static isStaticPlatformPlugin(platformPlugin: PlatformPlugin): platformPlugin is StaticPlatformPlugin;
+    signalFinished(): void;
+    signalShutdown(): void;
+    registerAccessory(accessoryName: AccessoryName, constructor: AccessoryPluginConstructor): void;
+    registerAccessory(pluginIdentifier: PluginIdentifier, accessoryName: AccessoryName, constructor: AccessoryPluginConstructor): void;
+    registerPlatform(platformName: PlatformName, constructor: PlatformPluginConstructor): void;
+    registerPlatform(pluginIdentifier: PluginIdentifier, platformName: PlatformName, constructor: PlatformPluginConstructor): void;
+    publishCameraAccessories(pluginIdentifier: PluginIdentifier, accessories: PlatformAccessory[]): void;
+    publishExternalAccessories(pluginIdentifier: PluginIdentifier, accessories: PlatformAccessory[]): void;
+    registerPlatformAccessories(pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: PlatformAccessory[]): void;
+    updatePlatformAccessories(accessories: PlatformAccessory[]): void;
+    unregisterPlatformAccessories(pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: PlatformAccessory[]): void;
+    publishMatterAccessories(pluginIdentifier: PluginIdentifier, accessories: PlatformAccessory[]): void;
+    unpublishMatterAccessories(pluginIdentifier: PluginIdentifier, accessories: PlatformAccessory[]): void;
+}
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAErD,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACzE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,SAAS,MAAM,YAAY,CAAA;AAIlC,OAAO,EACL,8BAA8B,EAC9B,gCAAgC,EAChC,yBAAyB,EACzB,wBAAwB,EACxB,cAAc,EACd,iBAAiB,EAClB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE1D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAKhC,MAAM,MAAM,GAAG,GAAG,OAAO,SAAS,CAAA;AAClC,MAAM,MAAM,cAAc,GAAG,OAAO,SAAS,CAAC,WAAW,CAAA;AAEzD,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,gBAAgB,CAAA;AAC5D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAC/B,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAA;AACrC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAA;AACxC,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAA;AAGvC,0BAAkB,UAAU;IAC1B,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAI,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,GAAG,GAAG,eAAe,CAAA;CACzE;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;IAErB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,OAAO,EAAE,CAAA;IAE5B;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,MAAM,UAAU,EAAE,CAAA;CACpC;AAED,MAAM,WAAW,yBAAyB,CAAC,MAAM,SAAS,cAAc,GAAG,cAAc;IACvF,KAAI,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,yBAAyB,CAAA;CACzH;AAED,MAAM,WAAW,cAAc;CAAG;AAElC;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D;;;;;;OAMG;IACH,kBAAkB,EAAE,CAAC,SAAS,EAAE,iBAAiB,KAAK,IAAI,CAAA;CAC3D;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;OAMG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,gBAAgB,EAAE,eAAe,EAAE,KAAK,IAAI,KAAK,IAAI,CAAA;CAC/E;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAA0B,SAAQ,cAAc;CAEhE;AAGD,0BAAkB,QAAQ;IACxB;;;;OAIG;IACH,oBAAoB,uBAAuB;IAE3C;;;OAGG;IACH,QAAQ,aAAa;CACtB;AAGD,0BAAkB,gBAAgB;IAChC,kBAAkB,sBAAsB;IACxC,iBAAiB,qBAAqB;IAEtC,4BAA4B,+BAA+B;IAC3D,6BAA6B,gCAAgC;IAC7D,2BAA2B,8BAA8B;IACzD,+BAA+B,kCAAkC;IAGjE,0BAA0B,6BAA6B;IACvD,4BAA4B,+BAA+B;CAC5D;AAED,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAG9B,QAAQ,CAAC,IAAI,EAAE,OAAO,IAAI,CAAA;IAC1B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAA;IACvC,QAAQ,CAAC,iBAAiB,EAAE,OAAO,iBAAiB,CAAA;IAIpD,QAAQ,CAAC,MAAM,EAAE;QACf,QAAQ,CAAC,QAAQ,EAAE,OAAO,cAAc,CAAA;QACxC,QAAQ,CAAC,WAAW,EAAE,OAAO,iBAAiB,CAAA;QAC9C,QAAQ,CAAC,yBAAyB,EAAE,OAAO,yBAAyB,CAAA;QACpE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,wBAAwB,CAAA;QAClE,QAAQ,CAAC,gCAAgC,EAAE,OAAO,gCAAgC,CAAA;QAClF,QAAQ,CAAC,8BAA8B,EAAE,OAAO,8BAA8B,CAAA;KAC/E,CAAA;IAGD;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAA;IAEnD,iBAAiB,EAAE,CAAC,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,0BAA0B,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,0BAA0B,KAAK,IAAI,CAAC,CAAA;IAE5N,gBAAgB,EAAE,CAAC,CAAC,MAAM,SAAS,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,yBAAyB,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,SAAS,cAAc,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,yBAAyB,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAA;IACnS,2BAA2B,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAA;IACvI,yBAAyB,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAA;IACrE,6BAA6B,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAA;IAEzI;;;;OAIG;IACH,wBAAwB,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAA;IAExG;;;;OAIG;IACH,0BAA0B,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAA;IAE1G,0BAA0B,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAA;IAE1G,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,CAAA;CACxH;AAGD,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,QAAQ,EAAE,CAAC,aAAa,EAAE,aAAa,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,KAAK,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,KAAK,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,4BAA4B,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,6BAA6B,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,2BAA2B,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,+BAA+B,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,4BAA4B,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,KAAK,IAAI,KAAK,IAAI,CAAC,CAAA;IAC7sC,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,oBAAoB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,aAAa,EAAE,aAAa,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,EAAE,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,4BAA4B,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,6BAA6B,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,2BAA2B,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,+BAA+B,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,4BAA4B,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,OAAO,CAAC,CAAA;CACliC;AAGD,qBAAa,aAAc,SAAQ,YAAa,YAAW,GAAG;IAC5D,SAAgB,OAAO,OAAM;IAC7B,SAAgB,aAAa,SAAe;IAG5C,QAAQ,CAAC,IAAI,cAAO;IACpB,QAAQ,CAAC,GAAG,mBAAY;IACxB,QAAQ,CAAC,cAAc,+BAAwB;IAC/C,QAAQ,CAAC,iBAAiB,2BAAoB;IAI9C,QAAQ,CAAC,MAAM;;;;;;;MAOd;;IAOM,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;WAIxC,uBAAuB,CAAC,cAAc,EAAE,cAAc,GAAG,cAAc,IAAI,qBAAqB;WAIhG,sBAAsB,CAAC,cAAc,EAAE,cAAc,GAAG,cAAc,IAAI,oBAAoB;IAI5G,cAAc,IAAI,IAAI;IAItB,cAAc,IAAI,IAAI;IAItB,iBAAiB,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,0BAA0B,GAAG,IAAI;IAC9F,iBAAiB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,0BAA0B,GAAG,IAAI;IAWlI,gBAAgB,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,yBAAyB,GAAG,IAAI;IAC1F,gBAAgB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,yBAAyB,GAAG,IAAI;IAW9H,wBAAwB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAIpG,0BAA0B,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAiBtG,2BAA2B,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAcnI,yBAAyB,CAAC,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAIjE,6BAA6B,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAWrI,wBAAwB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAgBpG,0BAA0B,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;CAavG"}

package/dist/api.js

@@ -0,0 +1,166 @@
+import { EventEmitter } from 'node:events';
+import hapNodeJs from 'hap-nodejs';
+import semver from 'semver';
+import { Logger } from './logger.js';
+import { getMatterClustersForHAPService, getMatterDeviceTypeForHAPService, HAPToMatterClusterMapping, HAPToMatterDeviceMapping, MatterClusters, MatterDeviceTypes, } from './matterTypes.js';
+import { PlatformAccessory } from './platformAccessory.js';
+import { PluginManager } from './pluginManager.js';
+import { User } from './user.js';
+import getVersion from './version.js';
+const log = Logger.internal;
+// eslint-disable-next-line no-restricted-syntax
+export var PluginType;
+(function (PluginType) {
+    PluginType["ACCESSORY"] = "accessory";
+    PluginType["PLATFORM"] = "platform";
+})(PluginType || (PluginType = {}));
+// eslint-disable-next-line no-restricted-syntax
+export var APIEvent;
+(function (APIEvent) {
+    /**
+     * Event is fired once homebridge has finished with booting up and initializing all components and plugins.
+     * When this event is fired it is possible that the Bridge accessory isn't published yet, if homebridge still needs
+     * to wait for some {@see StaticPlatformPlugin | StaticPlatformPlugins} to finish accessory creation.
+     */
+    APIEvent["DID_FINISH_LAUNCHING"] = "didFinishLaunching";
+    /**
+     * This event is fired when homebridge gets shutdown. This could be a regular shutdown or an unexpected crash.
+     * At this stage all Accessories are already unpublished and all PlatformAccessories are already saved to disk!
+     */
+    APIEvent["SHUTDOWN"] = "shutdown";
+})(APIEvent || (APIEvent = {}));
+// eslint-disable-next-line no-restricted-syntax
+export var InternalAPIEvent;
+(function (InternalAPIEvent) {
+    InternalAPIEvent["REGISTER_ACCESSORY"] = "registerAccessory";
+    InternalAPIEvent["REGISTER_PLATFORM"] = "registerPlatform";
+    InternalAPIEvent["PUBLISH_EXTERNAL_ACCESSORIES"] = "publishExternalAccessories";
+    InternalAPIEvent["REGISTER_PLATFORM_ACCESSORIES"] = "registerPlatformAccessories";
+    InternalAPIEvent["UPDATE_PLATFORM_ACCESSORIES"] = "updatePlatformAccessories";
+    InternalAPIEvent["UNREGISTER_PLATFORM_ACCESSORIES"] = "unregisterPlatformAccessories";
+    // Matter support
+    InternalAPIEvent["PUBLISH_MATTER_ACCESSORIES"] = "publishMatterAccessories";
+    InternalAPIEvent["UNPUBLISH_MATTER_ACCESSORIES"] = "unpublishMatterAccessories";
+})(InternalAPIEvent || (InternalAPIEvent = {}));
+// eslint-disable-next-line ts/no-unsafe-declaration-merging
+export class HomebridgeAPI extends EventEmitter {
+    version = 2.7; // homebridge API version
+    serverVersion = getVersion(); // homebridge node module version
+    // ------------------ LEGACY EXPORTS FOR PRE TYPESCRIPT  ------------------
+    user = User;
+    hap = hapNodeJs;
+    hapLegacyTypes = hapNodeJs.LegacyTypes; // used for older accessories/platforms
+    platformAccessory = PlatformAccessory;
+    // ------------------------------------------------------------------------
+    // ------------------ MATTER EXPORTS ------------------
+    matter = {
+        clusters: MatterClusters,
+        deviceTypes: MatterDeviceTypes,
+        hapToMatterClusterMapping: HAPToMatterClusterMapping,
+        hapToMatterDeviceMapping: HAPToMatterDeviceMapping,
+        getMatterDeviceTypeForHAPService,
+        getMatterClustersForHAPService,
+    };
+    // ------------------------------------------------------------------------
+    constructor() {
+        super();
+    }
+    versionGreaterOrEqual(version) {
+        return semver.gte(this.serverVersion, version);
+    }
+    static isDynamicPlatformPlugin(platformPlugin) {
+        return 'configureAccessory' in platformPlugin;
+    }
+    static isStaticPlatformPlugin(platformPlugin) {
+        return 'accessories' in platformPlugin;
+    }
+    signalFinished() {
+        this.emit("didFinishLaunching" /* APIEvent.DID_FINISH_LAUNCHING */);
+    }
+    signalShutdown() {
+        this.emit("shutdown" /* APIEvent.SHUTDOWN */);
+    }
+    registerAccessory(pluginIdentifier, accessoryName, constructor) {
+        if (typeof accessoryName === 'function') {
+            constructor = accessoryName;
+            accessoryName = pluginIdentifier;
+            this.emit("registerAccessory" /* InternalAPIEvent.REGISTER_ACCESSORY */, accessoryName, constructor);
+        }
+        else {
+            this.emit("registerAccessory" /* InternalAPIEvent.REGISTER_ACCESSORY */, accessoryName, constructor, pluginIdentifier);
+        }
+    }
+    registerPlatform(pluginIdentifier, platformName, constructor) {
+        if (typeof platformName === 'function') {
+            constructor = platformName;
+            platformName = pluginIdentifier;
+            this.emit("registerPlatform" /* InternalAPIEvent.REGISTER_PLATFORM */, platformName, constructor);
+        }
+        else {
+            this.emit("registerPlatform" /* InternalAPIEvent.REGISTER_PLATFORM */, platformName, constructor, pluginIdentifier);
+        }
+    }
+    publishCameraAccessories(pluginIdentifier, accessories) {
+        this.publishExternalAccessories(pluginIdentifier, accessories);
+    }
+    publishExternalAccessories(pluginIdentifier, accessories) {
+        if (!PluginManager.isQualifiedPluginIdentifier(pluginIdentifier)) {
+            log.info(`One of your plugins incorrectly registered an external accessory using the platform name (${pluginIdentifier}) and not the plugin identifier. Please report this to the developer!`);
+        }
+        accessories.forEach((accessory) => {
+            // noinspection SuspiciousTypeOfGuard
+            if (!(accessory instanceof PlatformAccessory)) {
+                throw new TypeError(`${pluginIdentifier} attempt to register an accessory that isn't PlatformAccessory!`);
+            }
+            accessory._associatedPlugin = pluginIdentifier;
+        });
+        this.emit("publishExternalAccessories" /* InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES */, accessories);
+    }
+    registerPlatformAccessories(pluginIdentifier, platformName, accessories) {
+        accessories.forEach((accessory) => {
+            // noinspection SuspiciousTypeOfGuard
+            if (!(accessory instanceof PlatformAccessory)) {
+                throw new TypeError(`${pluginIdentifier} - ${platformName} attempt to register an accessory that isn't PlatformAccessory!`);
+            }
+            accessory._associatedPlugin = pluginIdentifier;
+            accessory._associatedPlatform = platformName;
+        });
+        this.emit("registerPlatformAccessories" /* InternalAPIEvent.REGISTER_PLATFORM_ACCESSORIES */, accessories);
+    }
+    updatePlatformAccessories(accessories) {
+        this.emit("updatePlatformAccessories" /* InternalAPIEvent.UPDATE_PLATFORM_ACCESSORIES */, accessories);
+    }
+    unregisterPlatformAccessories(pluginIdentifier, platformName, accessories) {
+        accessories.forEach((accessory) => {
+            // noinspection SuspiciousTypeOfGuard
+            if (!(accessory instanceof PlatformAccessory)) {
+                throw new TypeError(`${pluginIdentifier} - ${platformName} attempt to unregister an accessory that isn't PlatformAccessory!`);
+            }
+        });
+        this.emit("unregisterPlatformAccessories" /* InternalAPIEvent.UNREGISTER_PLATFORM_ACCESSORIES */, accessories);
+    }
+    publishMatterAccessories(pluginIdentifier, accessories) {
+        if (!PluginManager.isQualifiedPluginIdentifier(pluginIdentifier)) {
+            log.info(`One of your plugins incorrectly registered a Matter accessory using the platform name (${pluginIdentifier}) and not the plugin identifier. Please report this to the developer!`);
+        }
+        accessories.forEach((accessory) => {
+            if (!(accessory instanceof PlatformAccessory)) {
+                throw new TypeError(`${pluginIdentifier} attempt to register a Matter accessory that isn't PlatformAccessory!`);
+            }
+            accessory._associatedPlugin = pluginIdentifier;
+        });
+        this.emit("publishMatterAccessories" /* InternalAPIEvent.PUBLISH_MATTER_ACCESSORIES */, accessories);
+    }
+    unpublishMatterAccessories(pluginIdentifier, accessories) {
+        if (!PluginManager.isQualifiedPluginIdentifier(pluginIdentifier)) {
+            log.info(`One of your plugins incorrectly unregistered a Matter accessory using the platform name (${pluginIdentifier}) and not the plugin identifier. Please report this to the developer!`);
+        }
+        accessories.forEach((accessory) => {
+            if (!(accessory instanceof PlatformAccessory)) {
+                throw new TypeError(`${pluginIdentifier} attempt to unregister a Matter accessory that isn't PlatformAccessory!`);
+            }
+        });
+        this.emit("unpublishMatterAccessories" /* InternalAPIEvent.UNPUBLISH_MATTER_ACCESSORIES */, accessories);
+    }
+}
+//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,SAAS,MAAM,YAAY,CAAA;AAClC,OAAO,MAAM,MAAM,QAAQ,CAAA;AAE3B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EACL,8BAA8B,EAC9B,gCAAgC,EAChC,yBAAyB,EACzB,wBAAwB,EACxB,cAAc,EACd,iBAAiB,GAClB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,UAAU,MAAM,cAAc,CAAA;AAErC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAA;AAc3B,gDAAgD;AAChD,MAAM,CAAN,IAAkB,UAGjB;AAHD,WAAkB,UAAU;IAC1B,qCAAuB,CAAA;IACvB,mCAAqB,CAAA;AACvB,CAAC,EAHiB,UAAU,KAAV,UAAU,QAG3B;AAmGD,gDAAgD;AAChD,MAAM,CAAN,IAAkB,QAajB;AAbD,WAAkB,QAAQ;IACxB;;;;OAIG;IACH,uDAA2C,CAAA;IAE3C;;;OAGG;IACH,iCAAqB,CAAA;AACvB,CAAC,EAbiB,QAAQ,KAAR,QAAQ,QAazB;AAED,gDAAgD;AAChD,MAAM,CAAN,IAAkB,gBAYjB;AAZD,WAAkB,gBAAgB;IAChC,4DAAwC,CAAA;IACxC,0DAAsC,CAAA;IAEtC,+EAA2D,CAAA;IAC3D,iFAA6D,CAAA;IAC7D,6EAAyD,CAAA;IACzD,qFAAiE,CAAA;IAEjE,iBAAiB;IACjB,2EAAuD,CAAA;IACvD,+EAA2D,CAAA;AAC7D,CAAC,EAZiB,gBAAgB,KAAhB,gBAAgB,QAYjC;AAgFD,4DAA4D;AAC5D,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7B,OAAO,GAAG,GAAG,CAAA,CAAC,yBAAyB;IACvC,aAAa,GAAG,UAAU,EAAE,CAAA,CAAC,iCAAiC;IAE9E,2EAA2E;IAClE,IAAI,GAAG,IAAI,CAAA;IACX,GAAG,GAAG,SAAS,CAAA;IACf,cAAc,GAAG,SAAS,CAAC,WAAW,CAAA,CAAC,uCAAuC;IAC9E,iBAAiB,GAAG,iBAAiB,CAAA;IAC9C,2EAA2E;IAE3E,uDAAuD;IAC9C,MAAM,GAAG;QAChB,QAAQ,EAAE,cAAc;QACxB,WAAW,EAAE,iBAAiB;QAC9B,yBAAyB,EAAE,yBAAyB;QACpD,wBAAwB,EAAE,wBAAwB;QAClD,gCAAgC;QAChC,8BAA8B;KAC/B,CAAA;IACD,2EAA2E;IAE3E;QACE,KAAK,EAAE,CAAA;IACT,CAAC;IAEM,qBAAqB,CAAC,OAAe;QAC1C,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAChD,CAAC;IAEM,MAAM,CAAC,uBAAuB,CAAC,cAA8B;QAClE,OAAO,oBAAoB,IAAI,cAAc,CAAA;IAC/C,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAAC,cAA8B;QACjE,OAAO,aAAa,IAAI,cAAc,CAAA;IACxC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,0DAA+B,CAAA;IAC1C,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,oCAAmB,CAAA;IAC9B,CAAC;IAID,iBAAiB,CAAC,gBAAkD,EAAE,aAAyD,EAAE,WAAwC;QACvK,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;YACxC,WAAW,GAAG,aAAa,CAAA;YAC3B,aAAa,GAAG,gBAAgB,CAAA;YAChC,IAAI,CAAC,IAAI,gEAAsC,aAAa,EAAE,WAAW,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,gEAAsC,aAAa,EAAE,WAAY,EAAE,gBAAgB,CAAC,CAAA;QAC/F,CAAC;IACH,CAAC;IAID,gBAAgB,CAAC,gBAAiD,EAAE,YAAsD,EAAE,WAAuC;QACjK,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;YACvC,WAAW,GAAG,YAAY,CAAA;YAC1B,YAAY,GAAG,gBAAgB,CAAA;YAC/B,IAAI,CAAC,IAAI,8DAAqC,YAAY,EAAE,WAAW,CAAC,CAAA;QAC1E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,8DAAqC,YAAY,EAAE,WAAY,EAAE,gBAAgB,CAAC,CAAA;QAC7F,CAAC;IACH,CAAC;IAED,wBAAwB,CAAC,gBAAkC,EAAE,WAAgC;QAC3F,IAAI,CAAC,0BAA0B,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAA;IAChE,CAAC;IAED,0BAA0B,CAAC,gBAAkC,EAAE,WAAgC;QAC7F,IAAI,CAAC,aAAa,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjE,GAAG,CAAC,IAAI,CAAC,6FAA6F,gBAAgB,uEAAuE,CAAC,CAAA;QAChM,CAAC;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,iEAAiE,CAAC,CAAA;YAC3G,CAAC;YAED,SAAS,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;QAChD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,mFAAgD,WAAW,CAAC,CAAA;IACvE,CAAC;IAED,2BAA2B,CAAC,gBAAkC,EAAE,YAA0B,EAAE,WAAgC;QAC1H,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,MAAM,YAAY,iEAAiE,CAAC,CAAA;YAC7H,CAAC;YAED,SAAS,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;YAC9C,SAAS,CAAC,mBAAmB,GAAG,YAAY,CAAA;QAC9C,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,qFAAiD,WAAW,CAAC,CAAA;IACxE,CAAC;IAED,yBAAyB,CAAC,WAAgC;QACxD,IAAI,CAAC,IAAI,iFAA+C,WAAW,CAAC,CAAA;IACtE,CAAC;IAED,6BAA6B,CAAC,gBAAkC,EAAE,YAA0B,EAAE,WAAgC;QAC5H,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,MAAM,YAAY,mEAAmE,CAAC,CAAA;YAC/H,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,yFAAmD,WAAW,CAAC,CAAA;IAC1E,CAAC;IAED,wBAAwB,CAAC,gBAAkC,EAAE,WAAgC;QAC3F,IAAI,CAAC,aAAa,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjE,GAAG,CAAC,IAAI,CAAC,0FAA0F,gBAAgB,uEAAuE,CAAC,CAAA;QAC7L,CAAC;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,uEAAuE,CAAC,CAAA;YACjH,CAAC;YAED,SAAS,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;QAChD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,+EAA8C,WAAW,CAAC,CAAA;IACrE,CAAC;IAED,0BAA0B,CAAC,gBAAkC,EAAE,WAAgC;QAC7F,IAAI,CAAC,aAAa,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjE,GAAG,CAAC,IAAI,CAAC,4FAA4F,gBAAgB,uEAAuE,CAAC,CAAA;QAC/L,CAAC;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,yEAAyE,CAAC,CAAA;YACnH,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,mFAAgD,WAAW,CAAC,CAAA;IACvE,CAAC;CACF"}

package/dist/bridgeService.d.ts

@@ -0,0 +1,125 @@
+import type { CharacteristicWarning, InterfaceName, IPAddress, MacAddress, MDNSAdvertiser } from 'hap-nodejs';
+import type { AccessoryIdentifier, AccessoryName, AccessoryPlugin, HomebridgeAPI, PlatformIdentifier, PlatformName, PluginIdentifier, StaticPlatformPlugin } from './api.js';
+import type { ExternalPortsConfiguration, ExternalPortService } from './externalPortService.js';
+import type { Logging } from './logger.js';
+import type { Plugin } from './plugin.js';
+import type { HomebridgeOptions } from './server.js';
+import { Accessory, Bridge } from 'hap-nodejs';
+import { PlatformAccessory } from './platformAccessory.js';
+import { PluginManager } from './pluginManager.js';
+export interface BridgeConfiguration {
+    name: string;
+    username: MacAddress;
+    pin: string;
+    advertiser?: MDNSAdvertiser;
+    port?: number;
+    bind?: (InterfaceName | IPAddress) | (InterfaceName | IPAddress)[];
+    setupID?: string[4];
+    manufacturer?: string;
+    model?: string;
+    disableIpc?: boolean;
+    firmwareRevision?: string;
+    serialNumber?: string;
+    debugModeEnabled?: boolean;
+    env?: {
+        DEBUG?: string;
+        NODE_OPTIONS?: string;
+    };
+}
+export interface AccessoryConfig extends Record<string, any> {
+    accessory: AccessoryName | AccessoryIdentifier;
+    name: string;
+    uuid_base?: string;
+    _bridge?: BridgeConfiguration;
+}
+export interface PlatformConfig extends Record<string, any> {
+    platform: PlatformName | PlatformIdentifier;
+    name?: string;
+    _bridge?: BridgeConfiguration;
+}
+export interface HomebridgeConfig {
+    bridge: BridgeConfiguration;
+    /**
+     * Optional Matter protocol configuration
+     */
+    matter?: {
+        enabled?: boolean;
+        port?: number;
+        discriminator?: number;
+        passcode?: number;
+        vendorId?: number;
+        productId?: number;
+        deviceName?: string;
+        deviceType?: number;
+    };
+    /**
+     * @deprecated
+     */
+    mdns?: any;
+    accessories: AccessoryConfig[];
+    platforms: PlatformConfig[];
+    plugins?: PluginIdentifier[];
+    /**
+     * Array of disabled plugins.
+     * Unlike the plugins[] config which prevents plugins from being initialised at all, disabled plugins still have their alias loaded, so
+     * we can match config blocks of disabled plugins and show an appropriate message in the logs.
+     */
+    disabledPlugins?: PluginIdentifier[];
+    ports?: ExternalPortsConfiguration;
+}
+export interface BridgeOptions extends HomebridgeOptions {
+    cachedAccessoriesDir: string;
+    cachedAccessoriesItemName: string;
+}
+export interface CharacteristicWarningOpts {
+    ignoreSlow?: boolean;
+}
+export declare class BridgeService {
+    private api;
+    private pluginManager;
+    private externalPortService;
+    private bridgeOptions;
+    private bridgeConfig;
+    private config;
+    bridge: Bridge;
+    private storageService;
+    private readonly allowInsecureAccess;
+    private cachedPlatformAccessories;
+    private cachedAccessoriesFileLoaded;
+    private readonly publishedExternalAccessories;
+    constructor(api: HomebridgeAPI, pluginManager: PluginManager, externalPortService: ExternalPortService, bridgeOptions: BridgeOptions, bridgeConfig: BridgeConfiguration, config: HomebridgeConfig);
+    static printCharacteristicWriteWarning(plugin: Plugin, accessory: Accessory, opts: CharacteristicWarningOpts, warning: CharacteristicWarning): void;
+    publishBridge(): void;
+    /**
+     * Attempt to load the cached accessories from disk.
+     */
+    loadCachedPlatformAccessoriesFromDisk(): Promise<void>;
+    /**
+     * Return the name of the backup cache file
+     */
+    private get backupCacheFileName();
+    /**
+     * Create a backup of the cached file
+     * This is used if we ever have trouble reading the main cache file
+     */
+    private createCachedAccessoriesBackup;
+    /**
+     * Restore a cached accessories backup
+     * This is used if the main cache file has a JSON syntax error / is corrupted
+     */
+    private restoreCachedAccessoriesBackup;
+    restoreCachedPlatformAccessories(): void;
+    /**
+     * Save the cached accessories back to disk.
+     */
+    saveCachedPlatformAccessoriesOnDisk(): void;
+    handleRegisterPlatformAccessories(accessories: PlatformAccessory[]): void;
+    handleUpdatePlatformAccessories(accessories: PlatformAccessory[]): void;
+    handleUnregisterPlatformAccessories(accessories: PlatformAccessory[]): void;
+    handlePublishExternalAccessories(accessories: PlatformAccessory[]): Promise<void>;
+    createHAPAccessory(plugin: Plugin, accessoryInstance: AccessoryPlugin, displayName: string, accessoryType: AccessoryName | AccessoryIdentifier, uuidBase?: string): Accessory | undefined;
+    loadPlatformAccessories(plugin: Plugin, platformInstance: StaticPlatformPlugin, platformType: PlatformName | PlatformIdentifier, logger: Logging): Promise<void>;
+    teardown(): void;
+    private static strippingPinCode;
+}
+//# sourceMappingURL=bridgeService.d.ts.map

package/dist/bridgeService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bridgeService.d.ts","sourceRoot":"","sources":["../src/bridgeService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,aAAa,EACb,SAAS,EACT,UAAU,EACV,cAAc,EAGf,MAAM,YAAY,CAAA;AAEnB,OAAO,KAAK,EACV,mBAAmB,EACnB,aAAa,EACb,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AACjB,OAAO,KAAK,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC/F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAEpD,OAAO,EACL,SAAS,EAET,MAAM,EASP,MAAM,YAAY,CAAA;AAInB,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAOlD,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,UAAU,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,cAAc,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,GAAG,CAAC,EAAE;QACJ,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,CAAA;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC1D,SAAS,EAAE,aAAa,GAAG,mBAAmB,CAAA;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B;AAED,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACzD,QAAQ,EAAE,YAAY,GAAG,kBAAkB,CAAA;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,mBAAmB,CAAA;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,CAAA;IAED;;OAEG;IACH,IAAI,CAAC,EAAE,GAAG,CAAA;IAEV,WAAW,EAAE,eAAe,EAAE,CAAA;IAC9B,SAAS,EAAE,cAAc,EAAE,CAAA;IAE3B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAE5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAGpC,KAAK,CAAC,EAAE,0BAA0B,CAAA;CACnC;AAED,MAAM,WAAW,aAAc,SAAQ,iBAAiB;IACtD,oBAAoB,EAAE,MAAM,CAAA;IAC5B,yBAAyB,EAAE,MAAM,CAAA;CAClC;AAED,MAAM,WAAW,yBAAyB;IACxC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,qBAAa,aAAa;IAStB,OAAO,CAAC,GAAG;IACX,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,mBAAmB;IAC3B,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,MAAM;IAbT,MAAM,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAC7C,OAAO,CAAC,yBAAyB,CAA0B;IAC3D,OAAO,CAAC,2BAA2B,CAAQ;IAC3C,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAgD;gBAGnF,GAAG,EAAE,aAAa,EAClB,aAAa,EAAE,aAAa,EAC5B,mBAAmB,EAAE,mBAAmB,EACxC,aAAa,EAAE,aAAa,EAC5B,YAAY,EAAE,mBAAmB,EACjC,MAAM,EAAE,gBAAgB;WA0BpB,+BAA+B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,EAAE,qBAAqB,GAAG,IAAI;IA+BnJ,aAAa,IAAI,IAAI;IA+B5B;;OAEG;IACU,qCAAqC,IAAI,OAAO,CAAC,IAAI,CAAC;IA+BnE;;OAEG;IACH,OAAO,KAAK,mBAAmB,GAE9B;IAED;;;OAGG;YACW,6BAA6B;IAQ3C;;;OAGG;YACW,8BAA8B;IAYrC,gCAAgC,IAAI,IAAI;IAoD/C;;OAEG;IACI,mCAAmC,IAAI,IAAI;IAclD,iCAAiC,CAAC,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAwBzE,+BAA+B,CAAC,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAkBvE,mCAAmC,CAAC,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI;IAcrE,gCAAgC,CAAC,WAAW,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA4ChF,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,mBAAmB,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAiDnL,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,YAAY,EAAE,YAAY,GAAG,kBAAkB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC7K,QAAQ,IAAI,IAAI;IAWhB,OAAO,CAAC,MAAM,CAAC,gBAAgB;CAOhC"}