@matter/protocol 0.11.0-alpha.0-20241005-e3e4e4a7a

package/dist/cjs/common/InstanceBroadcaster.d.ts

@@ -0,0 +1,273 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BitFlag, ProductDescription, TypeFromPartialBitSchema, VendorId } from "#types";
+import { Fabric } from "../fabric/Fabric.js";
+export declare const PairingHintBitmap: {
+    /**
+     * The Device will automatically enter Commissioning Mode upon power cycle (unplug/re- plug, remove/re-insert
+     * batteries). This bit SHALL be set to 1 for devices using Standard Commissioning Flow, and set to 0 otherwise.
+     */
+    powerCycle: BitFlag;
+    /**
+     * This SHALL be set to 1 for devices requiring Custom Commissioning Flow before they can be available for
+     * Commissioning by any Commissioner. For such a flow, the user SHOULD be sent to the URL specified in the
+     * CommissioningCustomFlowUrl of the DeviceModel schema entry indexed by the Vendor ID and Product ID (e.g., as
+     * found in the announcement) in the Distributed Compliance Ledger.
+     */
+    deviceManufacturerUrl: BitFlag;
+    /**
+     * The Device has been commissioned. Any Administrator that commissioned the device provides a user interface that
+     * may be used to put the device into Commissioning Mode.
+     */
+    administrator: BitFlag;
+    /**
+     * The settings menu on the Device provides instructions to put it into Commissioning Mode.
+     */
+    settingsMenuOnNode: BitFlag;
+    /**
+     * The PI key/value pair describes a custom way to put the Device into Commissioning Mode. This Custom Instruction
+     * option is NOT recommended for use by a Device that does not have knowledge of the user’s language preference.
+     */
+    customInstruction: BitFlag;
+    /**
+     * The Device Manual provides special instructions to put the Device into Commissioning Mode (see Section 11.22.5.8,
+     * “UserManualUrl”). This is a catch-all option to capture user interactions that are not codified by other options
+     * in this table.
+     */
+    deviceManual: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed.
+     */
+    pressResetButton: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed when applying power to it.
+     */
+    pressResetButtonWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed for N seconds. The exact value of N SHALL
+     * be made available via PI key.
+     */
+    pressRestButtonForNumberOfSeconds: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed until associated light blinks.
+     * Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressResetButtonUntilLightBlinks: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed for N seconds when applying power to it.
+     * The exact value of N SHALL be made available via PI key.
+     */
+    pressResetButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed until associated light blinks when
+     * applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressResetButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed N times with maximum 1 second between each
+     * press. The exact value of N SHALL be made available via PI key.
+     */
+    pressResetButtonNumberOfTimes: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed.
+     */
+    pressSetupButton: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed when applying power to it.
+     */
+    pressSetupButtonWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed for N seconds. The exact value of N SHALL
+     * be made available via PI key.
+     */
+    pressSetupButtonForNumberOfSeconds: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed until associated light blinks.
+     * Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressSetupButtonUntilLightBlinks: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed for N seconds when applying power to it.
+     * The exact value of N SHALL be made available via PI key.
+     */
+    pressSetupButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed until associated light blinks when
+     * applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressSetupButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed N times with maximum 1 second between each
+     * press. The exact value of N SHALL be made available via PI key.
+     */
+    pressSetupButtonNumberOfTimes: BitFlag;
+};
+export declare const PairingHintBitmapSchema: import("#types").BitmapSchemaInternal<{
+    /**
+     * The Device will automatically enter Commissioning Mode upon power cycle (unplug/re- plug, remove/re-insert
+     * batteries). This bit SHALL be set to 1 for devices using Standard Commissioning Flow, and set to 0 otherwise.
+     */
+    powerCycle: BitFlag;
+    /**
+     * This SHALL be set to 1 for devices requiring Custom Commissioning Flow before they can be available for
+     * Commissioning by any Commissioner. For such a flow, the user SHOULD be sent to the URL specified in the
+     * CommissioningCustomFlowUrl of the DeviceModel schema entry indexed by the Vendor ID and Product ID (e.g., as
+     * found in the announcement) in the Distributed Compliance Ledger.
+     */
+    deviceManufacturerUrl: BitFlag;
+    /**
+     * The Device has been commissioned. Any Administrator that commissioned the device provides a user interface that
+     * may be used to put the device into Commissioning Mode.
+     */
+    administrator: BitFlag;
+    /**
+     * The settings menu on the Device provides instructions to put it into Commissioning Mode.
+     */
+    settingsMenuOnNode: BitFlag;
+    /**
+     * The PI key/value pair describes a custom way to put the Device into Commissioning Mode. This Custom Instruction
+     * option is NOT recommended for use by a Device that does not have knowledge of the user’s language preference.
+     */
+    customInstruction: BitFlag;
+    /**
+     * The Device Manual provides special instructions to put the Device into Commissioning Mode (see Section 11.22.5.8,
+     * “UserManualUrl”). This is a catch-all option to capture user interactions that are not codified by other options
+     * in this table.
+     */
+    deviceManual: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed.
+     */
+    pressResetButton: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed when applying power to it.
+     */
+    pressResetButtonWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed for N seconds. The exact value of N SHALL
+     * be made available via PI key.
+     */
+    pressRestButtonForNumberOfSeconds: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed until associated light blinks.
+     * Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressResetButtonUntilLightBlinks: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed for N seconds when applying power to it.
+     * The exact value of N SHALL be made available via PI key.
+     */
+    pressResetButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed until associated light blinks when
+     * applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressResetButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when reset button is pressed N times with maximum 1 second between each
+     * press. The exact value of N SHALL be made available via PI key.
+     */
+    pressResetButtonNumberOfTimes: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed.
+     */
+    pressSetupButton: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed when applying power to it.
+     */
+    pressSetupButtonWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed for N seconds. The exact value of N SHALL
+     * be made available via PI key.
+     */
+    pressSetupButtonForNumberOfSeconds: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed until associated light blinks.
+     * Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressSetupButtonUntilLightBlinks: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed for N seconds when applying power to it.
+     * The exact value of N SHALL be made available via PI key.
+     */
+    pressSetupButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed until associated light blinks when
+     * applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).
+     */
+    pressSetupButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
+    /**
+     * The Device will enter Commissioning Mode when setup button is pressed N times with maximum 1 second between each
+     * press. The exact value of N SHALL be made available via PI key.
+     */
+    pressSetupButtonNumberOfTimes: BitFlag;
+}>;
+export interface CommissioningModeInstanceData extends ProductDescription {
+    /** Device discriminator for commissionable announcements. */
+    discriminator: number;
+    /** Session Idle Interval of the device for commissionable announcements. */
+    sessionIdleInterval?: number;
+    /** Session Active Interval of the device for commissionable announcements. */
+    sessionActiveInterval?: number;
+    /** Duration of time the node should stay Active after the last network activity. **/
+    sessionActiveThreshold?: number;
+    /** Pairing Hint of the device for commissionable announcements. */
+    pairingHint?: TypeFromPartialBitSchema<typeof PairingHintBitmap>;
+    /** Pairing Instruction of the device for commissionable announcements. */
+    pairingInstructions?: string;
+}
+export type CommissionerInstanceData = {
+    /** Device name for commissionable announcements. */
+    deviceName: string;
+    /** Device type for commissionable announcements. */
+    vendorId: VendorId;
+    /** Vendor ID for commissionable announcements. */
+    productId: number;
+    /** Device type for commissionable announcements. */
+    deviceType?: number;
+    /** Session Idle Interval of the device for commissionable announcements. */
+    sessionIdleInterval?: number;
+    /** Session Active Interval of the device for commissionable announcements. */
+    sessionActiveInterval?: number;
+    /** This key defines the duration of time the node stays Active after the last network activity. **/
+    sessionActiveThreshold?: number;
+};
+export type OperationalInstanceData = {
+    /** Session Idle Interval of the device for operational announcements. */
+    sessionIdleInterval?: number;
+    /** Session Active Interval of the device for operational announcements. */
+    sessionActiveInterval?: number;
+    /** This key defines the duration of time the node stays Active after the last network activity. **/
+    sessionActiveThreshold?: number;
+};
+export declare enum CommissioningMode {
+    NotCommissioning = 0,
+    Basic = 1,
+    Enhanced = 2
+}
+/** Interface for classes that allow to announce one Matter instance. */
+export interface InstanceBroadcaster {
+    /** Set a commissionable mode and details to announce a commissionable device. */
+    setCommissionMode(mode: CommissioningMode, deviceData: CommissioningModeInstanceData): Promise<void>;
+    /**
+     * Set operational details to Announce an operational device which is already commissioned.
+     * Use expireCommissioningAnnouncements = true when Fabrics are changed after a n commissioning process.
+     */
+    setFabrics(fabrics: Fabric[], expireCommissioningAnnouncements?: boolean): Promise<void>;
+    /** Set commissioner details to announce a commissioner service for User directed commissioning (UDC). */
+    setCommissionerInfo(commissionerData: CommissionerInstanceData): Promise<void>;
+    /** Send out announcements for this instance. */
+    announce(): Promise<void>;
+    /** Expire the announcement for this operative instance. */
+    expireFabricAnnouncement(): Promise<void>;
+    /** Expire the announcement for this commissioning instance. */
+    expireCommissioningAnnouncement(): Promise<void>;
+    /** Expire all announcements. */
+    expireAllAnnouncements(): Promise<void>;
+    /** Destroy the instance */
+    close(): Promise<void>;
+}
+//# sourceMappingURL=InstanceBroadcaster.d.ts.map

