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

package/dist/esm/common/FailsafeContext.js

@@ -0,0 +1,217 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { AsyncObservable, Construction, Logger, MatterFlowError, UnexpectedDataError } from "#general";
+import { CaseAuthenticatedTag, NodeId, ValidationError } from "#types";
+import { FabricBuilder } from "../fabric/Fabric.js";
+import { FailsafeTimer, MatterFabricConflictError } from "./FailsafeTimer.js";
+const logger = Logger.get("FailsafeContext");
+class MatterFabricInvalidAdminSubjectError extends MatterFlowError {
+}
+class FailsafeContext {
+  #sessions;
+  #fabrics;
+  #failsafe;
+  #construction;
+  #associatedFabric;
+  #csrSessionId;
+  #forUpdateNoc;
+  #fabricBuilder = new FabricBuilder();
+  #commissioned = AsyncObservable();
+  constructor(options) {
+    const { expiryLengthSeconds, associatedFabric, maxCumulativeFailsafeSeconds } = options;
+    this.#sessions = options.sessions;
+    this.#fabrics = options.fabrics;
+    this.#associatedFabric = options.associatedFabric;
+    this.#construction = Construction(this, async () => {
+      await Promise.resolve();
+      await this.storeEndpointState();
+      this.#failsafe = new FailsafeTimer(
+        associatedFabric,
+        expiryLengthSeconds,
+        maxCumulativeFailsafeSeconds,
+        () => this.#failSafeExpired()
+      );
+      logger.debug(`Arm failSafe timer for ${expiryLengthSeconds}s.`);
+    });
+  }
+  async extend(fabric, expiryLengthSeconds) {
+    await this.#construction;
+    await this.#failsafe?.reArm(fabric, expiryLengthSeconds);
+    if (expiryLengthSeconds > 0) {
+      logger.debug(`Extend failSafe timer for ${expiryLengthSeconds}s.`);
+    }
+  }
+  get fabricIndex() {
+    return this.#fabricBuilder.fabricIndex;
+  }
+  get construction() {
+    return this.#construction;
+  }
+  get commissioned() {
+    return this.#commissioned;
+  }
+  get associatedFabric() {
+    return this.#associatedFabric;
+  }
+  get csrSessionId() {
+    return this.#csrSessionId;
+  }
+  get forUpdateNoc() {
+    return this.#forUpdateNoc;
+  }
+  get hasRootCert() {
+    return this.#fabricBuilder.hasRootCert();
+  }
+  get rootCert() {
+    return this.#fabricBuilder.rootCert;
+  }
+  async completeCommission() {
+    if (this.#failsafe === void 0) {
+      throw new MatterFlowError("armFailSafe should be called first!");
+    }
+    this.#failsafe.complete();
+    if (this.fabricIndex !== void 0) {
+      await this.#fabrics.persistFabrics();
+    }
+    this.#failsafe = void 0;
+    await this.commissioned.emit();
+    await this.removePaseSession();
+    await this.close();
+  }
+  getFailSafeContext() {
+    if (this.#failsafe === void 0) throw new MatterFlowError("armFailSafe should be called first!");
+    return this.#failsafe;
+  }
+  getNextFabricIndex() {
+    return this.#fabrics.getNextFabricIndex();
+  }
+  async addFabric(fabric) {
+    this.#fabrics.addFabric(fabric);
+    if (this.#failsafe !== void 0) {
+      this.#associatedFabric = this.#failsafe.associatedFabric = fabric;
+    }
+    return fabric.fabricIndex;
+  }
+  async updateFabric(fabric) {
+    await this.#fabrics.updateFabric(fabric);
+    await this.#sessions.deleteResumptionRecordsForFabric(fabric);
+  }
+  /**
+   * Handles a CSR from OperationalCredentials cluster and stores additional internal information for further
+   * validity checks.
+   */
+  createCertificateSigningRequest(isForUpdateNoc, sessionId) {
+    if (this.#fabrics.findByKeypair(this.#fabricBuilder.keyPair)) {
+      throw new MatterFlowError("Key pair already exists.");
+    }
+    const result = this.#fabricBuilder.createCertificateSigningRequest();
+    this.#csrSessionId = sessionId;
+    this.#forUpdateNoc = isForUpdateNoc;
+    return result;
+  }
+  async removePaseSession() {
+    const session = this.#sessions.getPaseSession();
+    if (session) {
+      await session.close(true);
+    }
+  }
+  async close() {
+    await this.#construction;
+    await this.#construction.close(async () => {
+      if (this.#failsafe) {
+        await this.#failsafe.close();
+        this.#failsafe = void 0;
+        await this.rollback();
+      }
+    });
+  }
+  /** Handles adding a trusted root certificate from Operational Credentials cluster. */
+  setRootCert(rootCert) {
+    this.#fabricBuilder.setRootCert(rootCert);
+  }
+  /**
+   * Build a new Fabric object based on an existing fabric for the "UpdateNoc" case of the Operational Credentials
+   * cluster.
+   */
+  async buildUpdatedFabric(nocValue, icacValue) {
+    if (this.associatedFabric === void 0) {
+      throw new MatterFlowError("No fabric associated with failsafe context, but we prepare an Fabric update.");
+    }
+    this.#fabricBuilder.initializeFromFabricForUpdate(this.associatedFabric);
+    this.#fabricBuilder.setOperationalCert(nocValue, icacValue);
+    return await this.#fabricBuilder.build(this.associatedFabric.fabricIndex);
+  }
+  /** Build a new Fabric object for a new fabric for the "AddNoc" case of the Operational Credentials cluster. */
+  async buildFabric(nocData) {
+    const builder = this.#fabricBuilder;
+    const { nocValue, icacValue, adminVendorId, ipkValue, caseAdminSubject } = nocData;
+    if (!NodeId.isOperationalNodeId(caseAdminSubject) && !NodeId.isCaseAuthenticatedTag(caseAdminSubject)) {
+      try {
+        if (CaseAuthenticatedTag.getVersion(NodeId.extractAsCaseAuthenticatedTag(caseAdminSubject)) === 0) {
+          throw new MatterFabricInvalidAdminSubjectError();
+        }
+      } catch (error) {
+        if (error instanceof ValidationError || error instanceof UnexpectedDataError) {
+          throw new MatterFabricInvalidAdminSubjectError();
+        } else {
+          throw error;
+        }
+      }
+    }
+    builder.setOperationalCert(nocValue, icacValue);
+    const fabricAlreadyExisting = this.#fabrics.getFabrics().find((fabric) => builder.matchesToFabric(fabric));
+    if (fabricAlreadyExisting) {
+      throw new MatterFabricConflictError(
+        `Fabric with Id ${builder.fabricId} and Node Id ${builder.nodeId} already exists.`
+      );
+    }
+    return builder.setRootVendorId(adminVendorId).setIdentityProtectionKey(ipkValue).setRootNodeId(caseAdminSubject).build(this.#fabrics.getNextFabricIndex());
+  }
+  async #failSafeExpired() {
+    logger.info("Failsafe timer expired, Reset fabric builder.");
+    await this.close();
+  }
+  async rollback() {
+    if (this.fabricIndex !== void 0 && !this.#forUpdateNoc) {
+      logger.debug(`Revoking fabric with index ${this.fabricIndex}`);
+      await this.#fabrics.revokeFabric(this.fabricIndex);
+    }
+    await this.removePaseSession();
+    let fabric = void 0;
+    if (this.fabricIndex !== void 0) {
+      const fabricIndex = this.fabricIndex;
+      fabric = this.#fabrics.getFabrics().find((fabric2) => fabric2.fabricIndex === fabricIndex);
+      if (fabric !== void 0) {
+        const session = this.#sessions.getSessionForNode(fabric.addressOf(fabric.rootNodeId));
+        if (session !== void 0 && session.isSecure) {
+          await session.close(false);
+        }
+      }
+    }
+    await this.restoreNetworkState();
+    if (this.#forUpdateNoc && this.associatedFabric !== void 0) {
+      await this.restoreFabric(this.associatedFabric);
+    }
+    if (!this.#forUpdateNoc && fabric !== void 0) {
+      const fabricIndex = this.fabricIndex;
+      if (fabricIndex !== void 0) {
+        const fabric2 = this.#fabrics.getFabrics().find((fabric3) => fabric3.fabricIndex === fabricIndex);
+        if (fabric2 !== void 0) {
+          await this.revokeFabric(fabric2);
+        }
+      }
+    }
+    await this.restoreBreadcrumb();
+  }
+  async restoreFabric(fabric) {
+    await this.updateFabric(fabric);
+  }
+}
+export {
+  FailsafeContext,
+  MatterFabricInvalidAdminSubjectError
+};
+//# sourceMappingURL=FailsafeContext.js.map

