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

package/dist/cjs/peer/ControllerCommissioner.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { RootCertificateManager } from "#certificate/RootCertificateManager.js";
+import { CommissionableDevice, CommissionableDeviceIdentifiers, DiscoveryData, ScannerSet } from "#common/Scanner.js";
+import { Fabric } from "#fabric/Fabric.js";
+import { Environment, Environmental, NetInterfaceSet, ServerAddress } from "#general";
+import { ControllingCommissioningFlowOptions } from "#peer/ControllerCommissioningFlow.js";
+import { ExchangeManager } from "#protocol/ExchangeManager.js";
+import { SessionManager } from "#session/SessionManager.js";
+import { DiscoveryCapabilitiesBitmap, NodeId, TypeFromPartialBitSchema } from "#types";
+import { PeerAddress } from "./PeerAddress.js";
+import { PeerSet } from "./PeerSet.js";
+/**
+ * Options needed to commission a new node
+ */
+export interface PeerCommissioningOptions extends Partial<ControllingCommissioningFlowOptions> {
+    /** The fabric into which to commission. */
+    fabric: Fabric;
+    /** The node ID to assign (the commissioner assigns a random node ID if omitted) */
+    nodeId?: NodeId;
+    /** Discovery related options. */
+    discovery: ({
+        /**
+         * Device identifiers (Short or Long Discriminator, Product/Vendor-Ids, Device-type or a pre-discovered
+         * instance Id, or "nothing" to discover all commissionable matter devices) to use for discovery.
+         * If the property commissionableDevice is provided this property is ignored.
+         */
+        identifierData: CommissionableDeviceIdentifiers;
+    } | {
+        /**
+         * Commissionable device object returned by a discovery run.
+         * If this property is provided then identifierData and knownAddress are ignored.
+         */
+        commissionableDevice: CommissionableDevice;
+    }) & {
+        /**
+         * Discovery capabilities to use for discovery. These are included in the QR code normally and defined if BLE
+         * is supported for initial commissioning.
+         */
+        discoveryCapabilities?: TypeFromPartialBitSchema<typeof DiscoveryCapabilitiesBitmap>;
+        /**
+         * Known address of the device to use for discovery. if this is set this will be tried first before discovering
+         * the device.
+         */
+        knownAddress?: ServerAddress;
+        /** Timeout in seconds for the discovery process. Default: 30 seconds */
+        timeoutSeconds?: number;
+    };
+    /** Passcode to use for commissioning. */
+    passcode: number;
+    /**
+     * Commissioning completion callback
+     *
+     * This optional callback allows the caller to complete commissioning once PASE commissioning completes.  If it does
+     * not throw, the commissioner considers commissioning complete.
+     */
+    performCaseCommissioning?: (peerAddress: PeerAddress, discoveryData?: DiscoveryData) => Promise<void>;
+}
+/**
+ * Interfaces {@link ControllerCommissioner} with other components.
+ */
+export interface ControllerCommissionerContext {
+    peers: PeerSet;
+    scanners: ScannerSet;
+    netInterfaces: NetInterfaceSet;
+    sessions: SessionManager;
+    exchanges: ExchangeManager;
+    certificates: RootCertificateManager;
+}
+/**
+ * Commissions other nodes onto a fabric.
+ */
+export declare class ControllerCommissioner {
+    #private;
+    constructor(context: ControllerCommissionerContext);
+    [Environmental.create](env: Environment): ControllerCommissioner;
+    commission(options: PeerCommissioningOptions): Promise<PeerAddress>;
+}
+//# sourceMappingURL=ControllerCommissioner.d.ts.map

