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

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningBehavior.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+import { GeneralCommissioning } from "#clusters/general-commissioning";
+import { ClusterBehavior } from "../../behavior/cluster/ClusterBehavior.js";
+import { GeneralCommissioningInterface } from "./GeneralCommissioningInterface.js";
+/**
+ * GeneralCommissioningBehavior is the base class for objects that support interaction with {@link
+ * GeneralCommissioning.Cluster}.
+ */
+export declare const GeneralCommissioningBehavior: ClusterBehavior.Type<GeneralCommissioning.Cluster, ClusterBehavior.Type<import("@matter/types").ClusterType.Of<{
+    readonly id: 0;
+    readonly revision: 0;
+    readonly name: "Unknown";
+    readonly attributes: {};
+    readonly commands: {};
+    readonly events: {};
+}>, typeof ClusterBehavior, GeneralCommissioningInterface>, GeneralCommissioningInterface>;
+type GeneralCommissioningBehaviorType = InstanceType<typeof GeneralCommissioningBehavior>;
+export interface GeneralCommissioningBehavior extends GeneralCommissioningBehaviorType {
+}
+type StateType = InstanceType<typeof GeneralCommissioningBehavior.State>;
+export declare namespace GeneralCommissioningBehavior {
+    interface State extends StateType {
+    }
+}
+export {};
+//# sourceMappingURL=GeneralCommissioningBehavior.d.ts.map

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningBehavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeneralCommissioningBehavior.d.ts","sourceRoot":"","sources":["../../../../src/behaviors/general-commissioning/GeneralCommissioningBehavior.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAEnF;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;;;;;;0FAEH,CAAC;AAEvC,KAAK,gCAAgC,GAAG,YAAY,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAC1F,MAAM,WAAW,4BAA6B,SAAQ,gCAAgC;CAAG;AACzF,KAAK,SAAS,GAAG,YAAY,CAAC,OAAO,4BAA4B,CAAC,KAAK,CAAC,CAAC;AACzE,yBAAiB,4BAA4B,CAAC;IAAE,UAAiB,KAAM,SAAQ,SAAS;KAAG;CAAE"}

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningBehavior.js

@@ -0,0 +1,32 @@
+"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 GeneralCommissioningBehavior_exports = {};
+__export(GeneralCommissioningBehavior_exports, {
+  GeneralCommissioningBehavior: () => GeneralCommissioningBehavior
+});
+module.exports = __toCommonJS(GeneralCommissioningBehavior_exports);
+var import_general_commissioning = require("#clusters/general-commissioning");
+var import_ClusterBehavior = require("../../behavior/cluster/ClusterBehavior.js");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const GeneralCommissioningBehavior = import_ClusterBehavior.ClusterBehavior.withInterface().for(import_general_commissioning.GeneralCommissioning.Cluster);
+//# sourceMappingURL=GeneralCommissioningBehavior.js.map

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningBehavior.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/behaviors/general-commissioning/GeneralCommissioningBehavior.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,mCAAqC;AACrC,6BAAgC;AAThC;AAAA;AAAA;AAAA;AAAA;AAgBO,MAAM,+BAA+B,uCACvC,cAA6C,EAC7C,IAAI,kDAAqB,OAAO;",
+  "names": []
+}

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningInterface.d.ts