package/dist/cjs/common/InstanceBroadcaster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstanceBroadcaster.d.ts","sourceRoot":"","sources":["../../../src/common/InstanceBroadcaster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAgB,kBAAkB,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AACvG,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,eAAO,MAAM,iBAAiB;IAC1B;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;CAEN,CAAC;AAEF,eAAO,MAAM,uBAAuB;IAvHhC;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;EAI+D,CAAC;AAEvE,MAAM,WAAW,6BAA8B,SAAQ,kBAAkB;IACrE,6DAA6D;IAC7D,aAAa,EAAE,MAAM,CAAC;IAEtB,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,qFAAqF;IACrF,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,mEAAmE;IACnE,WAAW,CAAC,EAAE,wBAAwB,CAAC,OAAO,iBAAiB,CAAC,CAAC;IAEjE,0EAA0E;IAC1E,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,MAAM,wBAAwB,GAAG;IACnC,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IAEnB,oDAAoD;IACpD,QAAQ,EAAE,QAAQ,CAAC;IAEnB,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAElB,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,oGAAoG;IACpG,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,2EAA2E;IAC3E,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,oGAAoG;IACpG,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF,oBAAY,iBAAiB;IACzB,gBAAgB,IAAI;IACpB,KAAK,IAAI;IACT,QAAQ,IAAI;CACf;AAED,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAChC,iFAAiF;IACjF,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,EAAE,UAAU,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErG;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,gCAAgC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzF,yGAAyG;IACzG,mBAAmB,CAAC,gBAAgB,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/E,gDAAgD;IAChD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B,2DAA2D;IAC3D,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C,+DAA+D;IAC/D,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD,gCAAgC;IAChC,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC,2BAA2B;IAC3B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B"}