package/dist/cjs/peer/ControllerCommissioner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ControllerCommissioner.d.ts","sourceRoot":"","sources":["../../../src/peer/ControllerCommissioner.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAEhF,OAAO,EAAE,oBAAoB,EAAE,+BAA+B,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACtH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAGH,WAAW,EACX,aAAa,EAGb,eAAe,EAEf,aAAa,EAChB,MAAM,UAAU,CAAC;AAElB,OAAO,EAA+B,mCAAmC,EAAE,MAAM,sCAAsC,CAAC;AAExH,OAAO,EAAE,eAAe,EAAoC,MAAM,8BAA8B,CAAC;AAEjG,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,MAAM,EAA8B,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAEnH,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAqB,OAAO,EAAE,MAAM,cAAc,CAAC;AAI1D;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,OAAO,CAAC,mCAAmC,CAAC;IAC1F,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IAEf,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,iCAAiC;IACjC,SAAS,EAAE,CACL;QACI;;;;WAIG;QACH,cAAc,EAAE,+BAA+B,CAAC;KACnD,GACD;QACI;;;WAGG;QACH,oBAAoB,EAAE,oBAAoB,CAAC;KAC9C,CACN,GAAG;QACA;;;WAGG;QACH,qBAAqB,CAAC,EAAE,wBAAwB,CAAC,OAAO,2BAA2B,CAAC,CAAC;QAErF;;;WAGG;QACH,YAAY,CAAC,EAAE,aAAa,CAAC;QAE7B,wEAAwE;QACxE,cAAc,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACzG;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC1C,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,UAAU,CAAC;IACrB,aAAa,EAAE,eAAe,CAAC;IAC/B,QAAQ,EAAE,cAAc,CAAC;IACzB,SAAS,EAAE,eAAe,CAAC;IAC3B,YAAY,EAAE,sBAAsB,CAAC;CACxC;AAED;;GAEG;AACH,qBAAa,sBAAsB;;gBAInB,OAAO,EAAE,6BAA6B;IAKlD,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,WAAW;IAajC,UAAU,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;CAoP5E"}

package/dist/cjs/peer/ControllerCommissioner.js

