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

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

@@ -0,0 +1,79 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { AsyncObservable, Construction, MatterFlowError } from "#general";
+import { NodeId, VendorId } from "#types";
+import { Fabric } from "../fabric/Fabric.js";
+import { FabricManager } from "../fabric/FabricManager.js";
+import { SessionManager } from "../session/SessionManager.js";
+import { FailsafeTimer } from "./FailsafeTimer.js";
+export declare class MatterFabricInvalidAdminSubjectError extends MatterFlowError {
+}
+/**
+ * A "timed operation" is a command or sequence of commands that operate with a failsafe timer that will abort the
+ * operation if it does not complete within a specific window.
+ *
+ * FailsafeContext maintains the failsafe timer and tracks information required to rollback state if the operation
+ * aborts.
+ *
+ * Timed operations are exclusive for a node.
+ */
+export declare abstract class FailsafeContext {
+    #private;
+    constructor(options: FailsafeContext.Options);
+    extend(fabric: Fabric | undefined, expiryLengthSeconds: number): Promise<void>;
+    get fabricIndex(): import("#types").FabricIndex | undefined;
+    get construction(): Construction<FailsafeContext>;
+    get commissioned(): AsyncObservable<[], void>;
+    get associatedFabric(): Fabric | undefined;
+    get csrSessionId(): number | undefined;
+    get forUpdateNoc(): boolean | undefined;
+    get hasRootCert(): boolean;
+    get rootCert(): Uint8Array | undefined;
+    completeCommission(): Promise<void>;
+    getFailSafeContext(): FailsafeTimer;
+    getNextFabricIndex(): import("#types").FabricIndex;
+    addFabric(fabric: Fabric): Promise<import("#types").FabricIndex>;
+    updateFabric(fabric: Fabric): Promise<void>;
+    /**
+     * Handles a CSR from OperationalCredentials cluster and stores additional internal information for further
+     * validity checks.
+     */
+    createCertificateSigningRequest(isForUpdateNoc: boolean, sessionId: number): Uint8Array;
+    removePaseSession(): Promise<void>;
+    close(): Promise<void>;
+    /** Handles adding a trusted root certificate from Operational Credentials cluster. */
+    setRootCert(rootCert: Uint8Array): void;
+    /**
+     * Build a new Fabric object based on an existing fabric for the "UpdateNoc" case of the Operational Credentials
+     * cluster.
+     */
+    buildUpdatedFabric(nocValue: Uint8Array, icacValue: Uint8Array | undefined): Promise<Fabric>;
+    /** Build a new Fabric object for a new fabric for the "AddNoc" case of the Operational Credentials cluster. */
+    buildFabric(nocData: {
+        nocValue: Uint8Array;
+        icacValue: Uint8Array | undefined;
+        adminVendorId: VendorId;
+        ipkValue: Uint8Array;
+        caseAdminSubject: NodeId;
+    }): Promise<Fabric>;
+    protected rollback(): Promise<void>;
+    abstract storeEndpointState(): Promise<void>;
+    /** Restore Cluster data when the FailSafe context expired. */
+    abstract restoreNetworkState(): Promise<void>;
+    restoreFabric(fabric: Fabric): Promise<void>;
+    abstract revokeFabric(fabric: Fabric): Promise<void>;
+    abstract restoreBreadcrumb(): Promise<void>;
+}
+export declare namespace FailsafeContext {
+    interface Options {
+        sessions: SessionManager;
+        fabrics: FabricManager;
+        expiryLengthSeconds: number;
+        maxCumulativeFailsafeSeconds: number;
+        associatedFabric: Fabric | undefined;
+    }
+}
+//# sourceMappingURL=FailsafeContext.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FailsafeContext.d.ts","sourceRoot":"","sources":["../../../src/common/FailsafeContext.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAU,eAAe,EAAuB,MAAM,UAAU,CAAC;AACvG,OAAO,EAAwB,MAAM,EAAmB,QAAQ,EAAE,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAE,MAAM,EAAiB,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAA6B,MAAM,oBAAoB,CAAC;AAI9E,qBAAa,oCAAqC,SAAQ,eAAe;CAAG;AAE5E;;;;;;;;GAQG;AACH,8BAAsB,eAAe;;gBAYrB,OAAO,EAAE,eAAe,CAAC,OAAO;IAyBtC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,mBAAmB,EAAE,MAAM;IAQpE,IAAI,WAAW,6CAEd;IAED,IAAI,YAAY,kCAEf;IAED,IAAI,YAAY,8BAEf;IAED,IAAI,gBAAgB,uBAEnB;IAED,IAAI,YAAY,uBAEf;IAED,IAAI,YAAY,wBAEf;IAED,IAAI,WAAW,YAEd;IAED,IAAI,QAAQ,2BAEX;IAEK,kBAAkB;IAwBxB,kBAAkB;IAKlB,kBAAkB;IAIZ,SAAS,CAAC,MAAM,EAAE,MAAM;IAQxB,YAAY,CAAC,MAAM,EAAE,MAAM;IAKjC;;;OAGG;IACH,+BAA+B,CAAC,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM;IAWpE,iBAAiB;IAOjB,KAAK;IAWX,sFAAsF;IACtF,WAAW,CAAC,QAAQ,EAAE,UAAU;IAIhC;;;OAGG;IACG,kBAAkB,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,GAAG,SAAS;IAShF,+GAA+G;IACzG,WAAW,CAAC,OAAO,EAAE;QACvB,QAAQ,EAAE,UAAU,CAAC;QACrB,SAAS,EAAE,UAAU,GAAG,SAAS,CAAC;QAClC,aAAa,EAAE,QAAQ,CAAC;QACxB,QAAQ,EAAE,UAAU,CAAC;QACrB,gBAAgB,EAAE,MAAM,CAAC;KAC5B;cA2Ce,QAAQ;IAyDxB,QAAQ,CAAC,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAE5C,8DAA8D;IAC9D,QAAQ,CAAC,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEvC,aAAa,CAAC,MAAM,EAAE,MAAM;IAIlC,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEpD,QAAQ,CAAC,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,eAAe,CAAC;IAC7B,UAAiB,OAAO;QACpB,QAAQ,EAAE,cAAc,CAAC;QACzB,OAAO,EAAE,aAAa,CAAC;QACvB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,4BAA4B,EAAE,MAAM,CAAC;QACrC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;KACxC;CACJ"}