package/dist/cjs/common/InstanceBroadcaster.js

@@ -0,0 +1,139 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var InstanceBroadcaster_exports = {};
+__export(InstanceBroadcaster_exports, {
+  CommissioningMode: () => CommissioningMode,
+  PairingHintBitmap: () => PairingHintBitmap,
+  PairingHintBitmapSchema: () => PairingHintBitmapSchema
+});
+module.exports = __toCommonJS(InstanceBroadcaster_exports);
+var import_types = require("#types");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const PairingHintBitmap = {
+  /**
+   * The Device will automatically enter Commissioning Mode upon power cycle (unplug/re- plug, remove/re-insert
+   * batteries). This bit SHALL be set to 1 for devices using Standard Commissioning Flow, and set to 0 otherwise.
+   */
+  powerCycle: (0, import_types.BitFlag)(0),
+  /**
+   * This SHALL be set to 1 for devices requiring Custom Commissioning Flow before they can be available for
+   * Commissioning by any Commissioner. For such a flow, the user SHOULD be sent to the URL specified in the
+   * CommissioningCustomFlowUrl of the DeviceModel schema entry indexed by the Vendor ID and Product ID (e.g., as
+   * found in the announcement) in the Distributed Compliance Ledger.
+   */
+  deviceManufacturerUrl: (0, import_types.BitFlag)(1),
+  /**
+   * The Device has been commissioned. Any Administrator that commissioned the device provides a user interface that
+   * may be used to put the device into Commissioning Mode.
+   */
+  administrator: (0, import_types.BitFlag)(2),
+  /**
+   * The settings menu on the Device provides instructions to put it into Commissioning Mode.
+   */
+  settingsMenuOnNode: (0, import_types.BitFlag)(3),
+  /**
+   * The PI key/value pair describes a custom way to put the Device into Commissioning Mode. This Custom Instruction
+   * option is NOT recommended for use by a Device that does not have knowledge of the user’s language preference.
+   */
+  customInstruction: (0, import_types.BitFlag)(4),
+  /**
+   * The Device Manual provides special instructions to put the Device into Commissioning Mode (see Section 11.22.5.8,
+   * “UserManualUrl”). This is a catch-all option to capture user interactions that are not codified by other options
+   * in this table.
+   */
+  deviceManual: (0, import_types.BitFlag)(5),
+  /**
+   * The Device will enter Commissioning Mode when reset button is pressed.
+   */
+  pressResetButton: (0, import_types.BitFlag)(6),
+  /**
+   * The Device will enter Commissioning Mode when reset button is pressed when applying power to it.
+   */
+  pressResetButtonWithApplicationOfPower: (0, import_types.BitFlag)(7),
+  /**
+   * The Device will enter Commissioning Mode when reset button is pressed for N seconds. The exact value of N SHALL
+   * be made available via PI key.
+   */
+  pressRestButtonForNumberOfSeconds: (0, import_types.BitFlag)(8),
+  /**
+   * The Device will enter Commissioning Mode when reset button is pressed until associated light blinks.
+   * Information on color of light MAY be made available via PI key (see Note 1).
+   */
+  pressResetButtonUntilLightBlinks: (0, import_types.BitFlag)(9),
+  /**
+   * The Device will enter Commissioning Mode when reset button is pressed for N seconds when applying power to it.
+   * The exact value of N SHALL be made available via PI key.
+   */
+  pressResetButtonForNumberOfSecondsWithApplicationOfPower: (0, import_types.BitFlag)(10),
+  /**
+   * The Device will enter Commissioning Mode when reset button is pressed until associated light blinks when
+   * applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).
+   */
+  pressResetButtonUntilLightBlinksWithApplicationOfPower: (0, import_types.BitFlag)(11),
+  /**
+   * The Device will enter Commissioning Mode when reset button is pressed N times with maximum 1 second between each
+   * press. The exact value of N SHALL be made available via PI key.
+   */
+  pressResetButtonNumberOfTimes: (0, import_types.BitFlag)(12),
+  /**
+   * The Device will enter Commissioning Mode when setup button is pressed.
+   */
+  pressSetupButton: (0, import_types.BitFlag)(13),
+  /**
+   * The Device will enter Commissioning Mode when setup button is pressed when applying power to it.
+   */
+  pressSetupButtonWithApplicationOfPower: (0, import_types.BitFlag)(14),
+  /**
+   * The Device will enter Commissioning Mode when setup button is pressed for N seconds. The exact value of N SHALL
+   * be made available via PI key.
+   */
+  pressSetupButtonForNumberOfSeconds: (0, import_types.BitFlag)(15),
+  /**
+   * The Device will enter Commissioning Mode when setup button is pressed until associated light blinks.
+   * Information on color of light MAY be made available via PI key (see Note 1).
+   */
+  pressSetupButtonUntilLightBlinks: (0, import_types.BitFlag)(16),
+  /**
+   * The Device will enter Commissioning Mode when setup button is pressed for N seconds when applying power to it.
+   * The exact value of N SHALL be made available via PI key.
+   */
+  pressSetupButtonForNumberOfSecondsWithApplicationOfPower: (0, import_types.BitFlag)(17),
+  /**
+   * The Device will enter Commissioning Mode when setup button is pressed until associated light blinks when
+   * applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).
+   */
+  pressSetupButtonUntilLightBlinksWithApplicationOfPower: (0, import_types.BitFlag)(18),
+  /**
+   * The Device will enter Commissioning Mode when setup button is pressed N times with maximum 1 second between each
+   * press. The exact value of N SHALL be made available via PI key.
+   */
+  pressSetupButtonNumberOfTimes: (0, import_types.BitFlag)(19)
+};
+const PairingHintBitmapSchema = (0, import_types.BitmapSchema)(PairingHintBitmap);
+var CommissioningMode = /* @__PURE__ */ ((CommissioningMode2) => {
+  CommissioningMode2[CommissioningMode2["NotCommissioning"] = 0] = "NotCommissioning";
+  CommissioningMode2[CommissioningMode2["Basic"] = 1] = "Basic";
+  CommissioningMode2[CommissioningMode2["Enhanced"] = 2] = "Enhanced";
+  return CommissioningMode2;
+})(CommissioningMode || {});
+//# sourceMappingURL=InstanceBroadcaster.js.map