@@ -0,0 +1,235 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+import { MaybePromise } from "#general";
+import { GeneralCommissioning } from "#clusters/general-commissioning";
+export declare namespace GeneralCommissioningInterface {
+    interface Base {
+        /**
+         * Success or failure of this command shall be communicated by the ArmFailSafeResponse command, unless some
+         * data model validations caused a failure status code to be issued during the processing of the command.
+         *
+         * If the fail-safe timer is not currently armed, the commissioning window is open, and the command was
+         * received over a CASE session, the command shall leave the current fail-safe state unchanged and immediately
+         * respond with an ArmFailSafeResponse containing an ErrorCode value of BusyWithOtherAdmin. This is done to
+         * allow commissioners, which use PASE connections, the opportunity to use the failsafe during the relatively
+         * short commissioning window.
+         *
+         * Otherwise, the command shall arm or re-arm the "fail-safe timer" with an expiry time set for a duration of
+         * ExpiryLengthSeconds, or disarm it, depending on the situation:
+         *
+         *   • If ExpiryLengthSeconds is 0 and the fail-safe timer was already armed and the accessing fabric matches
+         *     the Fabric currently associated with the fail-safe context, then the fail-safe timer
+         *
+         * shall be immediately expired (see further below for side-effects of expiration).
+         *
+         *   • If ExpiryLengthSeconds is 0 and the fail-safe timer was not armed, then this command invocation shall
+         *     lead to a success response with no side-effects against the fail-safe context.
+         *
+         *   • If ExpiryLengthSeconds is non-zero and the fail-safe timer was not currently armed, then the fail-safe
+         *     timer shall be armed for that duration.
+         *
+         *   • If ExpiryLengthSeconds is non-zero and the fail-safe timer was currently armed, and the accessing Fabric
+         *     matches the fail-safe context’s associated Fabric, then the fail-safe timer shall be re- armed to expire
+         *     in ExpiryLengthSeconds.
+         *
+         *   • Otherwise, the command shall leave the current fail-safe state unchanged and immediately respond with
+         *     ArmFailSafeResponse containing an ErrorCode value of BusyWithOtherAdmin, indicating a likely conflict
+         *     between commissioners.
+         *
+         * The value of the Breadcrumb field shall be written to the Breadcrumb Attribute on successful execution of
+         * the command.
+         *
+         * If the receiver restarts unexpectedly (e.g., power interruption, software crash, or other reset) the
+         * receiver shall behave as if the fail-safe timer expired and perform the sequence of clean-up steps listed
+         * below.
+         *
+         * On successful execution of the command, the ErrorCode field of the ArmFailSafeResponse shall be set to OK.
+         *
+         * ### Fail Safe Context
+         *
+         * When first arming the fail-safe timer, a 'Fail Safe Context' shall be created on the receiver, to track the
+         * following state information while the fail-safe is armed:
+         *
+         *   • The fail-safe timer duration.
+         *
+         *   • The state of all Network Commissioning Networks attribute configurations, to allow recovery of
+         *     connectivity after Fail-Safe expiry.
+         *
+         *   • Whether an AddNOC command or UpdateNOC command has taken place.
+         *
+         *   • A Fabric Index for the fabric-scoping of the context, starting at the accessing fabric index for the
+         *     ArmFailSafe command, and updated with the Fabric Index associated with an AddNOC command or an UpdateNOC
+         *     command being invoked successfully during the ongoing Fail-Safe timer period.
+         *
+         *   • The operational credentials associated with any Fabric whose configuration is affected by the UpdateNOC
+         *     command.
+         *
+         *   • Optionally: the previous state of non-fabric-scoped data that is mutated during the fail-safe period.
+         *
+         * Note the following to assist in understanding the above state-keeping, which summarizes other normative
+         * requirements in the respective sections:
+         *
+         *   • The AddNOC command can only be invoked once per contiguous non-expiring fail-safe timer period, and only
+         *     if no UpdateNOC command was previously processed within the same fail-safe timer period.
+         *
+         *   • The UpdateNOC command can only be invoked once per contiguous non-expiring fail-safe timer period, can
+         *     only be invoked over a CASE session, and only if no AddNOC command was previously processed in the same
+         *     fail-safe timer period.
+         *
+         * On creation of the Fail Safe Context a second timer shall be created to expire at
+         * MaxCumulativeFailsafeSeconds as specified in BasicCommissioningInfo. This Cumulative Fail Safe Context timer
+         * (CFSC timer) serves to limit the lifetime of any particular Fail Safe Context; it shall NOT be extended or
+         * modified on subsequent invocations of ArmFailSafe associated with this Fail Safe Context. Upon expiry of the
+         * CFSC timer, the receiver shall execute cleanup behavior equivalent to that of fail-safe timer expiration as
+         * detailed in Section 11.10.6.2.2, “Behavior on expiry of Fail-Safe timer”. Termination of the session prior
+         * to the expiration of that timer for any reason (including a successful end of commissioning or an expiry of
+         * a fail-safe timer) shall also delete the CFSC timer.
+         *
+         * ### Behavior on expiry of Fail-Safe timer
+         *
+         * If the fail-safe timer expires before the CommissioningComplete command is successfully invoked, the
+         * following sequence of clean-up steps shall be executed, in order, by the receiver:
+         *
+         *   1. Terminate any open PASE secure session by clearing any associated Secure Session Context at the Server.
+         *
+         *   2. Revoke the temporary administrative privileges granted to any open PASE session (see Section 6.6.2.8,
+         *       “Bootstrapping of the Access Control Cluster”) at the Server.
+         *
+         *   3. If an AddNOC or UpdateNOC command has been successfully invoked, terminate all CASE sessions associated
+         *       with the Fabric whose Fabric Index is recorded in the Fail-Safe context (see Section 11.10.6.2,
+         *       “ArmFailSafe Command”) by clearing any associated Secure Session Context at the Server.
+         *
+         *   4. Reset the configuration of all Network Commissioning Networks attribute to their state prior to the
+         *       Fail-Safe being armed.
+         *
+         *   5. If an UpdateNOC command had been successfully invoked, revert the state of operational key pair, NOC
+         *       and ICAC for that Fabric to the state prior to the Fail-Safe timer being armed, for the Fabric Index
+         *       that was the subject of the UpdateNOC command.
+         *
+         *   6. If an AddNOC command had been successfully invoked, achieve the equivalent effect of invoking the
+         *       RemoveFabric command against the Fabric Index stored in the Fail-Safe Context for the Fabric Index
+         *       that was the subject of the AddNOC command. This shall remove all associations to that Fabric
+         *       including all fabric-scoped data, and may possibly factory-reset the device depending on current
+         *       device state. This shall only apply to Fabrics added during the fail-safe period as the result of the
+         *       AddNOC command.
+         *
+         *   7. If the CSRRequest command had been successfully invoked, but no AddNOC or UpdateNOC command had been
+         *       successfully invoked, then the new operational key pair temporarily generated for the purposes of NOC
+         *       addition or update (see Node Operational CSR Procedure) shall be removed as it is no longer needed.
+         *
+         *   8. Remove any RCACs added by the AddTrustedRootCertificate command that are not currently referenced by
+         *       any entry in the Fabrics attribute.
+         *
+         *   9. Reset the Breadcrumb attribute to zero.
+         *
+         *   10. Optionally: if no factory-reset resulted from the previous steps, it is recommended that the
+         *
+         * Node rollback the state of all non fabric-scoped data present in the Fail-Safe context.
+         *
+         * @see {@link MatterSpecification.v13.Core} § 11.10.6.2
+         */
+        armFailSafe(request: GeneralCommissioning.ArmFailSafeRequest): MaybePromise<GeneralCommissioning.ArmFailSafeResponse>;
+        /**
+         * This shall add or update the regulatory configuration in the RegulatoryConfig Attribute to the value
+         * provided in the NewRegulatoryConfig field.
+         *
+         * Success or failure of this command shall be communicated by the SetRegulatoryConfigResponse command, unless
+         * some data model validations caused a failure status code to be issued during the processing of the command.
+         *
+         * The CountryCode field shall conforms to ISO 3166-1 alpha-2 and shall be used to set the Location attribute
+         * reflected by the Basic Information Cluster.
+         *
+         * If the server limits some of the values (e.g. locked to a particular country, with no regulatory data for
+         * others), then setting regulatory information outside a valid country or location shall still set the
+         * Location attribute reflected by the Basic Information Cluster configuration, but the
+         * SetRegulatoryConfigResponse replied shall have the ErrorCode field set to ValueOutsideRange error.
+         *
+         * If the LocationCapability attribute is not Indoor/Outdoor and the NewRegulatoryConfig value received does
+         * not match either the Indoor or Outdoor fixed value in LocationCapability, then the
+         * SetRegulatoryConfigResponse replied shall have the ErrorCode field set to ValueOutsideRange error and the
+         * RegulatoryConfig attribute and associated internal radio configuration shall remain unchanged.
+         *
+         * If the LocationCapability attribute is set to Indoor/Outdoor, then the RegulatoryConfig attribute shall be
+         * set to match the NewRegulatoryConfig field.
+         *
+         * On successful execution of the command, the ErrorCode field of the SetRegulatoryConfigResponse shall be set
+         * to OK.
+         *
+         * The Breadcrumb field shall be used to atomically set the Breadcrumb attribute on success of this command,
+         * when SetRegulatoryConfigResponse has the ErrorCode field set to OK. If the command fails, the Breadcrumb
+         * attribute shall be left unchanged.
+         *
+         * @see {@link MatterSpecification.v13.Core} § 11.10.6.4
+         */
+        setRegulatoryConfig(request: GeneralCommissioning.SetRegulatoryConfigRequest): MaybePromise<GeneralCommissioning.SetRegulatoryConfigResponse>;
+        /**
+         * This command has no data.
+         *
+         * Success or failure of this command shall be communicated by the CommissioningCompleteResponse command,
+         * unless some data model validations caused a failure status code to be issued during the processing of the
+         * command.
+         *
+         * This command signals the Server that the Commissioner or Administrator has successfully completed all steps
+         * needed during the Fail-Safe period, such as commissioning (see Section 5.5, “Commissioning Flows”) or other
+         * Administrator operations requiring usage of the Fail Safe timer. It ensures that the Server is configured in
+         * a state such that it still has all necessary elements to be fully operable within a Fabric, such as ACL
+         * entries (see Access Control Cluster) and operational credentials (see Section 6.4, “Node Operational
+         * Credentials Specification”), and that the Node is reach
+         *
+         * able using CASE (see Section 4.14.2, “Certificate Authenticated Session Establishment (CASE)”) over an
+         * operational network.
+         *
+         * An ErrorCode of NoFailSafe shall be responded to the invoker if the CommissioningComplete command was
+         * received when no Fail-Safe context exists.
+         *
+         * This command is fabric-scoped, so cannot be issued over a session that does not have an associated fabric,
+         * i.e. over PASE session prior to an AddNOC command. In addition, this command is only permitted over CASE and
+         * must be issued by a node associated with the ongoing Fail-Safe context. An ErrorCode of
+         * InvalidAuthentication shall be responded to the invoker if the CommissioningComplete command was received
+         * outside a CASE session (e.g., over Group messaging, or PASE session after AddNOC), or if the accessing
+         * fabric is not the one associated with the ongoing Fail-Safe context.
+         *
+         * This command shall only result in success with an ErrorCode value of OK in the CommissioningCompleteResponse
+         * if received over a CASE session and the accessing fabric index matches the Fabric Index associated with the
+         * current Fail-Safe context. In other words:
+         *
+         *   • If no AddNOC command had been successfully invoked, the CommissioningComplete command must originate
+         *     from the Fabric that initiated the Fail-Safe context.
+         *
+         *   • After an AddNOC command has been successfully invoked, the CommissioningComplete command must originate
+         *     from the Fabric which was joined through the execution of that command, which updated the Fail-Safe
+         *     context’s Fabric Index.
+         *
+         * On successful execution of the CommissioningComplete command, where the CommissioningCompleteResponse has an
+         * ErrorCode of OK, the following actions shall be undertaken on the Server:
+         *
+         *   1. The Fail-Safe timer associated with the current Fail-Safe context shall be disarmed.
+         *
+         *   2. The commissioning window at the Server shall be closed.
+         *
+         *   3. Any temporary administrative privileges automatically granted to any open PASE session shall be revoked
+         *      (see Section 6.6.2.8, “Bootstrapping of the Access Control Cluster”).
+         *
+         *   4. The Secure Session Context of any PASE session still established at the Server shall be cleared.
+         *
+         *   5. The Breadcrumb attribute shall be reset to zero.
+         *
+         * After receipt of a CommissioningCompleteResponse with an ErrorCode value of OK, a client cannot expect any
+         * previously established PASE session to still be usable, due to the server having cleared such sessions.
+         *
+         * @see {@link MatterSpecification.v13.Core} § 11.10.6.6
+         */
+        commissioningComplete(): MaybePromise<GeneralCommissioning.CommissioningCompleteResponse>;
+    }
+}
+export type GeneralCommissioningInterface = {
+    components: [{
+        flags: {};
+        methods: GeneralCommissioningInterface.Base;
+    }];
+};
+//# sourceMappingURL=GeneralCommissioningInterface.d.ts.map

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeneralCommissioningInterface.d.ts","sourceRoot":"","sources":["../../../../src/behaviors/general-commissioning/GeneralCommissioningInterface.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,yBAAiB,6BAA6B,CAAC;IAC3C,UAAiB,IAAI;QACjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2HG;QACH,WAAW,CAAC,OAAO,EAAE,oBAAoB,CAAC,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;QAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,CAAC,0BAA0B,GAAG,YAAY,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;QAE9I;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwDG;QACH,qBAAqB,IAAI,YAAY,CAAC,oBAAoB,CAAC,6BAA6B,CAAC,CAAC;KAC7F;CACJ;AAED,MAAM,MAAM,6BAA6B,GAAG;IAAE,UAAU,EAAE,CAAC;QAAE,KAAK,EAAE,EAAE,CAAC;QAAC,OAAO,EAAE,6BAA6B,CAAC,IAAI,CAAA;KAAE,CAAC,CAAA;CAAE,CAAC"}

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningInterface.js