package/dist/esm/common/FailsafeContext.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/common/FailsafeContext.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,SAAS,iBAAiB,cAAc,QAAQ,iBAAiB,2BAA2B;AAC5F,SAAS,sBAAsB,QAAQ,uBAAiC;AACxE,SAAiB,qBAAqB;AAGtC,SAAS,eAAe,iCAAiC;AAEzD,MAAM,SAAS,OAAO,IAAI,iBAAiB;AAEpC,MAAM,6CAA6C,gBAAgB;AAAC;AAWpE,MAAe,gBAAgB;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,iBAAiB,IAAI,cAAc;AAAA,EAEnC,gBAAgB,gBAA0B;AAAA,EAE1C,YAAY,SAAkC;AAC1C,UAAM,EAAE,qBAAqB,kBAAkB,6BAA6B,IAAI;AAEhF,SAAK,YAAY,QAAQ;AACzB,SAAK,WAAW,QAAQ;AACxB,SAAK,oBAAoB,QAAQ;AAEjC,SAAK,gBAAgB,aAAa,MAAM,YAAY;AAEhD,YAAM,QAAQ,QAAQ;AAEtB,YAAM,KAAK,mBAAmB;AAI9B,WAAK,YAAY,IAAI;AAAA,QACjB;AAAA,QACA;AAAA,QACA;AAAA,QACA,MAAM,KAAK,iBAAiB;AAAA,MAChC;AACA,aAAO,MAAM,0BAA0B,mBAAmB,IAAI;AAAA,IAClE,CAAC;AAAA,EACL;AAAA,EAEA,MAAM,OAAO,QAA4B,qBAA6B;AAClE,UAAM,KAAK;AACX,UAAM,KAAK,WAAW,MAAM,QAAQ,mBAAmB;AACvD,QAAI,sBAAsB,GAAG;AACzB,aAAO,MAAM,6BAA6B,mBAAmB,IAAI;AAAA,IACrE;AAAA,EACJ;AAAA,EAEA,IAAI,cAAc;AACd,WAAO,KAAK,eAAe;AAAA,EAC/B;AAAA,EAEA,IAAI,eAAe;AACf,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,eAAe;AACf,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,mBAAmB;AACnB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,eAAe;AACf,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,eAAe;AACf,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,cAAc;AACd,WAAO,KAAK,eAAe,YAAY;AAAA,EAC3C;AAAA,EAEA,IAAI,WAAW;AACX,WAAO,KAAK,eAAe;AAAA,EAC/B;AAAA,EAEA,MAAM,qBAAqB;AAEvB,QAAI,KAAK,cAAc,QAAW;AAC9B,YAAM,IAAI,gBAAgB,qCAAqC;AAAA,IACnE;AACA,SAAK,UAAU,SAAS;AAExB,QAAI,KAAK,gBAAgB,QAAW;AAChC,YAAM,KAAK,SAAS,eAAe;AAAA,IACvC;AAEA,SAAK,YAAY;AAGjB,UAAM,KAAK,aAAa,KAAK;AAK7B,UAAM,KAAK,kBAAkB;AAE7B,UAAM,KAAK,MAAM;AAAA,EACrB;AAAA,EAEA,qBAAqB;AACjB,QAAI,KAAK,cAAc,OAAW,OAAM,IAAI,gBAAgB,qCAAqC;AACjG,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,qBAAqB;AACjB,WAAO,KAAK,SAAS,mBAAmB;AAAA,EAC5C;AAAA,EAEA,MAAM,UAAU,QAAgB;AAC5B,SAAK,SAAS,UAAU,MAAM;AAC9B,QAAI,KAAK,cAAc,QAAW;AAC9B,WAAK,oBAAoB,KAAK,UAAU,mBAAmB;AAAA,IAC/D;AACA,WAAO,OAAO;AAAA,EAClB;AAAA,EAEA,MAAM,aAAa,QAAgB;AAC/B,UAAM,KAAK,SAAS,aAAa,MAAM;AACvC,UAAM,KAAK,UAAU,iCAAiC,MAAM;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gCAAgC,gBAAyB,WAAmB;AACxE,QAAI,KAAK,SAAS,cAAc,KAAK,eAAe,OAAO,GAAG;AAC1D,YAAM,IAAI,gBAAgB,0BAA0B;AAAA,IACxD;AAEA,UAAM,SAAS,KAAK,eAAe,gCAAgC;AACnE,SAAK,gBAAgB;AACrB,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACX;AAAA,EAEA,MAAM,oBAAoB;AACtB,UAAM,UAAU,KAAK,UAAU,eAAe;AAC9C,QAAI,SAAS;AACT,YAAM,QAAQ,MAAM,IAAI;AAAA,IAC5B;AAAA,EACJ;AAAA,EAEA,MAAM,QAAQ;AACV,UAAM,KAAK;AACX,UAAM,KAAK,cAAc,MAAM,YAAY;AACvC,UAAI,KAAK,WAAW;AAChB,cAAM,KAAK,UAAU,MAAM;AAC3B,aAAK,YAAY;AACjB,cAAM,KAAK,SAAS;AAAA,MACxB;AAAA,IACJ,CAAC;AAAA,EACL;AAAA;AAAA,EAGA,YAAY,UAAsB;AAC9B,SAAK,eAAe,YAAY,QAAQ;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,mBAAmB,UAAsB,WAAmC;AAC9E,QAAI,KAAK,qBAAqB,QAAW;AACrC,YAAM,IAAI,gBAAgB,8EAA8E;AAAA,IAC5G;AACA,SAAK,eAAe,8BAA8B,KAAK,gBAAgB;AACvE,SAAK,eAAe,mBAAmB,UAAU,SAAS;AAC1D,WAAO,MAAM,KAAK,eAAe,MAAM,KAAK,iBAAiB,WAAW;AAAA,EAC5E;AAAA;AAAA,EAGA,MAAM,YAAY,SAMf;AACC,UAAM,UAAU,KAAK;AAErB,UAAM,EAAE,UAAU,WAAW,eAAe,UAAU,iBAAiB,IAAI;AAG3E,QAAI,CAAC,OAAO,oBAAoB,gBAAgB,KAAK,CAAC,OAAO,uBAAuB,gBAAgB,GAAG;AACnG,UAAI;AACA,YAAI,qBAAqB,WAAW,OAAO,8BAA8B,gBAAgB,CAAC,MAAM,GAAG;AAC/F,gBAAM,IAAI,qCAAqC;AAAA,QACnD;AAAA,MACJ,SAAS,OAAO;AAEZ,YAAI,iBAAiB,mBAAmB,iBAAiB,qBAAqB;AAC1E,gBAAM,IAAI,qCAAqC;AAAA,QACnD,OAAO;AACH,gBAAM;AAAA,QACV;AAAA,MACJ;AAAA,IACJ;AAEA,YAAQ,mBAAmB,UAAU,SAAS;AAC9C,UAAM,wBAAwB,KAAK,SAAS,WAAW,EAAE,KAAK,YAAU,QAAQ,gBAAgB,MAAM,CAAC;AAEvG,QAAI,uBAAuB;AACvB,YAAM,IAAI;AAAA,QACN,kBAAkB,QAAQ,QAAQ,gBAAgB,QAAQ,MAAM;AAAA,MACpE;AAAA,IACJ;AAEA,WAAO,QACF,gBAAgB,aAAa,EAC7B,yBAAyB,QAAQ,EACjC,cAAc,gBAAgB,EAC9B,MAAM,KAAK,SAAS,mBAAmB,CAAC;AAAA,EACjD;AAAA,EAEA,MAAM,mBAAmB;AACrB,WAAO,KAAK,+CAA+C;AAE3D,UAAM,KAAK,MAAM;AAAA,EACrB;AAAA,EAEA,MAAgB,WAAW;AACvB,QAAI,KAAK,gBAAgB,UAAa,CAAC,KAAK,eAAe;AACvD,aAAO,MAAM,8BAA8B,KAAK,WAAW,EAAE;AAC7D,YAAM,KAAK,SAAS,aAAa,KAAK,WAAW;AAAA,IACrD;AAIA,UAAM,KAAK,kBAAkB;AAK7B,QAAI,SAA6B;AACjC,QAAI,KAAK,gBAAgB,QAAW;AAChC,YAAM,cAAc,KAAK;AACzB,eAAS,KAAK,SAAS,WAAW,EAAE,KAAK,CAAAA,YAAUA,QAAO,gBAAgB,WAAW;AACrF,UAAI,WAAW,QAAW;AACtB,cAAM,UAAU,KAAK,UAAU,kBAAkB,OAAO,UAAU,OAAO,UAAU,CAAC;AACpF,YAAI,YAAY,UAAa,QAAQ,UAAU;AAC3C,gBAAM,QAAQ,MAAM,KAAK;AAAA,QAC7B;AAAA,MACJ;AAAA,IACJ;AAIA,UAAM,KAAK,oBAAoB;AAK/B,QAAI,KAAK,iBAAiB,KAAK,qBAAqB,QAAW;AAE3D,YAAM,KAAK,cAAc,KAAK,gBAAgB;AAAA,IAClD;AAIA,QAAI,CAAC,KAAK,iBAAiB,WAAW,QAAW;AAC7C,YAAM,cAAc,KAAK;AACzB,UAAI,gBAAgB,QAAW;AAC3B,cAAMA,UAAS,KAAK,SAAS,WAAW,EAAE,KAAK,CAAAA,YAAUA,QAAO,gBAAgB,WAAW;AAC3F,YAAIA,YAAW,QAAW;AACtB,gBAAM,KAAK,aAAaA,OAAM;AAAA,QAClC;AAAA,MACJ;AAAA,IACJ;AAGA,UAAM,KAAK,kBAAkB;AAAA,EAKjC;AAAA,EAOA,MAAM,cAAc,QAAgB;AAChC,UAAM,KAAK,aAAa,MAAM;AAAA,EAClC;AAKJ;",
+  "names": ["fabric"]
+}