package/dist/cjs/common/InstanceBroadcaster.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/common/InstanceBroadcaster.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,mBAA8F;AAN9F;AAAA;AAAA;AAAA;AAAA;AASO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA;AAAA,EAK7B,gBAAY,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrB,2BAAuB,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMhC,mBAAe,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA,EAKxB,wBAAoB,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAM7B,uBAAmB,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO5B,kBAAc,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA,EAKvB,sBAAkB,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA,EAK3B,4CAAwC,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMjD,uCAAmC,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAM5C,sCAAkC,sBAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,8DAA0D,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMpE,4DAAwD,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMlE,mCAA+B,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA,EAKzC,sBAAkB,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA,EAK5B,4CAAwC,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMlD,wCAAoC,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9C,sCAAkC,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA,EAM5C,8DAA0D,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMpE,4DAAwD,sBAAQ,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMlE,mCAA+B,sBAAQ,EAAE;AAC7C;AAEO,MAAM,8BAA0B,2BAAa,iBAAiB;AAwD9D,IAAK,oBAAL,kBAAKA,uBAAL;AACH,EAAAA,sCAAA,sBAAmB,KAAnB;AACA,EAAAA,sCAAA,WAAQ,KAAR;AACA,EAAAA,sCAAA,cAAW,KAAX;AAHQ,SAAAA;AAAA,GAAA;",
+  "names": ["CommissioningMode"]
+}