@@ -0,0 +1,22 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 GeneralCommissioningInterface_exports = {};
+module.exports = __toCommonJS(GeneralCommissioningInterface_exports);
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+//# sourceMappingURL=GeneralCommissioningInterface.js.map

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningInterface.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/behaviors/general-commissioning/GeneralCommissioningInterface.ts"],
+  "mappings": ";;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;",
+  "names": []
+}

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningServer.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { GeneralCommissioning } from "#clusters/general-commissioning";
+import { GeneralCommissioningBehavior } from "./GeneralCommissioningBehavior.js";
+/**
+ * This is the default server implementation of GeneralCommissioningBehavior.
+ */
+export declare class GeneralCommissioningServer extends GeneralCommissioningBehavior {
+    state: GeneralCommissioningServer.State;
+    initialize(): void;
+    armFailSafe({ breadcrumb, expiryLengthSeconds }: GeneralCommissioning.ArmFailSafeRequest): Promise<{
+        errorCode: GeneralCommissioning.CommissioningError;
+        debugText: string;
+    }>;
+    setRegulatoryConfig({ breadcrumb, newRegulatoryConfig, countryCode, }: GeneralCommissioning.SetRegulatoryConfigRequest): Promise<{
+        errorCode: GeneralCommissioning.CommissioningError;
+        debugText: string;
+    }>;
+    commissioningComplete(): Promise<{
+        errorCode: GeneralCommissioning.CommissioningError;
+        debugText: string;
+    }>;
+}
+export declare namespace GeneralCommissioningServer {
+    class State extends GeneralCommissioningBehavior.State {
+        /**
+         * Set to false to prevent the controller from changing the country code during commissioning.
+         */
+        allowCountryCodeChange: boolean;
+        /**
+         * Set to an array of two-letter country codes to limit the countries the controller may assign.
+         */
+        countryCodeWhitelist?: string[];
+    }
+}
+//# sourceMappingURL=GeneralCommissioningServer.d.ts.map

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeneralCommissioningServer.d.ts","sourceRoot":"","sources":["../../../../src/behaviors/general-commissioning/GeneralCommissioningServer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAIvE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAMjF;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,4BAA4B;IAChE,KAAK,EAAE,0BAA0B,CAAC,KAAK,CAAC;IAEvC,UAAU;IAgBJ,WAAW,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,EAAE,oBAAoB,CAAC,kBAAkB;;;;IAsDxF,mBAAmB,CAAC,EAC/B,UAAU,EACV,mBAAmB,EACnB,WAAW,GACd,EAAE,oBAAoB,CAAC,0BAA0B;;;;IAyEnC,qBAAqB;;;;CA2CvC;AAED,yBAAiB,0BAA0B,CAAC;IAGxC,MAAa,KAAM,SAAQ,4BAA4B,CAAC,KAAK;QACzD;;WAEG;QACH,sBAAsB,UAAQ;QAE9B;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAa;KAC/C;CACJ"}

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningServer.js

