hap-nodejs 1.0.0-beta.2 → 1.0.0-beta.3

package/dist/lib/Advertiser.d.ts

@@ -2,12 +2,15 @@
 /// <reference types="node" />
 import { MDNSServerOptions, ServiceTxt } from "@homebridge/ciao";
 import { InterfaceName, IPAddress } from "@homebridge/ciao/lib/NetworkManager";
+import { InvokeError } from "@homebridge/dbus-native";
 import { MulticastOptions } from "bonjour-hap";
 import { EventEmitter } from "events";
 import { AccessoryInfo } from "./model/AccessoryInfo";
 /**
  * This enum lists all bitmasks for all known status flags.
  * When the bit for the given bitmask is set, it represents the state described by the name.
+ *
+ * @group Advertiser
  */
 export declare const enum StatusFlag {
     NOT_PAIRED = 1,
@@ -17,26 +20,41 @@ export declare const enum StatusFlag {
 /**
  * This enum lists all bitmasks for all known pairing feature flags.
  * When the bit for the given bitmask is set, it represents the state described by the name.
+ *
+ * @group Advertiser
  */
 export declare const enum PairingFeatureFlag {
     SUPPORTS_HARDWARE_AUTHENTICATION = 1,
     SUPPORTS_SOFTWARE_AUTHENTICATION = 2
 }
+/**
+ * @group Advertiser
+ */
 export declare const enum AdvertiserEvent {
+    /**
+     * Emitted if the underlying mDNS advertisers signals, that the service name
+     * was automatically changed due to some naming conflicts on the network.
+     */
     UPDATED_NAME = "updated-name"
 }
+/**
+ * @group Advertiser
+ */
 export declare interface Advertiser {
     on(event: "updated-name", listener: (name: string) => void): this;
     emit(event: "updated-name", name: string): boolean;
 }
+/**
+ * @group Advertiser
+ */
 export interface ServiceNetworkOptions {
     /**
      * If defined it restricts the service to be advertised on the specified
      * ip addresses or interface names.
      *
-     * If a interface name is specified, ANY address on that given interface will be advertised
-     * (if a IP address of the given interface is also given in the array, it will be overridden).
-     * If a IP address is specified, the service will only be advertised for the given addresses.
+     * If an interface name is specified, ANY address on that given interface will be advertised
+     * (if an IP address of the given interface is also given in the array, it will be overridden).
+     * If an IP address is specified, the service will only be advertised for the given addresses.
      *
      * Interface names and addresses can be mixed in the array.
      * If an ip address is given, the ip address must be valid at the time of service creation.
@@ -52,9 +70,16 @@ export interface ServiceNetworkOptions {
      */
     disabledIpv6?: boolean;
 }
+/**
+ * A generic Advertiser interface required for any MDNS Advertiser backend implementations.
+ *
+ * All implementations have to extend NodeJS' {@link EventEmitter} and emit the events defined in {@link AdvertiserEvent}.
+ *
+ * @group Advertiser
+ */
 export interface Advertiser {
     initPort(port: number): void;
-    startAdvertising(): void;
+    startAdvertising(): Promise<void>;
     updateAdvertisement(silent?: boolean): void;
     destroy(): void;
 }
@@ -65,6 +90,8 @@ export interface Advertiser {
  * accessories with multiple iOS devices in your home, Apple intends for you to use Home Sharing.
  * To support this requirement, we provide the ability to be "discoverable" or not (via a "service flag" on the
  * mdns payload).
+ *
+ * @group Advertiser
  */
 export declare class CiaoAdvertiser extends EventEmitter implements Advertiser {
     static protocolVersion: string;
@@ -79,11 +106,14 @@ export declare class CiaoAdvertiser extends EventEmitter implements Advertiser {
     updateAdvertisement(silent?: boolean): void;
     destroy(): Promise<void>;
     static createTxt(accessoryInfo: AccessoryInfo, setupHash: string): ServiceTxt;
+    static computeSetupHash(accessoryInfo: AccessoryInfo): string;
     static ff(...flags: PairingFeatureFlag[]): number;
     static sf(...flags: StatusFlag[]): number;
 }
 /**
  * Advertiser base on the legacy "bonjour-hap" library.
+ *
+ * @group Advertiser
  */
 export declare class BonjourHAPAdvertiser extends EventEmitter implements Advertiser {
     private readonly accessoryInfo;
@@ -95,8 +125,72 @@ export declare class BonjourHAPAdvertiser extends EventEmitter implements Advert
     private destroyed;
     constructor(accessoryInfo: AccessoryInfo, responderOptions?: MulticastOptions, serviceOptions?: ServiceNetworkOptions);
     initPort(port: number): void;
-    startAdvertising(): void;
+    startAdvertising(): Promise<void>;
     updateAdvertisement(silent?: boolean): void;
     destroy(): void;
 }
+/**
+ * @group Advertiser
+ */
+export declare class DBusInvokeError extends Error {
+    readonly errorName: string;
+    constructor(errorObject: InvokeError);
+}
+/**
+ * Advertiser based on the Avahi D-Bus library.
+ * For (very crappy) docs on the interface, see the XML files at: https://github.com/lathiat/avahi/tree/master/avahi-daemon.
+ *
+ * Refer to https://github.com/lathiat/avahi/blob/fd482a74625b8db8547b8cfca3ee3d3c6c721423/avahi-common/defs.h#L120-L155 for a
+ * rough API usage guide of Avahi.
+ *
+ * @group Advertiser
+ */
+export declare class AvahiAdvertiser extends EventEmitter implements Advertiser {
+    private readonly accessoryInfo;
+    private readonly setupHash;
+    private port?;
+    private bus?;
+    private avahiServerInterface?;
+    private path?;
+    private readonly stateChangeHandler;
+    constructor(accessoryInfo: AccessoryInfo);
+    private createTxt;
+    initPort(port: number): void;
+    startAdvertising(): Promise<void>;
+    /**
+     * Event handler for the `StateChanged` event of the `org.freedesktop.Avahi.Server` DBus interface.
+     *
+     * This is called once the state of the running avahi-daemon changes its running state.
+     * @param state - The state the server changed into {@see AvahiServerState}.
+     */
+    private handleStateChangedEvent;
+    updateAdvertisement(silent?: boolean): Promise<void>;
+    destroy(): Promise<void>;
+    static isAvailable(): Promise<boolean>;
+    private static avahiInvoke;
+    private static avahiInterface;
+}
+/**
+ * Advertiser based on the systemd-resolved D-Bus library.
+ * For docs on the interface, see: https://www.freedesktop.org/software/systemd/man/org.freedesktop.resolve1.html
+ *
+ * @group Advertiser
+ */
+export declare class ResolvedAdvertiser extends EventEmitter implements Advertiser {
+    private readonly accessoryInfo;
+    private readonly setupHash;
+    private port?;
+    private bus?;
+    private path?;
+    constructor(accessoryInfo: AccessoryInfo);
+    private createTxt;
+    initPort(port: number): void;
+    startAdvertising(): Promise<void>;
+    updateAdvertisement(silent?: boolean): Promise<void>;
+    private stopAdvertising;
+    destroy(): Promise<void>;
+    static isAvailable(): Promise<boolean>;
+    private static resolvedInvoke;
+    private static managerInvoke;
+}
 //# sourceMappingURL=Advertiser.d.ts.map

package/dist/lib/Advertiser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Advertiser.d.ts","sourceRoot":"","sources":["../../src/lib/Advertiser.ts"],"names":[],"mappings":";;AACA,OAAa,EAEX,iBAAiB,EAGjB,UAAU,EAEX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAE/E,OAAgB,EAAiC,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAGtD;;;GAGG;AACH,0BAAkB,UAAU;IAC1B,UAAU,IAAO;IACjB,eAAe,IAAO;IACtB,gBAAgB,IAAO;CACxB;AAED;;;GAGG;AACH,0BAAkB,kBAAkB;IAClC,gCAAgC,IAAO;IACvC,gCAAgC,IAAO;CACxC;AAED,0BAAkB,eAAe;IAC/B,YAAY,iBAAiB;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU;IACjC,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IAElE,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACpD;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE,CAAC;IACpD;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IAEzB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,gBAAgB,IAAI,IAAI,CAAC;IAEzB,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C,OAAO,IAAI,IAAI,CAAC;CAEjB;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,YAAa,YAAW,UAAU;IAEpE,MAAM,CAAC,eAAe,EAAE,MAAM,CAAS;IACvC,MAAM,CAAC,sBAAsB,EAAE,MAAM,CAAW;IAEhD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAc;gBAEpC,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,cAAc,CAAC,EAAE,qBAAqB;IAoB/G,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5B,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKjC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAIrC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrC,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,UAAU;WAoB/D,EAAE,CAAC,GAAG,KAAK,EAAE,kBAAkB,EAAE,GAAG,MAAM;WAM1C,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM;CAMjD;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,YAAa,YAAW,UAAU;IAE1E,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAwB;IAExD,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,aAAa,CAAC,CAAoB;IAE1C,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,SAAS,CAAkB;gBAEvB,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,qBAAqB;IAU9G,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5B,gBAAgB,IAAI,IAAI;IAyBxB,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAM3C,OAAO,IAAI,IAAI;CAYvB"}
+{"version":3,"file":"Advertiser.d.ts","sourceRoot":"","sources":["../../src/lib/Advertiser.ts"],"names":[],"mappings":";;AAEA,OAAa,EAAe,iBAAiB,EAA2B,UAAU,EAAe,MAAM,kBAAkB,CAAC;AAC1H,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAa,EAAiB,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAEvF,OAAgB,EAAiC,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGvF,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAKtD;;;;;GAKG;AACH,0BAAkB,UAAU;IAC1B,UAAU,IAAO;IACjB,eAAe,IAAO;IACtB,gBAAgB,IAAO;CACxB;AAED;;;;;GAKG;AACH,0BAAkB,kBAAkB;IAClC,gCAAgC,IAAO;IACvC,gCAAgC,IAAO;CACxC;AAED;;GAEG;AACH,0BAAkB,eAAe;IAC/B;;;OAGG;IACH,YAAY,iBAAiB;CAC9B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,UAAU;IACjC,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IAElE,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE,CAAC;IACpD;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;;;;;;;GASG;AACH,qBAAa,cAAe,SAAQ,YAAa,YAAW,UAAU;IACpE,MAAM,CAAC,eAAe,SAAS;IAC/B,MAAM,CAAC,sBAAsB,SAAW;IAExC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAc;gBAEpC,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,cAAc,CAAC,EAAE,qBAAqB;IAoB/G,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5B,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKjC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAMrC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrC,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,UAAU;IAoB7E,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM;WAM/C,EAAE,CAAC,GAAG,KAAK,EAAE,kBAAkB,EAAE,GAAG,MAAM;WAM1C,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM;CAKjD;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,YAAa,YAAW,UAAU;IAC1E,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAwB;IAExD,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,aAAa,CAAC,CAAoB;IAE1C,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,SAAS,CAAS;gBAEd,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,qBAAqB;IAU9G,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5B,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BjC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAS3C,OAAO,IAAI,IAAI;CAYvB;AAmBD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAEf,WAAW,EAAE,WAAW;CAerC;AAyCD;;;;;;;;GAQG;AACH,qBAAa,eAAgB,SAAQ,YAAa,YAAW,UAAU;IACrE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,OAAO,CAAC,IAAI,CAAC,CAAS;IAEtB,OAAO,CAAC,GAAG,CAAC,CAAa;IACzB,OAAO,CAAC,oBAAoB,CAAC,CAAgB;IAC7C,OAAO,CAAC,IAAI,CAAC,CAAS;IAEtB,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoC;gBAE3D,aAAa,EAAE,aAAa;IAYxC,OAAO,CAAC,SAAS;IAMV,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAItB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAiC9C;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IAQlB,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBpD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;WAwBjB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IA0BnD,OAAO,CAAC,MAAM,CAAC,WAAW;IAW1B,OAAO,CAAC,MAAM,CAAC,cAAc;CAa9B;AAWD;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,UAAU;IACxE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,OAAO,CAAC,IAAI,CAAC,CAAS;IAEtB,OAAO,CAAC,GAAG,CAAC,CAAa;IACzB,OAAO,CAAC,IAAI,CAAC,CAAS;gBAEV,aAAa,EAAE,aAAa;IAUxC,OAAO,CAAC,SAAS;IAMV,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAItB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAiCjC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YAYnD,eAAe;IAmBhB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;WAWjB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAsDnD,OAAO,CAAC,MAAM,CAAC,cAAc;IAY7B,OAAO,CAAC,MAAM,CAAC,aAAa;CAG7B"}