package/dist/cjs/common/OperationalCredentialsTypes.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** @see {@link MatterSpecification.v11.Core} § 11.17.5.4 */
+export declare const TlvAttestation: import("#types").ObjectSchema<{
+    declaration: import("#types").FieldType<Uint8Array>;
+    attestationNonce: import("#types").FieldType<Uint8Array>;
+    timestamp: import("#types").FieldType<number>;
+    firmwareInfo: import("#types").OptionalFieldType<Uint8Array>;
+}>;
+/** @see {@link MatterSpecification.v11.Core} § 11.17.5.6 */
+export declare const TlvCertSigningRequest: import("#types").ObjectSchema<{
+    certSigningRequest: import("#types").FieldType<Uint8Array>;
+    csrNonce: import("#types").FieldType<Uint8Array>;
+    vendorReserved1: import("#types").OptionalFieldType<Uint8Array>;
+    vendorReserved2: import("#types").OptionalFieldType<Uint8Array>;
+    vendorReserved3: import("#types").OptionalFieldType<Uint8Array>;
+}>;
+//# sourceMappingURL=OperationalCredentialsTypes.d.ts.map

package/dist/cjs/common/OperationalCredentialsTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationalCredentialsTypes.d.ts","sourceRoot":"","sources":["../../../src/common/OperationalCredentialsTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,4DAA4D;AAC5D,eAAO,MAAM,cAAc;;;;;EAKzB,CAAC;AAEH,4DAA4D;AAC5D,eAAO,MAAM,qBAAqB;;;;;;EAMhC,CAAC"}