@@ -0,0 +1,224 @@
+"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 ControllerCommissioner_exports = {};
+__export(ControllerCommissioner_exports, {
+  ControllerCommissioner: () => ControllerCommissioner
+});
+module.exports = __toCommonJS(ControllerCommissioner_exports);
+var import_RootCertificateManager = require("#certificate/RootCertificateManager.js");
+var import_general_commissioning = require("#clusters/general-commissioning");
+var import_Scanner = require("#common/Scanner.js");
+var import_general = require("#general");
+var import_MdnsScanner = require("#mdns/MdnsScanner.js");
+var import_ControllerCommissioningFlow = require("#peer/ControllerCommissioningFlow.js");
+var import_ControllerDiscovery = require("#peer/ControllerDiscovery.js");
+var import_ExchangeManager = require("#protocol/ExchangeManager.js");
+var import_session = require("#session/index.js");
+var import_SessionManager = require("#session/SessionManager.js");
+var import_types = require("#types");
+var import_InteractionClient = require("../interaction/InteractionClient.js");
+var import_PeerSet = require("./PeerSet.js");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const logger = import_general.Logger.get("PeerCommissioner");
+class ControllerCommissioner {
+  #context;
+  #paseClient;
+  constructor(context) {
+    this.#context = context;
+    this.#paseClient = new import_session.PaseClient(context.sessions);
+  }
+  [import_general.Environmental.create](env) {
+    const instance = new ControllerCommissioner({
+      peers: env.get(import_PeerSet.PeerSet),
+      scanners: env.get(import_Scanner.ScannerSet),
+      netInterfaces: env.get(import_general.NetInterfaceSet),
+      sessions: env.get(import_SessionManager.SessionManager),
+      exchanges: env.get(import_ExchangeManager.ExchangeManager),
+      certificates: env.get(import_RootCertificateManager.RootCertificateManager)
+    });
+    env.set(ControllerCommissioner, instance);
+    return instance;
+  }
+  async commission(options) {
+    const {
+      discovery: { timeoutSeconds = 30 },
+      passcode
+    } = options;
+    const commissioningOptions = {
+      regulatoryLocation: import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Outdoor,
+      // Set to the most restrictive if relevant
+      regulatoryCountryCode: "XX",
+      ...options
+    };
+    const commissionableDevice = "commissionableDevice" in options.discovery ? options.discovery.commissionableDevice : void 0;
+    let {
+      discovery: { discoveryCapabilities = {}, knownAddress }
+    } = options;
+    let identifierData = "identifierData" in options.discovery ? options.discovery.identifierData : {};
+    if (this.#context.scanners.hasScannerFor(import_general.ChannelType.UDP) && this.#context.netInterfaces.hasInterfaceFor(import_general.ChannelType.UDP, "::") !== void 0) {
+      discoveryCapabilities.onIpNetwork = true;
+    }
+    if (commissionableDevice !== void 0) {
+      let { addresses } = commissionableDevice;
+      if (discoveryCapabilities.ble === true) {
+        discoveryCapabilities = { onIpNetwork: true, ble: addresses.some((address) => address.type === "ble") };
+      } else if (discoveryCapabilities.onIpNetwork === true) {
+        addresses = addresses.filter((address) => address.type !== "ble");
+      }
+      addresses.sort((a) => a.type === "udp" ? -1 : 1);
+      knownAddress = addresses[0];
+      if ("instanceId" in commissionableDevice && commissionableDevice.instanceId !== void 0) {
+        identifierData = { instanceId: commissionableDevice.instanceId };
+      } else {
+        identifierData = { longDiscriminator: commissionableDevice.D };
+      }
+    }
+    const scannersToUse = this.#context.scanners.select(discoveryCapabilities);
+    logger.info(
+      `Commissioning device with identifier ${import_general.Logger.toJSON(identifierData)} and ${scannersToUse.length} scanners and knownAddress ${import_general.Logger.toJSON(knownAddress)}`
+    );
+    let paseSecureChannel;
+    let discoveryData;
+    if (knownAddress !== void 0) {
+      try {
+        paseSecureChannel = await this.#initializePaseSecureChannel(knownAddress, passcode);
+      } catch (error) {
+        import_general.NoResponseTimeoutError.accept(error);
+      }
+    }
+    if (paseSecureChannel === void 0) {
+      const discoveredDevices = await import_ControllerDiscovery.ControllerDiscovery.discoverDeviceAddressesByIdentifier(
+        scannersToUse,
+        identifierData,
+        timeoutSeconds
+      );
+      const { result } = await import_ControllerDiscovery.ControllerDiscovery.iterateServerAddresses(
+        discoveredDevices,
+        import_general.NoResponseTimeoutError,
+        async () => scannersToUse.flatMap((scanner) => scanner.getDiscoveredCommissionableDevices(identifierData)),
+        async (address, device) => {
+          const channel = await this.#initializePaseSecureChannel(address, passcode, device);
+          discoveryData = device;
+          return channel;
+        }
+      );
+      paseSecureChannel = result;
+    }
+    return await this.#commissionDiscoveredNode(paseSecureChannel, commissioningOptions, discoveryData);
+  }
+  /**
+   * Method to start commission process with a PASE pairing.
+   * If this not successful and throws an RetransmissionLimitReachedError the address is invalid or the passcode
+   * is wrong.
+   */
+  async #initializePaseSecureChannel(address, passcode, device) {
+    let paseChannel;
+    if (device !== void 0) {
+      logger.info(`Commissioning device`, import_MdnsScanner.MdnsScanner.discoveryDataDiagnostics(device));
+    }
+    if (address.type === "udp") {
+      const { ip } = address;
+      const isIpv6Address = (0, import_general.isIPv6)(ip);
+      const paseInterface = this.#context.netInterfaces.interfaceFor(
+        import_general.ChannelType.UDP,
+        isIpv6Address ? "::" : "0.0.0.0"
+      );
+      if (paseInterface === void 0) {
+        throw new import_ControllerDiscovery.PairRetransmissionLimitReachedError(
+          `IPv${isIpv6Address ? "6" : "4"} interface not initialized. Cannot use ${ip} for commissioning.`
+        );
+      }
+      paseChannel = await paseInterface.openChannel(address);
+    } else {
+      const ble = this.#context.netInterfaces.interfaceFor(import_general.ChannelType.BLE);
+      if (!ble) {
+        throw new import_ControllerDiscovery.PairRetransmissionLimitReachedError(
+          `BLE interface not initialized. Cannot use ${address.peripheralAddress} for commissioning.`
+        );
+      }
+      paseChannel = await ble.openChannel(address);
+    }
+    const unsecureSession = this.#context.sessions.createInsecureSession({
+      // Use the session parameters from MDNS announcements when available and rest is assumed to be fallbacks
+      sessionParameters: {
+        idleIntervalMs: device?.SII,
+        activeIntervalMs: device?.SAI,
+        activeThresholdMs: device?.SAT
+      },
+      isInitiator: true
+    });
+    const paseUnsecureMessageChannel = new import_ExchangeManager.MessageChannel(paseChannel, unsecureSession);
+    const paseExchange = this.#context.exchanges.initiateExchangeWithChannel(
+      paseUnsecureMessageChannel,
+      import_types.SECURE_CHANNEL_PROTOCOL_ID
+    );
+    let paseSecureSession;
+    try {
+      paseSecureSession = await this.#paseClient.pair(
+        this.#context.sessions.sessionParameters,
+        paseExchange,
+        passcode
+      );
+    } catch (e) {
+      await paseExchange.close();
+      throw e;
+    }
+    await unsecureSession.destroy();
+    return new import_ExchangeManager.MessageChannel(paseChannel, paseSecureSession);
+  }
+  /**
+   * Method to commission a device with a PASE secure channel. It returns the NodeId of the commissioned device on
+   * success.
+   */
+  async #commissionDiscoveredNode(paseSecureMessageChannel, commissioningOptions, discoveryData) {
+    const { fabric, performCaseCommissioning } = commissioningOptions;
+    const address = fabric.addressOf(commissioningOptions.nodeId ?? import_types.NodeId.randomOperationalNodeId());
+    const commissioningManager = new import_ControllerCommissioningFlow.ControllerCommissioningFlow(
+      // Use the created secure session to do the commissioning
+      new import_InteractionClient.InteractionClient(new import_ExchangeManager.ExchangeProvider(this.#context.exchanges, paseSecureMessageChannel), address),
+      this.#context.certificates,
+      fabric,
+      commissioningOptions,
+      async (address2) => {
+        await paseSecureMessageChannel.close();
+        if (performCaseCommissioning !== void 0) {
+          await performCaseCommissioning(address2, discoveryData);
+          return;
+        }
+        return await this.#context.peers.connect(address2, {
+          discoveryType: import_PeerSet.NodeDiscoveryType.TimedDiscovery,
+          timeoutSeconds: 120,
+          discoveryData
+        });
+      }
+    );
+    try {
+      await commissioningManager.executeCommissioning();
+    } catch (error) {
+      await this.#context.peers.delete(address);
+      throw error;
+    }
+    return address;
+  }
+}
+//# sourceMappingURL=ControllerCommissioner.js.map

