@matter/protocol 0.13.0-alpha.0-20250318-c1aa38b08 → 0.13.0-alpha.0-20250323-770919c6a

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

@@ -4,8 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { GeneralCommissioning } from "#clusters/general-commissioning";
+import { NetworkCommissioning } from "#clusters/network-commissioning";
 import { MatterError } from "#general";
-import { VendorId } from "#types";
+import { ClusterId, EndpointNumber, FabricIndex, TypeFromPartialBitSchema, TypeFromSchema, VendorId } from "#types";
 import { CertificateAuthority } from "../certificate/CertificateAuthority.js";
 import { Fabric } from "../fabric/Fabric.js";
 import { InteractionClient } from "../interaction/InteractionClient.js";
@@ -56,6 +57,42 @@ type CommissioningStepResult = {
     code: CommissioningStepResultCode;
     breadcrumb: number;
 };
+/**
+ * Definition of one commissioning step
+ * All steps are for execution sorted by stepNumber and subStepNumber
+ */
+type CommissioningStep = {
+    /** Step Number according to the specs */
+    stepNumber: number;
+    /** Order of actions within a step */
+    subStepNumber: number;
+    /** Name of the action or step */
+    name: string;
+    /** Logic function to execute */
+    stepLogic: () => Promise<CommissioningStepResult>;
+    /** Optional flag to indicate that the failsafe timer should be rearmed in any case before this step. */
+    reArmFailsafe?: boolean;
+};
+/** Data that are collected initially or through the commissioning process and can be used also by other steps. */
+type CollectedCommissioningData = {
+    basicCommissioningInfo?: TypeFromSchema<typeof GeneralCommissioning.TlvBasicCommissioningInfo>;
+    productName?: string;
+    networkFeatures?: {
+        endpointId: number;
+        value: TypeFromPartialBitSchema<typeof NetworkCommissioning.Complete.features>;
+    }[];
+    networkStatus?: {
+        endpointId: number;
+        value: TypeFromSchema<typeof NetworkCommissioning.TlvNetworkInfo>[];
+    }[];
+    rootPartsList?: EndpointNumber[];
+    rootServerList?: ClusterId[];
+    vendorId?: VendorId;
+    productId?: number;
+    supportsConcurrentConnection?: boolean;
+    successfullyConnectedToNetwork?: boolean;
+    fabricIndex?: FabricIndex;
+};
 /** Error that throws when Commissioning fails and process cannot be continued. */
 export declare class CommissioningError extends MatterError {
 }