package/dist/cjs/common/OperationalCredentialsTypes.js

@@ -0,0 +1,45 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var OperationalCredentialsTypes_exports = {};
+__export(OperationalCredentialsTypes_exports, {
+  TlvAttestation: () => TlvAttestation,
+  TlvCertSigningRequest: () => TlvCertSigningRequest
+});
+module.exports = __toCommonJS(OperationalCredentialsTypes_exports);
+var import_types = require("#types");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const TlvAttestation = (0, import_types.TlvObject)({
+  declaration: (0, import_types.TlvField)(1, import_types.TlvByteString),
+  attestationNonce: (0, import_types.TlvField)(2, import_types.TlvByteString.bound({ length: 32 })),
+  timestamp: (0, import_types.TlvField)(3, import_types.TlvUInt32),
+  // TODO: check actual max length in specs
+  firmwareInfo: (0, import_types.TlvOptionalField)(4, import_types.TlvByteString)
+});
+const TlvCertSigningRequest = (0, import_types.TlvObject)({
+  certSigningRequest: (0, import_types.TlvField)(1, import_types.TlvByteString),
+  csrNonce: (0, import_types.TlvField)(2, import_types.TlvByteString.bound({ length: 32 })),
+  vendorReserved1: (0, import_types.TlvOptionalField)(3, import_types.TlvByteString),
+  vendorReserved2: (0, import_types.TlvOptionalField)(4, import_types.TlvByteString),
+  vendorReserved3: (0, import_types.TlvOptionalField)(5, import_types.TlvByteString)
+});
+//# sourceMappingURL=OperationalCredentialsTypes.js.map

package/dist/cjs/common/OperationalCredentialsTypes.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/common/OperationalCredentialsTypes.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,mBAAgF;AANhF;AAAA;AAAA;AAAA;AAAA;AASO,MAAM,qBAAiB,wBAAU;AAAA,EACpC,iBAAa,uBAAS,GAAG,0BAAa;AAAA,EACtC,sBAAkB,uBAAS,GAAG,2BAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC;AAAA,EACjE,eAAW,uBAAS,GAAG,sBAAS;AAAA;AAAA,EAChC,kBAAc,+BAAiB,GAAG,0BAAa;AACnD,CAAC;AAGM,MAAM,4BAAwB,wBAAU;AAAA,EAC3C,wBAAoB,uBAAS,GAAG,0BAAa;AAAA,EAC7C,cAAU,uBAAS,GAAG,2BAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC;AAAA,EACzD,qBAAiB,+BAAiB,GAAG,0BAAa;AAAA,EAClD,qBAAiB,+BAAiB,GAAG,0BAAa;AAAA,EAClD,qBAAiB,+BAAiB,GAAG,0BAAa;AACtD,CAAC;",
+  "names": []
+}

package/dist/cjs/common/Scanner.d.ts