package/dist/cjs/peer/ControllerCommissioner.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/peer/ControllerCommissioner.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,oCAAuC;AACvC,mCAAqC;AACrC,qBAAiG;AAEjG,qBAUO;AACP,yBAA4B;AAC5B,yCAAiF;AACjF,iCAAyE;AACzE,6BAAkE;AAClE,qBAA2B;AAC3B,4BAA+B;AAC/B,mBAA0G;AAC1G,+BAAkC;AAElC,qBAA2C;AA9B3C;AAAA;AAAA;AAAA;AAAA;AAgCA,MAAM,SAAS,sBAAO,IAAI,kBAAkB;AAyErC,MAAM,uBAAuB;AAAA,EAChC;AAAA,EACA;AAAA,EAEA,YAAY,SAAwC;AAChD,SAAK,WAAW;AAChB,SAAK,cAAc,IAAI,0BAAW,QAAQ,QAAQ;AAAA,EACtD;AAAA,EAEA,CAAC,6BAAc,MAAM,EAAE,KAAkB;AACrC,UAAM,WAAW,IAAI,uBAAuB;AAAA,MACxC,OAAO,IAAI,IAAI,sBAAO;AAAA,MACtB,UAAU,IAAI,IAAI,yBAAU;AAAA,MAC5B,eAAe,IAAI,IAAI,8BAAe;AAAA,MACtC,UAAU,IAAI,IAAI,oCAAc;AAAA,MAChC,WAAW,IAAI,IAAI,sCAAe;AAAA,MAClC,cAAc,IAAI,IAAI,oDAAsB;AAAA,IAChD,CAAC;AACD,QAAI,IAAI,wBAAwB,QAAQ;AACxC,WAAO;AAAA,EACX;AAAA,EAEA,MAAM,WAAW,SAAyD;AACtE,UAAM;AAAA,MACF,WAAW,EAAE,iBAAiB,GAAG;AAAA,MACjC;AAAA,IACJ,IAAI;AAEJ,UAAM,uBAAuB;AAAA,MACzB,oBAAoB,kDAAqB,uBAAuB;AAAA;AAAA,MAChE,uBAAuB;AAAA,MACvB,GAAG;AAAA,IACP;AAEA,UAAM,uBACF,0BAA0B,QAAQ,YAAY,QAAQ,UAAU,uBAAuB;AAC3F,QAAI;AAAA,MACA,WAAW,EAAE,wBAAwB,CAAC,GAAG,aAAa;AAAA,IAC1D,IAAI;AACJ,QAAI,iBAAiB,oBAAoB,QAAQ,YAAY,QAAQ,UAAU,iBAAiB,CAAC;AAEjG,QACI,KAAK,SAAS,SAAS,cAAc,2BAAY,GAAG,KACpD,KAAK,SAAS,cAAc,gBAAgB,2BAAY,KAAK,IAAI,MAAM,QACzE;AACE,4BAAsB,cAAc;AAAA,IACxC;AACA,QAAI,yBAAyB,QAAW;AACpC,UAAI,EAAE,UAAU,IAAI;AACpB,UAAI,sBAAsB,QAAQ,MAAM;AACpC,gCAAwB,EAAE,aAAa,MAAM,KAAK,UAAU,KAAK,aAAW,QAAQ,SAAS,KAAK,EAAE;AAAA,MACxG,WAAW,sBAAsB,gBAAgB,MAAM;AAEnD,oBAAY,UAAU,OAAO,aAAW,QAAQ,SAAS,KAAK;AAAA,MAClE;AACA,gBAAU,KAAK,OAAM,EAAE,SAAS,QAAQ,KAAK,CAAE;AAC/C,qBAAe,UAAU,CAAC;AAC1B,UAAI,gBAAgB,wBAAwB,qBAAqB,eAAe,QAAW;AAEvF,yBAAiB,EAAE,YAAY,qBAAqB,WAAqB;AAAA,MAC7E,OAAO;AACH,yBAAiB,EAAE,mBAAmB,qBAAqB,EAAE;AAAA,MACjE;AAAA,IACJ;AAEA,UAAM,gBAAgB,KAAK,SAAS,SAAS,OAAO,qBAAqB;AAEzE,WAAO;AAAA,MACH,wCAAwC,sBAAO,OAAO,cAAc,CAAC,QACjE,cAAc,MAClB,8BAA8B,sBAAO,OAAO,YAAY,CAAC;AAAA,IAC7D;AAGA,QAAI;AACJ,QAAI;AAGJ,QAAI,iBAAiB,QAAW;AAC5B,UAAI;AACA,4BAAoB,MAAM,KAAK,6BAA6B,cAAc,QAAQ;AAAA,MACtF,SAAS,OAAO;AACZ,8CAAuB,OAAO,KAAK;AAAA,MACvC;AAAA,IACJ;AACA,QAAI,sBAAsB,QAAW;AACjC,YAAM,oBAAoB,MAAM,+CAAoB;AAAA,QAChD;AAAA,QACA;AAAA,QACA;AAAA,MACJ;AAEA,YAAM,EAAE,OAAO,IAAI,MAAM,+CAAoB;AAAA,QACzC;AAAA,QACA;AAAA,QACA,YACI,cAAc,QAAQ,aAAW,QAAQ,mCAAmC,cAAc,CAAC;AAAA,QAC/F,OAAO,SAAS,WAAW;AACvB,gBAAM,UAAU,MAAM,KAAK,6BAA6B,SAAS,UAAU,MAAM;AACjF,0BAAgB;AAChB,iBAAO;AAAA,QACX;AAAA,MACJ;AAGA,0BAAoB;AAAA,IACxB;AAEA,WAAO,MAAM,KAAK,0BAA0B,mBAAmB,sBAAsB,aAAa;AAAA,EACtG;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,6BACF,SACA,UACA,QACuB;AACvB,QAAI;AACJ,QAAI,WAAW,QAAW;AACtB,aAAO,KAAK,wBAAwB,+BAAY,yBAAyB,MAAM,CAAC;AAAA,IACpF;AACA,QAAI,QAAQ,SAAS,OAAO;AACxB,YAAM,EAAE,GAAG,IAAI;AAEf,YAAM,oBAAgB,uBAAO,EAAE;AAC/B,YAAM,gBAAgB,KAAK,SAAS,cAAc;AAAA,QAC9C,2BAAY;AAAA,QACZ,gBAAgB,OAAO;AAAA,MAC3B;AACA,UAAI,kBAAkB,QAAW;AAE7B,cAAM,IAAI;AAAA,UACN,MAAM,gBAAgB,MAAM,GAAG,0CAA0C,EAAE;AAAA,QAC/E;AAAA,MACJ;AACA,oBAAc,MAAM,cAAc,YAAY,OAAO;AAAA,IACzD,OAAO;AACH,YAAM,MAAM,KAAK,SAAS,cAAc,aAAa,2BAAY,GAAG;AACpE,UAAI,CAAC,KAAK;AACN,cAAM,IAAI;AAAA,UACN,6CAA6C,QAAQ,iBAAiB;AAAA,QAC1E;AAAA,MACJ;AAEA,oBAAc,MAAM,IAAI,YAAY,OAAO;AAAA,IAC/C;AAGA,UAAM,kBAAkB,KAAK,SAAS,SAAS,sBAAsB;AAAA;AAAA,MAEjE,mBAAmB;AAAA,QACf,gBAAgB,QAAQ;AAAA,QACxB,kBAAkB,QAAQ;AAAA,QAC1B,mBAAmB,QAAQ;AAAA,MAC/B;AAAA,MACA,aAAa;AAAA,IACjB,CAAC;AACD,UAAM,6BAA6B,IAAI,sCAAe,aAAa,eAAe;AAClF,UAAM,eAAe,KAAK,SAAS,UAAU;AAAA,MACzC;AAAA,MACA;AAAA,IACJ;AAEA,QAAI;AACJ,QAAI;AACA,0BAAoB,MAAM,KAAK,YAAY;AAAA,QACvC,KAAK,SAAS,SAAS;AAAA,QACvB;AAAA,QACA;AAAA,MACJ;AAAA,IACJ,SAAS,GAAG;AAER,YAAM,aAAa,MAAM;AACzB,YAAM;AAAA,IACV;AAEA,UAAM,gBAAgB,QAAQ;AAC9B,WAAO,IAAI,sCAAe,aAAa,iBAAiB;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,0BACF,0BACA,sBACA,eACoB;AACpB,UAAM,EAAE,QAAQ,yBAAyB,IAAI;AA8B7C,UAAM,UAAU,OAAO,UAAU,qBAAqB,UAAU,oBAAO,wBAAwB,CAAC;AAChG,UAAM,uBAAuB,IAAI;AAAA;AAAA,MAE7B,IAAI,2CAAkB,IAAI,wCAAiB,KAAK,SAAS,WAAW,wBAAwB,GAAG,OAAO;AAAA,MACtG,KAAK,SAAS;AAAA,MACd;AAAA,MACA;AAAA,MACA,OAAMA,aAAW;AAUb,cAAM,yBAAyB,MAAM;AAErC,YAAI,6BAA6B,QAAW;AACxC,gBAAM,yBAAyBA,UAAS,aAAa;AACrD;AAAA,QACJ;AAGA,eAAO,MAAM,KAAK,SAAS,MAAM,QAAQA,UAAS;AAAA,UAC9C,eAAe,iCAAkB;AAAA,UACjC,gBAAgB;AAAA,UAChB;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ;AAEA,QAAI;AACA,YAAM,qBAAqB,qBAAqB;AAAA,IACpD,SAAS,OAAO;AAEZ,YAAM,KAAK,SAAS,MAAM,OAAO,OAAO;AACxC,YAAM;AAAA,IACV;AAEA,WAAO;AAAA,EACX;AACJ;",
+  "names": ["address"]
+}