@@ -0,0 +1,183 @@
+"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 GeneralCommissioningServer_exports = {};
+__export(GeneralCommissioningServer_exports, {
+  GeneralCommissioningServer: () => GeneralCommissioningServer
+});
+module.exports = __toCommonJS(GeneralCommissioningServer_exports);
+var import_administrator_commissioning = require("#behaviors/administrator-commissioning");
+var import_basic_information = require("#behaviors/basic-information");
+var import_administrator_commissioning2 = require("#clusters/administrator-commissioning");
+var import_general_commissioning = require("#clusters/general-commissioning");
+var import_general = require("#general");
+var import_protocol = require("#protocol");
+var import_GeneralCommissioningBehavior = require("./GeneralCommissioningBehavior.js");
+var import_ServerNodeFailsafeContext = require("./ServerNodeFailsafeContext.js");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const SuccessResponse = { errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.Ok, debugText: "" };
+const logger = import_general.Logger.get("GeneralCommissioningClusterHandler");
+class GeneralCommissioningServer extends import_GeneralCommissioningBehavior.GeneralCommissioningBehavior {
+  initialize() {
+    const bci = this.state.basicCommissioningInfo;
+    if (bci.failSafeExpiryLengthSeconds === void 0) {
+      bci.failSafeExpiryLengthSeconds = 60;
+    }
+    if (bci.maxCumulativeFailsafeSeconds === void 0) {
+      bci.maxCumulativeFailsafeSeconds = 900;
+    }
+    this.state.breadcrumb = 0;
+  }
+  async armFailSafe({ breadcrumb, expiryLengthSeconds }) {
+    (0, import_protocol.assertSecureSession)(this.session, "armFailSafe can only be called on a secure session");
+    const commissioner = this.env.get(import_protocol.DeviceCommissioner);
+    try {
+      if (!commissioner.isFailsafeArmed && this.agent.get(import_administrator_commissioning.AdministratorCommissioningServer).state.windowStatus !== import_administrator_commissioning2.AdministratorCommissioning.CommissioningWindowStatus.WindowNotOpen && !this.session.isPase) {
+        throw new import_general.MatterFlowError("Failed to arm failsafe using CASE while commissioning window is opened.");
+      }
+      if (commissioner.isFailsafeArmed) {
+        await commissioner.failsafeContext.extend(this.session.fabric, expiryLengthSeconds);
+      } else {
+        if (expiryLengthSeconds === 0) return SuccessResponse;
+        await commissioner.beginTimed(
+          new import_ServerNodeFailsafeContext.ServerNodeFailsafeContext(this.endpoint, {
+            fabrics: this.env.get(import_protocol.FabricManager),
+            sessions: this.env.get(import_protocol.SessionManager),
+            expiryLengthSeconds,
+            maxCumulativeFailsafeSeconds: this.state.basicCommissioningInfo.maxCumulativeFailsafeSeconds,
+            associatedFabric: this.session.fabric
+          })
+        );
+      }
+      if (commissioner.isFailsafeArmed) {
+        this.state.breadcrumb = breadcrumb;
+      }
+    } catch (error) {
+      import_general.MatterFlowError.accept(error);
+      logger.debug(`Error while arming failSafe timer`, error);
+      return {
+        errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.BusyWithOtherAdmin,
+        debugText: error.message
+      };
+    }
+    return SuccessResponse;
+  }
+  async setRegulatoryConfig({
+    breadcrumb,
+    newRegulatoryConfig,
+    countryCode
+  }) {
+    const locationCapabilityValue = this.state.locationCapability;
+    const basicInformation = this.agent.get(import_basic_information.BasicInformationServer);
+    const currentLocationCountryCode = basicInformation.state.location;
+    if (currentLocationCountryCode !== countryCode) {
+      if (this.state.allowCountryCodeChange === false && countryCode !== "XX") {
+        return {
+          errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.ValueOutsideRange,
+          debugText: `Country code change not allowed: ${countryCode}`
+        };
+      }
+      if (this.state.countryCodeWhitelist !== void 0 && !this.state.countryCodeWhitelist.includes(countryCode)) {
+        return {
+          errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.ValueOutsideRange,
+          debugText: `Country code change not allowed: ${countryCode}`
+        };
+      }
+      if (countryCode !== "XX") {
+        basicInformation.state.location = countryCode;
+      }
+    }
+    let validValues;
+    switch (locationCapabilityValue) {
+      case import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Outdoor:
+        validValues = [import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Outdoor];
+        break;
+      case import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Indoor:
+        validValues = [import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Indoor];
+        break;
+      case import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.IndoorOutdoor:
+        validValues = [
+          import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Indoor,
+          import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Outdoor,
+          import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.IndoorOutdoor
+        ];
+        break;
+      default:
+        return {
+          errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.ValueOutsideRange,
+          debugText: `Invalid regulatory location: ${newRegulatoryConfig === import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Indoor ? "Indoor" : "Outdoor"}`
+        };
+    }
+    if (!validValues.includes(newRegulatoryConfig)) {
+      return {
+        errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.ValueOutsideRange,
+        debugText: `Invalid regulatory location: ${newRegulatoryConfig === import_general_commissioning.GeneralCommissioning.RegulatoryLocationType.Indoor ? "Indoor" : "Outdoor"}`
+      };
+    }
+    this.asAdmin(() => {
+      this.state.regulatoryConfig = newRegulatoryConfig;
+    });
+    this.state.breadcrumb = breadcrumb;
+    return SuccessResponse;
+  }
+  async commissioningComplete() {
+    if (this.session.isPase) {
+      return {
+        errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.InvalidAuthentication,
+        debugText: "Command not executed over CASE session."
+      };
+    }
+    const fabric = this.session.associatedFabric;
+    const commissioner = this.env.get(import_protocol.DeviceCommissioner);
+    if (!commissioner.isFailsafeArmed) {
+      return { errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.NoFailSafe, debugText: "FailSafe not armed." };
+    }
+    const failsafeContext = commissioner.failsafeContext;
+    (0, import_protocol.assertSecureSession)(this.session, "commissioningComplete can only be called on a secure session");
+    const timedFabric = failsafeContext.associatedFabric?.fabricIndex;
+    if (fabric.fabricIndex !== timedFabric) {
+      return {
+        errorCode: import_general_commissioning.GeneralCommissioning.CommissioningError.InvalidAuthentication,
+        debugText: `Associated fabric ${fabric.fabricIndex} does not match the one from the failsafe context ${timedFabric}.`
+      };
+    }
+    await failsafeContext.completeCommission();
+    this.state.breadcrumb = BigInt(0);
+    logger.info(`Commissioning completed on fabric #${fabric.fabricId} as node #${fabric.nodeId}.`);
+    return SuccessResponse;
+  }
+}
+((GeneralCommissioningServer2) => {
+  class State extends import_GeneralCommissioningBehavior.GeneralCommissioningBehavior.State {
+    /**
+     * Set to false to prevent the controller from changing the country code during commissioning.
+     */
+    allowCountryCodeChange = true;
+    // Default true if not set
+    /**
+     * Set to an array of two-letter country codes to limit the countries the controller may assign.
+     */
+    countryCodeWhitelist = void 0;
+  }
+  GeneralCommissioningServer2.State = State;
+})(GeneralCommissioningServer || (GeneralCommissioningServer = {}));
+//# sourceMappingURL=GeneralCommissioningServer.js.map