@@ -0,0 +1,121 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BasicSet, ChannelType, Environment, Environmental, ServerAddress, ServerAddressIp } from "#general";
+import { DiscoveryCapabilitiesBitmap, NodeId, TypeFromPartialBitSchema, VendorId } from "#types";
+import { Fabric } from "../fabric/Fabric.js";
+/**
+ * All information exposed by a commissionable device via announcements.
+ * The properties are named identical as in the Matter specification.
+ */
+export type DiscoveryData = {
+    /** VendorId + ProductId */
+    VP?: string;
+    /** Device type */
+    DT?: number;
+    /** Device advertising name */
+    DN?: string;
+    /** Rotating device identifier */
+    RI?: string;
+    /** Pairing hint */
+    PH?: number;
+    /** Pairing instructions */
+    PI?: string;
+    /** Sleep Idle Interval */
+    SII?: number;
+    /** Sleep Active Interval */
+    SAI?: number;
+    /** Session active threshold */
+    SAT?: number;
+    /** TCP supported */
+    T?: number;
+    /** ICD Long Idle Time operating mode supported */
+    ICD?: number;
+};
+export type DiscoverableDevice<SA extends ServerAddress> = DiscoveryData & {
+    /** The device's addresses IP/port pairs */
+    addresses: SA[];
+};
+export type AddressTypeFromDevice<D extends DiscoverableDevice<any>> = D extends DiscoverableDevice<infer SA> ? SA : never;
+export type OperationalDevice = DiscoverableDevice<ServerAddressIp> & {
+    deviceIdentifier: string;
+};
+export type CommissionableDevice = DiscoverableDevice<ServerAddress> & {
+    deviceIdentifier: string;
+    /** Discriminator */
+    D: number;
+    /** Commissioning Mode */
+    CM: number;
+};
+/**
+ * Identifier to use to discover a commissionable device.
+ * Please decide for the best matching identifier that you have.
+ */
+export type CommissionableDeviceIdentifiers = {
+    /** Instance ID of the commissionable device. This is mainly used by UDC. */
+    instanceId: string;
+} | {
+    /** The Long Discriminator of the commissionable device that can be obtained from the QR code. */
+    longDiscriminator: number;
+} | {
+    /** The Short Discriminator of the commissionable device that can be obtained from the Pairing code. */
+    shortDiscriminator: number;
+} | {
+    /** The vendor ID of the commissionable device, if devices from a special vendor should be discovered. */
+    vendorId: VendorId;
+    /** Optionally the product ID of the commissionable device, if devices from a special vendor should be discovered. */
+    productId?: number;
+} | {
+    /** The device type of the commissionable device, if devices of a special type should be discovered. */
+    deviceType: number;
+} | {
+    /** The product ID of the commissionable device, if devices with a special product should be discovered. */
+    productId: number;
+} | {
+    [K in any]: never;
+};
+export interface Scanner {
+    type: ChannelType;
+    /**
+     * Send DNS-SD queries to discover the current addresses of an operational paired device by its operational ID
+     * and return them.
+     */
+    findOperationalDevice(fabric: Fabric, nodeId: NodeId, timeoutSeconds?: number, ignoreExistingRecords?: boolean): Promise<OperationalDevice | undefined>;
+    /**
+     * Return already discovered addresses of an operational paired device and return them. Does not send out new
+     * DNS-SD queries.
+     */
+    getDiscoveredOperationalDevice(fabric: Fabric, nodeId: NodeId): OperationalDevice | undefined;
+    /**
+     * Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator,
+     * vendorId, etc.) and returns as soon as minimum one was found or the timeout is over.
+     */
+    findCommissionableDevices(identifier: CommissionableDeviceIdentifiers, timeoutSeconds?: number, ignoreExistingRecords?: boolean): Promise<CommissionableDevice[]>;
+    /**
+     * Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator,
+     * vendorId, etc.) and returns after the timeout is over. For each new discovered device the provided callback is
+     * called when it is discovered.
+     */
+    findCommissionableDevicesContinuously(identifier: CommissionableDeviceIdentifiers, callback: (device: CommissionableDevice) => void, timeoutSeconds?: number): Promise<CommissionableDevice[]>;
+    /** Return already discovered commissionable devices and return them. Does not send out new DNS-SD queries. */
+    getDiscoveredCommissionableDevices(identifier: CommissionableDeviceIdentifiers): CommissionableDevice[];
+    /**
+     * Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would
+     * be over.
+     */
+    cancelCommissionableDeviceDiscovery(identifier: CommissionableDeviceIdentifiers, resolvePromise?: boolean): void;
+    /** Close the scanner server and free resources. */
+    close(): void;
+}
+export declare class ScannerSet extends BasicSet<Scanner> {
+    scannerFor(type: ChannelType): Scanner | undefined;
+    hasScannerFor(type: ChannelType): boolean;
+    /**
+     * Select a set of scanners based on discovery capabilities.
+     */
+    select(discoveryCapabilities?: TypeFromPartialBitSchema<typeof DiscoveryCapabilitiesBitmap>): Scanner[];
+    [Environmental.create](env: Environment): ScannerSet;
+}
+//# sourceMappingURL=Scanner.d.ts.map