package/dist/cjs/peer/ControllerCommissioningFlow.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { GeneralCommissioning } from "#clusters/general-commissioning";
+import { MatterError } from "#general";
+import { VendorId } from "#types";
+import { RootCertificateManager } from "../certificate/RootCertificateManager.js";
+import { Fabric } from "../fabric/Fabric.js";
+import { InteractionClient } from "../interaction/InteractionClient.js";
+import { PeerAddress } from "./PeerAddress.js";
+/**
+ * User specific options for the Commissioning process
+ */
+export type ControllingCommissioningFlowOptions = {
+    /**
+     * The regulatory location (indoor or outdoor) where the device is used.
+     */
+    regulatoryLocation: GeneralCommissioning.RegulatoryLocationType;
+    /**
+     * The country where the device is used.
+     */
+    regulatoryCountryCode: string;
+    /**
+     * The vendor ID we present as a commissioner.
+     */
+    adminVendorId?: VendorId;
+    /**
+     * Required credentials if the device is to connect to a wifi network provide the credentials here.
+     */
+    wifiNetwork?: {
+        wifiSsid: string;
+        wifiCredentials: string;
+    };
+    /**
+     * If the device should connect to a thread network.
+     */
+    threadNetwork?: {
+        networkName: string;
+        operationalDataset: string;
+    };
+};
+/** Result code of a single commissioning step. */
+declare enum CommissioningStepResultCode {
+    Success = 0,
+    Failure = 1,
+    Skipped = 2,
+    Stop = 3
+}
+/**
+ * Result of a single commissioning step
+ * Breadcrump value is stored for each step for transparency
+ */
+type CommissioningStepResult = {
+    code: CommissioningStepResultCode;
+    breadcrumb: number;
+};
+/** Error that throws when Commissioning fails and process cannot be continued. */
+export declare class CommissioningError extends MatterError {
+}
+/**
+ * Class to abstract the Device commission flow in a step wise way as defined in Specs. The specs are not 100%
+ */
+export declare class ControllerCommissioningFlow {
+    #private;
+    constructor(
+    /** InteractionClient for the initiated PASE session */
+    interactionClient: InteractionClient, 
+    /** CertificateManager of the controller. */
+    certificateManager: RootCertificateManager, 
+    /** Fabric of the controller. */
+    fabric: Fabric, 
+    /** Commissioning options for the commissioning process. */
+    commissioningOptions: ControllingCommissioningFlowOptions, 
+    /** Callback that establishes CASE connection or handles final commissioning */
+    transitionToCase: (peerAddress: PeerAddress) => Promise<InteractionClient | undefined>);
+    /**
+     * Execute the commissioning process in the defined order. The steps are sorted before execution based on the step
+     * number and sub step number.
+     * If >50% of the failsafe time has passed, the failsafe timer is re-armed (50% of 60s default are 30s and each
+     * action is allowed to take 30s at minimum based on specs).
+     */
+    executeCommissioning(): Promise<void>;
+    getCommissioningStepResult(stepNumber: number, subStepNumber: number): CommissioningStepResult | undefined;
+}
+export {};
+//# sourceMappingURL=ControllerCommissioningFlow.d.ts.map