package/dist/cjs/behaviors/general-commissioning/GeneralCommissioningServer.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/behaviors/general-commissioning/GeneralCommissioningServer.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,yCAAiD;AACjD,+BAAuC;AACvC,IAAAA,sCAA2C;AAC3C,mCAAqC;AACrC,qBAAwC;AAExC,sBAAuF;AACvF,0CAA6C;AAC7C,uCAA0C;AAd1C;AAAA;AAAA;AAAA;AAAA;AAgBA,MAAM,kBAAkB,EAAE,WAAW,kDAAqB,mBAAmB,IAAI,WAAW,GAAG;AAC/F,MAAM,SAAS,sBAAO,IAAI,oCAAoC;AAKvD,MAAM,mCAAmC,iEAA6B;AAAA,EAGhE,aAAa;AAClB,UAAM,MAAM,KAAK,MAAM;AAEvB,QAAI,IAAI,gCAAgC,QAAW;AAE/C,UAAI,8BAA8B;AAAA,IACtC;AAEA,QAAI,IAAI,iCAAiC,QAAW;AAEhD,UAAI,+BAA+B;AAAA,IACvC;AAEA,SAAK,MAAM,aAAa;AAAA,EAC5B;AAAA,EAEA,MAAe,YAAY,EAAE,YAAY,oBAAoB,GAA4C;AACrG,6CAAoB,KAAK,SAAS,oDAAoD;AACtF,UAAM,eAAe,KAAK,IAAI,IAAI,kCAAkB;AAEpD,QAAI;AAMA,UACI,CAAC,aAAa,mBACd,KAAK,MAAM,IAAI,mEAAgC,EAAE,MAAM,iBACnD,+DAA2B,0BAA0B,iBACzD,CAAC,KAAK,QAAQ,QAChB;AACE,cAAM,IAAI,+BAAgB,yEAAyE;AAAA,MACvG;AAEA,UAAI,aAAa,iBAAiB;AAC9B,cAAM,aAAa,gBAAgB,OAAO,KAAK,QAAQ,QAAQ,mBAAmB;AAAA,MACtF,OAAO;AAGH,YAAI,wBAAwB,EAAG,QAAO;AAEtC,cAAM,aAAa;AAAA,UACf,IAAI,2DAA0B,KAAK,UAAwB;AAAA,YACvD,SAAS,KAAK,IAAI,IAAI,6BAAa;AAAA,YACnC,UAAU,KAAK,IAAI,IAAI,8BAAc;AAAA,YACrC;AAAA,YACA,8BAA8B,KAAK,MAAM,uBAAuB;AAAA,YAChE,kBAAkB,KAAK,QAAQ;AAAA,UACnC,CAAC;AAAA,QACL;AAAA,MACJ;AAEA,UAAI,aAAa,iBAAiB;AAE9B,aAAK,MAAM,aAAa;AAAA,MAC5B;AAAA,IACJ,SAAS,OAAO;AACZ,qCAAgB,OAAO,KAAK;AAE5B,aAAO,MAAM,qCAAqC,KAAK;AACvD,aAAO;AAAA,QACH,WAAW,kDAAqB,mBAAmB;AAAA,QACnD,WAAW,MAAM;AAAA,MACrB;AAAA,IACJ;AAEA,WAAO;AAAA,EACX;AAAA,EAEA,MAAe,oBAAoB;AAAA,IAC/B;AAAA,IACA;AAAA,IACA;AAAA,EACJ,GAAoD;AAChD,UAAM,0BAA0B,KAAK,MAAM;AAG3C,UAAM,mBAAmB,KAAK,MAAM,IAAI,+CAAsB;AAC9D,UAAM,6BAA6B,iBAAiB,MAAM;AAE1D,QAAI,+BAA+B,aAAa;AAC5C,UAAI,KAAK,MAAM,2BAA2B,SAAS,gBAAgB,MAAM;AACrE,eAAO;AAAA,UACH,WAAW,kDAAqB,mBAAmB;AAAA,UACnD,WAAW,oCAAoC,WAAW;AAAA,QAC9D;AAAA,MACJ;AACA,UACI,KAAK,MAAM,yBAAyB,UACpC,CAAC,KAAK,MAAM,qBAAqB,SAAS,WAAW,GACvD;AACE,eAAO;AAAA,UACH,WAAW,kDAAqB,mBAAmB;AAAA,UACnD,WAAW,oCAAoC,WAAW;AAAA,QAC9D;AAAA,MACJ;AACA,UAAI,gBAAgB,MAAM;AACtB,yBAAiB,MAAM,WAAW;AAAA,MACtC;AAAA,IACJ;AAGA,QAAI;AACJ,YAAQ,yBAAyB;AAAA,MAC7B,KAAK,kDAAqB,uBAAuB;AAC7C,sBAAc,CAAC,kDAAqB,uBAAuB,OAAO;AAClE;AAAA,MACJ,KAAK,kDAAqB,uBAAuB;AAC7C,sBAAc,CAAC,kDAAqB,uBAAuB,MAAM;AACjE;AAAA,MACJ,KAAK,kDAAqB,uBAAuB;AAC7C,sBAAc;AAAA,UACV,kDAAqB,uBAAuB;AAAA,UAC5C,kDAAqB,uBAAuB;AAAA,UAC5C,kDAAqB,uBAAuB;AAAA,QAChD;AACA;AAAA,MACJ;AACI,eAAO;AAAA,UACH,WAAW,kDAAqB,mBAAmB;AAAA,UACnD,WAAW,gCACP,wBAAwB,kDAAqB,uBAAuB,SAC9D,WACA,SACV;AAAA,QACJ;AAAA,IACR;AACA,QAAI,CAAC,YAAY,SAAS,mBAAmB,GAAG;AAC5C,aAAO;AAAA,QACH,WAAW,kDAAqB,mBAAmB;AAAA,QACnD,WAAW,gCACP,wBAAwB,kDAAqB,uBAAuB,SAAS,WAAW,SAC5F;AAAA,MACJ;AAAA,IACJ;AAGA,SAAK,QAAQ,MAAM;AACf,WAAK,MAAM,mBAAmB;AAAA,IAClC,CAAC;AAED,SAAK,MAAM,aAAa;AAExB,WAAO;AAAA,EACX;AAAA,EAEA,MAAe,wBAAwB;AACnC,QAAI,KAAK,QAAQ,QAAQ;AACrB,aAAO;AAAA,QACH,WAAW,kDAAqB,mBAAmB;AAAA,QACnD,WAAW;AAAA,MACf;AAAA,IACJ;AAEA,UAAM,SAAS,KAAK,QAAQ;AAE5B,UAAM,eAAe,KAAK,IAAI,IAAI,kCAAkB;AAEpD,QAAI,CAAC,aAAa,iBAAiB;AAC/B,aAAO,EAAE,WAAW,kDAAqB,mBAAmB,YAAY,WAAW,sBAAsB;AAAA,IAC7G;AACA,UAAM,kBAAkB,aAAa;AAErC,6CAAoB,KAAK,SAAS,8DAA8D;AAEhG,UAAM,cAAc,gBAAgB,kBAAkB;AACtD,QAAI,OAAO,gBAAgB,aAAa;AACpC,aAAO;AAAA,QACH,WAAW,kDAAqB,mBAAmB;AAAA,QACnD,WAAW,qBAAqB,OAAO,WAAW,qDAAqD,WAAW;AAAA,MACtH;AAAA,IACJ;AASA,UAAM,gBAAgB,mBAAmB;AAGzC,SAAK,MAAM,aAAa,OAAO,CAAC;AAEhC,WAAO,KAAK,sCAAsC,OAAO,QAAQ,aAAa,OAAO,MAAM,GAAG;AAE9F,WAAO;AAAA,EACX;AACJ;AAAA,CAEO,CAAUC,gCAAV;AAAA,EAGI,MAAM,cAAc,iEAA6B,MAAM;AAAA;AAAA;AAAA;AAAA,IAI1D,yBAAyB;AAAA;AAAA;AAAA;AAAA;AAAA,IAKzB,uBAAkC;AAAA,EACtC;AAVO,EAAAA,4BAAM;AAAA,GAHA;",
+  "names": ["import_administrator_commissioning", "GeneralCommissioningServer"]
+}