package/dist/esm/common/FailsafeTimer.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MatterFlowError } from "#general";
+import { Fabric } from "../fabric/Fabric.js";
+export declare class MatterFabricConflictError extends MatterFlowError {
+}
+/**
+ * Manages the failsafe timer associated with a {@link FailsafeContext}.
+ */
+export declare class FailsafeTimer {
+    #private;
+    associatedFabric: Fabric | undefined;
+    constructor(associatedFabric: Fabric | undefined, expiryLengthSeconds: number, maxCumulativeFailsafeSeconds: number, expiryCallback: () => Promise<void>);
+    close(): Promise<void>;
+    /** Handle "Re-Arming" an existing FailSafe context to extend the timer, expire or fail if not allowed. */
+    reArm(associatedFabric: Fabric | undefined, expiryLengthSeconds: number): Promise<void>;
+    /** Expire the FailSafe context. This is called by the timer and can also be called manually if needed. */
+    expire(): Promise<void>;
+    /** Complete the FailSafe context. This is called when the commissioning is completed. */
+    complete(): void;
+}
+//# sourceMappingURL=FailsafeTimer.d.ts.map

package/dist/esm/common/FailsafeTimer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FailsafeTimer.d.ts","sourceRoot":"","sources":["../../../src/common/FailsafeTimer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAU,eAAe,EAAe,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAG7C,qBAAa,yBAA0B,SAAQ,eAAe;CAAG;AAIjE;;GAEG;AACH,qBAAa,aAAa;;IAMX,gBAAgB,EAAE,MAAM,GAAG,SAAS;gBAApC,gBAAgB,EAAE,MAAM,GAAG,SAAS,EAC3C,mBAAmB,EAAE,MAAM,EAC3B,4BAA4B,EAAE,MAAM,EACpC,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC;IAWjC,KAAK;IASX,0GAA0G;IACpG,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,EAAE,mBAAmB,EAAE,MAAM;IA0B7E,0GAA0G;IACpG,MAAM;IAKZ,yFAAyF;IACzF,QAAQ;CAUX"}