package/dist/cjs/common/Scanner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Scanner.d.ts","sourceRoot":"","sources":["../../../src/common/Scanner.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC7G,OAAO,EAAE,2BAA2B,EAAE,MAAM,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AACjG,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,2BAA2B;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,kBAAkB;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,8BAA8B;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,iCAAiC;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,mBAAmB;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,2BAA2B;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,0BAA0B;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,4BAA4B;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,+BAA+B;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,oBAAoB;IACpB,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,EAAE,SAAS,aAAa,IAAI,aAAa,GAAG;IACvE,2CAA2C;IAC3C,SAAS,EAAE,EAAE,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,kBAAkB,CAAC,GAAG,CAAC,IAC/D,CAAC,SAAS,kBAAkB,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;AAExD,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,eAAe,CAAC,GAAG;IAClE,gBAAgB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,aAAa,CAAC,GAAG;IACnE,gBAAgB,EAAE,MAAM,CAAC;IAEzB,oBAAoB;IACpB,CAAC,EAAE,MAAM,CAAC;IAEV,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GACrC;IACI,4EAA4E;IAC5E,UAAU,EAAE,MAAM,CAAC;CACtB,GACD;IACI,iGAAiG;IACjG,iBAAiB,EAAE,MAAM,CAAC;CAC7B,GACD;IACI,uGAAuG;IACvG,kBAAkB,EAAE,MAAM,CAAC;CAC9B,GACD;IACI,yGAAyG;IACzG,QAAQ,EAAE,QAAQ,CAAC;IAEnB,qHAAqH;IACrH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IACI,uGAAuG;IACvG,UAAU,EAAE,MAAM,CAAC;CACtB,GACD;IACI,2GAA2G;IAC3G,SAAS,EAAE,MAAM,CAAC;CACrB,GACD;KAEK,CAAC,IAAI,GAAG,GAAG,KAAK;CACpB,CAAC;AAER,MAAM,WAAW,OAAO;IACpB,IAAI,EAAE,WAAW,CAAC;IAElB;;;OAGG;IACH,qBAAqB,CACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,qBAAqB,CAAC,EAAE,OAAO,GAChC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAE1C;;;OAGG;IACH,8BAA8B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAE9F;;;OAGG;IACH,yBAAyB,CACrB,UAAU,EAAE,+BAA+B,EAC3C,cAAc,CAAC,EAAE,MAAM,EACvB,qBAAqB,CAAC,EAAE,OAAO,GAChC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAEnC;;;;OAIG;IACH,qCAAqC,CACjC,UAAU,EAAE,+BAA+B,EAC3C,QAAQ,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,EAChD,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAEnC,8GAA8G;IAC9G,kCAAkC,CAAC,UAAU,EAAE,+BAA+B,GAAG,oBAAoB,EAAE,CAAC;IAExG;;;OAGG;IACH,mCAAmC,CAAC,UAAU,EAAE,+BAA+B,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjH,mDAAmD;IACnD,KAAK,IAAI,IAAI,CAAC;CACjB;AAED,qBAAa,UAAW,SAAQ,QAAQ,CAAC,OAAO,CAAC;IAC7C,UAAU,CAAC,IAAI,EAAE,WAAW;IAI5B,aAAa,CAAC,IAAI,EAAE,WAAW;IAI/B;;OAEG;IACI,MAAM,CAAC,qBAAqB,CAAC,EAAE,wBAAwB,CAAC,OAAO,2BAA2B,CAAC;IAQlG,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,WAAW;CAK1C"}