package/dist/cjs/peer/ControllerCommissioningFlow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ControllerCommissioningFlow.d.ts","sourceRoot":"","sources":["../../../src/peer/ControllerCommissioningFlow.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAIvE,OAAO,EAAsC,WAAW,EAA6B,MAAM,UAAU,CAAC;AACtG,OAAO,EAOH,QAAQ,EACX,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAIlF,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAC9C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB,CAAC,sBAAsB,CAAC;IAEhE;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;CACL,CAAC;AAQF,kDAAkD;AAClD,aAAK,2BAA2B;IAC5B,OAAO,IAAA;IACP,OAAO,IAAA;IACP,OAAO,IAAA;IACP,IAAI,IAAA;CACP;AAED;;;GAGG;AACH,KAAK,uBAAuB,GAAG;IAC3B,IAAI,EAAE,2BAA2B,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC;AAqCF,kFAAkF;AAClF,qBAAa,kBAAmB,SAAQ,WAAW;CAAG;AAOtD;;GAEG;AACH,qBAAa,2BAA2B;;;IAiBhC,uDAAuD;IACvD,iBAAiB,EAAE,iBAAiB;IAEpC,4CAA4C;IAC5C,kBAAkB,EAAE,sBAAsB;IAE1C,gCAAgC;IAChC,MAAM,EAAE,MAAM;IAEd,2DAA2D;IAC3D,oBAAoB,EAAE,mCAAmC;IAEzD,+EAA+E;IAC/E,gBAAgB,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAW1F;;;;;OAKG;IACG,oBAAoB;IAiN1B,0BAA0B,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;CA4tBvE"}