package/dist/esm/common/FailsafeTimer.js

@@ -0,0 +1,71 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Logger, MatterFlowError, Time } from "#general";
+class MatterFabricConflictError extends MatterFlowError {
+}
+const logger = Logger.get("FailsafeTimer");
+class FailsafeTimer {
+  constructor(associatedFabric, expiryLengthSeconds, maxCumulativeFailsafeSeconds, expiryCallback) {
+    this.associatedFabric = associatedFabric;
+    this.#expiryCallback = expiryCallback;
+    this.#failsafeTimer = this.#startFailsafeTimer(expiryLengthSeconds);
+    this.#maxCumulativeFailsafeTimer = Time.getTimer(
+      "Max cumulative failsafe",
+      maxCumulativeFailsafeSeconds * 1e3,
+      () => this.expire()
+    ).start();
+  }
+  #expiryCallback;
+  #failsafeTimer;
+  #maxCumulativeFailsafeTimer;
+  async close() {
+    if (this.#failsafeTimer.isRunning) {
+      this.#failsafeTimer.stop();
+    }
+    if (this.#maxCumulativeFailsafeTimer.isRunning) {
+      this.#maxCumulativeFailsafeTimer.stop();
+    }
+  }
+  /** Handle "Re-Arming" an existing FailSafe context to extend the timer, expire or fail if not allowed. */
+  async reArm(associatedFabric, expiryLengthSeconds) {
+    if (!this.#failsafeTimer.isRunning) {
+      throw new MatterFlowError("FailSafe already expired.");
+    }
+    if (this.associatedFabric?.fabricIndex !== associatedFabric?.fabricIndex) {
+      throw new MatterFlowError(
+        `FailSafe already armed (index=${this.associatedFabric?.fabricIndex}) with different fabric (index=${associatedFabric?.fabricIndex}).`
+      );
+    }
+    this.#failsafeTimer.stop();
+    if (expiryLengthSeconds === 0) {
+      await this.expire();
+    } else {
+      this.#failsafeTimer = this.#startFailsafeTimer(expiryLengthSeconds);
+    }
+  }
+  /** Expire the FailSafe context. This is called by the timer and can also be called manually if needed. */
+  async expire() {
+    this.complete();
+    await this.#expiryCallback();
+  }
+  /** Complete the FailSafe context. This is called when the commissioning is completed. */
+  complete() {
+    this.#failsafeTimer.stop();
+    this.#maxCumulativeFailsafeTimer.stop();
+  }
+  #startFailsafeTimer(expiryLengthSeconds) {
+    return Time.getTimer(
+      "Failsafe expiration",
+      expiryLengthSeconds * 1e3,
+      () => this.expire().catch((e) => logger.error("Error during failsafe expiration", e))
+    ).start();
+  }
+}
+export {
+  FailsafeTimer,
+  MatterFabricConflictError
+};
+//# sourceMappingURL=FailsafeTimer.js.map