package/dist/cjs/behaviors/general-commissioning/ServerNodeFailsafeContext.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ServerNode } from "#node/ServerNode.js";
+import { Fabric, FailsafeContext } from "#protocol";
+/**
+ * {@link FailsafeContext} for {@link ServerNode} API.
+ */
+export declare class ServerNodeFailsafeContext extends FailsafeContext {
+    #private;
+    constructor(node: ServerNode, options: FailsafeContext.Options);
+    /**
+     * Persist endpoint credentials and network configurations for restoration if commissioning does not complete.
+     *
+     * The Matter 1.2 specification makes it pretty clear that Matter supports configuration of multiple network
+     * interfaces (e.g. @see {@link MatterSpecification.v11.Core} § 11.8.8 and § 2.3.2).
+     * {@link NetworkCommissioningCluster} of the primary interface is on the root endpoint.  However it's not clear
+     * where {@link NetworkCommissioningCluster} instances for secondary interfaces reside.  To be on the safe side
+     * we just assume any endpoint may support {@link NetworkCommissioningCluster}.
+     *
+     * TODO - it's recommended to reset all state if commissioning bails; currently we perform mandatory restore
+     */
+    storeEndpointState(): Promise<void>;
+    restoreNetworkState(): Promise<void>;
+    revokeFabric(fabric: Fabric): Promise<void>;
+    restoreBreadcrumb(): Promise<void>;
+    rollback(): Promise<void>;
+}
+//# sourceMappingURL=ServerNodeFailsafeContext.d.ts.map

package/dist/cjs/behaviors/general-commissioning/ServerNodeFailsafeContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerNodeFailsafeContext.d.ts","sourceRoot":"","sources":["../../../../src/behaviors/general-commissioning/ServerNodeFailsafeContext.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAiB,eAAe,EAAE,MAAM,WAAW,CAAC;AAEnE;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,eAAe;;gBAiB9C,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,eAAe,CAAC,OAAO;IAW9D;;;;;;;;;;OAUG;IACY,kBAAkB;IAsBlB,mBAAmB;IAanB,YAAY,CAAC,MAAM,EAAE,MAAM;IAM3B,iBAAiB;IAMjB,QAAQ;CA0C1B"}