@@ -64,6 +101,15 @@ export declare class CommissioningError extends MatterError {
  */
 export declare class ControllerCommissioningFlow {
     #private;
+    protected interactionClient: InteractionClient;
+    protected readonly ca: CertificateAuthority;
+    protected readonly fabric: Fabric;
+    protected readonly transitionToCase: (peerAddress: PeerAddress, supportsConcurrentConnections: boolean) => Promise<InteractionClient | undefined>;
+    protected readonly commissioningOptions: ControllerCommissioningFlowOptions;
+    protected readonly commissioningSteps: CommissioningStep[];
+    protected readonly commissioningStepResults: Map<string, CommissioningStepResult>;
+    protected lastBreadcrumb: number;
+    protected collectedCommissioningData: CollectedCommissioningData;
     constructor(
     /** InteractionClient for the initiated PASE session */
     interactionClient: InteractionClient, 

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

@@ -1 +1 @@
-{"version":3,"file":"ControllerCommissioningFlow.d.ts","sourceRoot":"","sources":["../../../src/peer/ControllerCommissioningFlow.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAIvE,OAAO,EAAsC,WAAW,EAA4C,MAAM,UAAU,CAAC;AACrH,OAAO,EAQH,QAAQ,EACX,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAK9E,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC7C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB,CAAC,sBAAsB,CAAC;IAEhE;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;CACL,CAAC;AAQF,kDAAkD;AAClD,aAAK,2BAA2B;IAC5B,OAAO,IAAA;IACP,OAAO,IAAA;IACP,OAAO,IAAA;IACP,IAAI,IAAA;CACP;AAED;;;GAGG;AACH,KAAK,uBAAuB,GAAG;IAC3B,IAAI,EAAE,2BAA2B,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC;AAyCF,kFAAkF;AAClF,qBAAa,kBAAmB,SAAQ,WAAW;CAAG;AAOtD;;GAEG;AACH,qBAAa,2BAA2B;;;IAoBhC,uDAAuD;IACvD,iBAAiB,EAAE,iBAAiB;IAEpC,4CAA4C;IAC5C,EAAE,EAAE,oBAAoB;IAExB,gCAAgC;IAChC,MAAM,EAAE,MAAM;IAEd,2DAA2D;IAC3D,oBAAoB,EAAE,kCAAkC;IAExD,+EAA+E;IAC/E,gBAAgB,EAAE,CACd,WAAW,EAAE,WAAW,EACxB,6BAA6B,EAAE,OAAO,KACrC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAW/C;;;;;OAKG;IACG,oBAAoB;IA0O1B,0BAA0B,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;CAszBvE"}
+{"version":3,"file":"ControllerCommissioningFlow.d.ts","sourceRoot":"","sources":["../../../src/peer/ControllerCommissioningFlow.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAGvE,OAAO,EAMH,WAAW,EAId,MAAM,UAAU,CAAC;AAClB,OAAO,EACH,SAAS,EAET,cAAc,EACd,WAAW,EAEX,wBAAwB,EACxB,cAAc,EACd,QAAQ,EACX,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAK9E,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC7C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB,CAAC,sBAAsB,CAAC;IAEhE;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;CACL,CAAC;AAQF,kDAAkD;AAClD,aAAK,2BAA2B;IAC5B,OAAO,IAAA;IACP,OAAO,IAAA;IACP,OAAO,IAAA;IACP,IAAI,IAAA;CACP;AAED;;;GAGG;AACH,KAAK,uBAAuB,GAAG;IAC3B,IAAI,EAAE,2BAA2B,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,KAAK,iBAAiB,GAAG;IACrB,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IAEnB,qCAAqC;IACrC,aAAa,EAAE,MAAM,CAAC;IAEtB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IAEb,gCAAgC;IAChC,SAAS,EAAE,MAAM,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAElD,wGAAwG;IACxG,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,kHAAkH;AAClH,KAAK,0BAA0B,GAAG;IAC9B,sBAAsB,CAAC,EAAE,cAAc,CAAC,OAAO,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;IAC/F,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,wBAAwB,CAAC,OAAO,oBAAoB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAClF,EAAE,CAAC;IACJ,aAAa,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,cAAc,CAAC,OAAO,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAA;KAAE,EAAE,CAAC;IAC9G,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC,cAAc,CAAC,EAAE,SAAS,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B,CAAC;AAEF,kFAAkF;AAClF,qBAAa,kBAAmB,SAAQ,WAAW;CAAG;AAOtD;;GAEG;AACH,qBAAa,2BAA2B;;IACpC,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC/C,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,oBAAoB,CAAC;IAC5C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CACjC,WAAW,EAAE,WAAW,EACxB,6BAA6B,EAAE,OAAO,KACrC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAC5C,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,kCAAkC,CAAC;IAC5E,SAAS,CAAC,QAAQ,CAAC,kBAAkB,sBAAkC;IACvE,SAAS,CAAC,QAAQ,CAAC,wBAAwB,uCAA8C;IAKzF,SAAS,CAAC,cAAc,SAAK;IAC7B,SAAS,CAAC,0BAA0B,EAAE,0BAA0B,CAAM;;IAIlE,uDAAuD;IACvD,iBAAiB,EAAE,iBAAiB;IAEpC,4CAA4C;IAC5C,EAAE,EAAE,oBAAoB;IAExB,gCAAgC;IAChC,MAAM,EAAE,MAAM;IAEd,2DAA2D;IAC3D,oBAAoB,EAAE,kCAAkC;IAExD,+EAA+E;IAC/E,gBAAgB,EAAE,CACd,WAAW,EAAE,WAAW,EACxB,6BAA6B,EAAE,OAAO,KACrC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAW/C;;;;;OAKG;IACG,oBAAoB;IA0O1B,0BAA0B,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;CA0zBvE"}