package/dist/esm/common/FailsafeTimer.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/common/FailsafeTimer.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,SAAS,QAAQ,iBAAiB,YAAmB;AAI9C,MAAM,kCAAkC,gBAAgB;AAAC;AAEhE,MAAM,SAAS,OAAO,IAAI,eAAe;AAKlC,MAAM,cAAc;AAAA,EAKvB,YACW,kBACP,qBACA,8BACA,gBACF;AAJS;AAKP,SAAK,kBAAkB;AACvB,SAAK,iBAAiB,KAAK,oBAAoB,mBAAmB;AAClE,SAAK,8BAA8B,KAAK;AAAA,MACpC;AAAA,MACA,+BAA+B;AAAA,MAC/B,MAAM,KAAK,OAAO;AAAA,IACtB,EAAE,MAAM;AAAA,EACZ;AAAA,EAjBA;AAAA,EACA;AAAA,EACA;AAAA,EAiBA,MAAM,QAAQ;AACV,QAAI,KAAK,eAAe,WAAW;AAC/B,WAAK,eAAe,KAAK;AAAA,IAC7B;AACA,QAAI,KAAK,4BAA4B,WAAW;AAC5C,WAAK,4BAA4B,KAAK;AAAA,IAC1C;AAAA,EACJ;AAAA;AAAA,EAGA,MAAM,MAAM,kBAAsC,qBAA6B;AAC3E,QAAI,CAAC,KAAK,eAAe,WAAW;AAChC,YAAM,IAAI,gBAAgB,2BAA2B;AAAA,IACzD;AAEA,QAAI,KAAK,kBAAkB,gBAAgB,kBAAkB,aAAa;AACtE,YAAM,IAAI;AAAA,QACN,iCAAiC,KAAK,kBAAkB,WAAW,kCAAkC,kBAAkB,WAAW;AAAA,MACtI;AAAA,IACJ;AAEA,SAAK,eAAe,KAAK;AAEzB,QAAI,wBAAwB,GAAG;AAI3B,YAAM,KAAK,OAAO;AAAA,IACtB,OAAO;AAIH,WAAK,iBAAiB,KAAK,oBAAoB,mBAAmB;AAAA,IACtE;AAAA,EACJ;AAAA;AAAA,EAGA,MAAM,SAAS;AACX,SAAK,SAAS;AACd,UAAM,KAAK,gBAAgB;AAAA,EAC/B;AAAA;AAAA,EAGA,WAAW;AACP,SAAK,eAAe,KAAK;AACzB,SAAK,4BAA4B,KAAK;AAAA,EAC1C;AAAA,EAEA,oBAAoB,qBAA6B;AAC7C,WAAO,KAAK;AAAA,MAAS;AAAA,MAAuB,sBAAsB;AAAA,MAAM,MACpE,KAAK,OAAO,EAAE,MAAM,OAAK,OAAO,MAAM,oCAAoC,CAAC,CAAC;AAAA,IAChF,EAAE,MAAM;AAAA,EACZ;AACJ;",
+  "names": []
+}

package/dist/esm/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/esm/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"}