package/dist/cjs/common/FailsafeContext.js

@@ -0,0 +1,237 @@
+"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 FailsafeContext_exports = {};
+__export(FailsafeContext_exports, {
+  FailsafeContext: () => FailsafeContext,
+  MatterFabricInvalidAdminSubjectError: () => MatterFabricInvalidAdminSubjectError
+});
+module.exports = __toCommonJS(FailsafeContext_exports);
+var import_general = require("#general");
+var import_types = require("#types");
+var import_Fabric = require("../fabric/Fabric.js");
+var import_FailsafeTimer = require("./FailsafeTimer.js");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const logger = import_general.Logger.get("FailsafeContext");
+class MatterFabricInvalidAdminSubjectError extends import_general.MatterFlowError {
+}
+class FailsafeContext {
+  #sessions;
+  #fabrics;
+  #failsafe;
+  #construction;
+  #associatedFabric;
+  #csrSessionId;
+  #forUpdateNoc;
+  #fabricBuilder = new import_Fabric.FabricBuilder();
+  #commissioned = (0, import_general.AsyncObservable)();
+  constructor(options) {
+    const { expiryLengthSeconds, associatedFabric, maxCumulativeFailsafeSeconds } = options;
+    this.#sessions = options.sessions;
+    this.#fabrics = options.fabrics;
+    this.#associatedFabric = options.associatedFabric;
+    this.#construction = (0, import_general.Construction)(this, async () => {
+      await Promise.resolve();
+      await this.storeEndpointState();
+      this.#failsafe = new import_FailsafeTimer.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 import_general.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 import_general.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 import_general.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 import_general.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 (!import_types.NodeId.isOperationalNodeId(caseAdminSubject) && !import_types.NodeId.isCaseAuthenticatedTag(caseAdminSubject)) {
+      try {
+        if (import_types.CaseAuthenticatedTag.getVersion(import_types.NodeId.extractAsCaseAuthenticatedTag(caseAdminSubject)) === 0) {
+          throw new MatterFabricInvalidAdminSubjectError();
+        }
+      } catch (error) {
+        if (error instanceof import_types.ValidationError || error instanceof import_general.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 import_FailsafeTimer.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);
+  }
+}
+//# sourceMappingURL=FailsafeContext.js.map

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

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/common/FailsafeContext.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,qBAA4F;AAC5F,mBAAwE;AACxE,oBAAsC;AAGtC,2BAAyD;AAXzD;AAAA;AAAA;AAAA;AAAA;AAaA,MAAM,SAAS,sBAAO,IAAI,iBAAiB;AAEpC,MAAM,6CAA6C,+BAAgB;AAAC;AAWpE,MAAe,gBAAgB;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,iBAAiB,IAAI,4BAAc;AAAA,EAEnC,oBAAgB,gCAA0B;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,oBAAgB,6BAAa,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,+BAAgB,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,+BAAgB,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,+BAAgB,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,+BAAgB,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,oBAAO,oBAAoB,gBAAgB,KAAK,CAAC,oBAAO,uBAAuB,gBAAgB,GAAG;AACnG,UAAI;AACA,YAAI,kCAAqB,WAAW,oBAAO,8BAA8B,gBAAgB,CAAC,MAAM,GAAG;AAC/F,gBAAM,IAAI,qCAAqC;AAAA,QACnD;AAAA,MACJ,SAAS,OAAO;AAEZ,YAAI,iBAAiB,gCAAmB,iBAAiB,oCAAqB;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/cjs/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/cjs/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/cjs/common/FailsafeTimer.js

@@ -0,0 +1,91 @@
+"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 FailsafeTimer_exports = {};
+__export(FailsafeTimer_exports, {
+  FailsafeTimer: () => FailsafeTimer,
+  MatterFabricConflictError: () => MatterFabricConflictError
+});
+module.exports = __toCommonJS(FailsafeTimer_exports);
+var import_general = require("#general");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+class MatterFabricConflictError extends import_general.MatterFlowError {
+}
+const logger = import_general.Logger.get("FailsafeTimer");
+class FailsafeTimer {
+  constructor(associatedFabric, expiryLengthSeconds, maxCumulativeFailsafeSeconds, expiryCallback) {
+    this.associatedFabric = associatedFabric;
+    this.#expiryCallback = expiryCallback;
+    this.#failsafeTimer = this.#startFailsafeTimer(expiryLengthSeconds);
+    this.#maxCumulativeFailsafeTimer = import_general.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 import_general.MatterFlowError("FailSafe already expired.");
+    }
+    if (this.associatedFabric?.fabricIndex !== associatedFabric?.fabricIndex) {
+      throw new import_general.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 import_general.Time.getTimer(
+      "Failsafe expiration",
+      expiryLengthSeconds * 1e3,
+      () => this.expire().catch((e) => logger.error("Error during failsafe expiration", e))
+    ).start();
+  }
+}
+//# sourceMappingURL=FailsafeTimer.js.map

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

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/common/FailsafeTimer.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,qBAAqD;AANrD;AAAA;AAAA;AAAA;AAAA;AAUO,MAAM,kCAAkC,+BAAgB;AAAC;AAEhE,MAAM,SAAS,sBAAO,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,oBAAK;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,+BAAgB,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,oBAAK;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": []
+}