@matter/node 0.17.0-alpha.0-20260507-059f7763b → 0.17.0-alpha.0-20260508-29ff5ae9e

package/dist/cjs/behavior/system/commissioning/CommissioningClient.d.ts

@@ -1,332 +0,0 @@
-/**
- * @license
- * Copyright 2022-2026 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-import { Behavior } from "#behavior/Behavior.js";
-import { Events as BaseEvents } from "#behavior/Events.js";
-import type { ClientNode } from "#node/ClientNode.js";
-import { ClassExtends, Duration, Observable, ServerAddress, Timestamp } from "@matter/general";
-import type { SupportedTransportsBitmap } from "@matter/protocol";
-import { CommissioningMode, ControllerCommissioningFlow, ControllerCommissioningFlowOptions, DiscoveryData, Fabric, FabricAuthority, PeerTimingParameters, PeerAddress as ProtocolPeerAddress, SessionParameters as ProtocolSessionParameters, Subscribe } from "@matter/protocol";
-import { CaseAuthenticatedTag, DeviceTypeId, DiscoveryCapabilitiesBitmap, FabricIndex, NodeId, TypeFromPartialBitSchema, VendorId } from "@matter/types";
-import { RemoteDescriptor } from "./RemoteDescriptor.js";
-/**
- * Client functionality related to commissioning.
- *
- * Updates node state based on commissioning status and commissions new nodes.
- */
-export declare class CommissioningClient extends Behavior {
-    #private;
-    internal: CommissioningClient.Internal;
-    readonly state: CommissioningClient.State;
-    readonly events: CommissioningClient.Events;
-    static readonly early = true;
-    static readonly id = "commissioning";
-    initialize(options: {
-        descriptor?: RemoteDescriptor;
-    }): void;
-    [Symbol.asyncDispose](): void;
-    commission(passcode: number | string): Promise<ClientNode>;
-    commission(options: CommissioningClient.CommissioningOptions): Promise<ClientNode>;
-    /**
-     * Remove this node from the fabric.
-     *
-     * After removal the {@link ClientNode} remains intact.  You can use {@link ClientNode#delete} to remove the node
-     * permanently.
-     *
-     * Only legal if this node controls the peer's fabric.
-     */
-    decommission(): Promise<void>;
-    /**
-     * Override to implement CASE commissioning yourself.
-     *
-     * If you override, matter.js commissions to the point where commissioning over PASE is complete.  You must then
-     * complete commissioning yourself by connecting to the device and invoking the "CommissioningComplete" command.
-     */
-    protected finalizeCommissioning(_address: ProtocolPeerAddress, _discoveryData?: DiscoveryData): Promise<void>;
-    get descriptor(): RemoteDescriptor | undefined;
-    set descriptor(descriptor: RemoteDescriptor | undefined);
-}
-export declare namespace CommissioningClient {
-    /**
-     * Concrete version of {@link ProtocolPeerAddress}.
-     */
-    class PeerAddress implements ProtocolPeerAddress {
-        fabricIndex: FabricIndex;
-        nodeId: NodeId;
-        constructor(fabricIndex: FabricIndex, nodeId: NodeId);
-    }
-    /**
-     * Supported transport flags.
-     */
-    class SupportedTransports implements Partial<SupportedTransportsBitmap> {
-        tcpClient?: boolean;
-        tcpServer?: boolean;
-    }
-    /**
-     * Concrete version of {@link ProtocolSessionParameters}.
-     */
-    class SessionParameters implements Partial<ProtocolSessionParameters> {
-        idleInterval?: Duration;
-        activeInterval?: Duration;
-        activeThreshold?: Duration;
-        dataModelRevision?: number;
-        interactionModelRevision?: number;
-        specificationVersion?: number;
-        maxPathsPerInvoke?: number;
-        supportedTransports?: SupportedTransports;
-        maxTcpMessageSize?: number;
-    }
-    /**
-     * The network address of a node.
-     */
-    class NetworkAddress {
-        type: "udp" | "tcp" | "ble";
-        ip?: string;
-        port?: number;
-        peripheralAddress?: string;
-        ttl?: Duration | undefined;
-        discoveredAt?: Timestamp | undefined;
-        constructor(address: NetworkAddress);
-    }
-    class Internal {
-        peerObserver?: Disposable;
-    }
-    class State {
-        /**
-         * Fabric index and node ID for paired peers.  If this is undefined the node is uncommissioned.
-         */
-        peerAddress?: PeerAddress;
-        /**
-         * Case Authenticated Tags (CATs)
-         *
-         * See {@link PeerDescriptor}
-         */
-        caseAuthenticatedTags?: readonly CaseAuthenticatedTag[];
-        /**
-         * Known network addresses for the device.  If this is undefined, the node has not been located on any network
-         * interface.
-         */
-        addresses?: ServerAddress[];
-        /**
-         * Time at which the device was discovered.
-         */
-        discoveredAt?: Timestamp;
-        /**
-         * Time at which we discovered the device's current operational addresses.
-         */
-        onlineAt?: Timestamp;
-        /**
-         * Time at which we concluded the device's current operational address is unreachable.
-         */
-        offlineAt?: Timestamp;
-        /**
-         * Time at which the device was commissioned.
-         */
-        commissionedAt?: Timestamp;
-        /**
-         * The TTL of the discovery record if applicable (in seconds).
-         */
-        ttl?: Duration;
-        /**
-         * The canonical global ID of the device.
-         */
-        deviceIdentifier?: string;
-        /**
-         * The device's long discriminator.
-         */
-        discriminator?: number;
-        /**
-         * The last know commissioning mode of the device.
-         */
-        commissioningMode?: CommissioningMode;
-        /**
-         * Vendor.
-         */
-        vendorId?: VendorId;
-        /**
-         * Product.
-         */
-        productId?: number;
-        /**
-         * Advertised device type.
-         */
-        deviceType?: DeviceTypeId;
-        /**
-         * The advertised device name specified by the user.
-         */
-        deviceName?: string;
-        /**
-         * An optional manufacturer-specific unique rotating ID for uniquely identifying the device.
-         */
-        rotatingIdentifier?: string;
-        /**
-         * A bitmap indicating how to transition the device to commissioning mode from its current state.
-         */
-        pairingHint?: number;
-        /**
-         * Textual pairing instructions associated with pairing hint.
-         */
-        pairingInstructions?: string;
-        /**
-         * The remote node's session intervals.
-         */
-        sessionParameters?: SessionParameters;
-        /**
-         * TCP support bitmap.
-         */
-        tcpSupport?: number;
-        /**
-         * Indicates whether node is ICD with a slow (15 s+) polling interval.
-         */
-        longIdleTimeOperatingMode?: boolean;
-    }
-    class Events extends BaseEvents {
-        peerAddress$Changed: Observable<[value: ProtocolPeerAddress | undefined, oldValue: ProtocolPeerAddress | undefined], void>;
-        addresses$Changed: Observable<[value: ServerAddress[] | undefined, oldValue: ServerAddress[] | undefined], void>;
-        caseAuthenticatedTags$Changed: Observable<[value: CaseAuthenticatedTag[] | undefined, oldValue: CaseAuthenticatedTag[] | undefined], void>;
-    }
-    /**
-     * Options that control commissioning.
-     */
-    interface BaseCommissioningOptions {
-        /**
-         * The ID to assign the node during commissioning.  By default the node receives the next available ID.
-         */
-        nodeId?: NodeId;
-        /**
-         * The fabric the node joins upon commissioning.  Defaults to the default fabric of the assigned
-         * {@link FabricAuthority}.
-         */
-        fabric?: Fabric;
-        /**
-         * The authority controlling the commissioning fabric.  Defaults to the {@link FabricAuthority} of the local
-         * environment.
-         */
-        fabricAuthority?: FabricAuthority;
-        /**
-         * Custom commissioning flow implementation to use instead of the default.
-         */
-        commissioningFlowImpl?: ClassExtends<ControllerCommissioningFlow>;
-        /**
-         * Abort signal for cancellation.  When fired during PASE establishment, cancels the PASE attempt.
-         * In parallel commissioning scenarios this fires once a winner is found, stopping remaining candidates.
-         */
-        abort?: AbortSignal;
-        /**
-         * Called immediately after PASE is established, before the main commissioning flow begins.
-         *
-         * Return `true` to proceed with commissioning (this candidate won the parallel race).
-         * Return `false` to abort cleanly — the PASE session is closed and commissioning stops.
-         *
-         * When omitted, commissioning always proceeds.
-         */
-        continueCommissioningAfterPase?: () => boolean;
-        /**
-         * Overall wall-clock budget for PASE establishment.
-         * Defaults to 30 seconds.
-         */
-        timeout?: Duration;
-        /**
-         * Discovery capabilities to use for discovery. These are included in the QR code normally and defined if BLE
-         * is supported for initial commissioning.
-         */
-        discoveryCapabilities?: TypeFromPartialBitSchema<typeof DiscoveryCapabilitiesBitmap>;
-        /**
-         * The initial read/subscription used to populate node data.
-         *
-         * By default, matter.js reads all attributes on the node.  This allows us to efficiently initialize the complete
-         * node structure.
-         *
-         * If you only require a subset of attributes you can replace this with a more discriminative read.  For
-         * example, if you are only interested in interacting with the root endpoint and the On/Off cluster on other
-         * endpoints, you could do:
-         *
-         * ```js
-         * {
-         *     defaultSubscription: Read(
-         *         Read.Attribute({ endpoint: 0 }),
-         *         Read.Attribute({ cluster: OnOffCluster })
-         *     )
-         * }
-         * ```
-         *
-         * Note that certain clusters like Descriptor and Basic Information contain critical operational data. If your
-         * read omits them then the node will only be partially functional once initialized.
-         */
-        defaultSubscription?: Subscribe;
-        /**
-         * By default, nodes we commission are automatically subscribed to using the {@link defaultSubscription} (or a
-         * full wildcard subscription if that is undefined).
-         *
-         * Matter.js will not subscribe automatically if set to false.
-         */
-        autoSubscribe?: boolean;
-        /**
-         * Case Authenticated Tags (CATs)
-         */
-        caseAuthenticatedTags?: CaseAuthenticatedTag[];
-        /**
-         * WiFi network credentials to configure on the device during commissioning.  Required if the device connects
-         * to the network over WiFi and doesn't already have credentials configured.
-         */
-        wifiNetwork?: ControllerCommissioningFlowOptions["wifiNetwork"];
-        /**
-         * Thread network credentials to configure on the device during commissioning.  Required if the device connects
-         * to the network over Thread and doesn't already have credentials configured.
-         */
-        threadNetwork?: ControllerCommissioningFlowOptions["threadNetwork"];
-        /**
-         * The regulatory location (indoor or outdoor) where the device is used.
-         * Defaults to `Indoor` if not provided.
-         */
-        regulatoryLocation?: ControllerCommissioningFlowOptions["regulatoryLocation"];
-        /**
-         * The two-character country code where the device is deployed (e.g. "DE", "US").
-         * Defaults to "XX" (unspecified).
-         */
-        regulatoryCountryCode?: ControllerCommissioningFlowOptions["regulatoryCountryCode"];
-        /**
-         * Override the final commissioning step.
-         *
-         * When provided, matter.js completes commissioning over PASE and then calls this function instead of performing
-         * the CASE reconnection and "CommissioningComplete" command internally.  The function must connect to the device
-         * operationally and invoke "CommissioningComplete" itself.
-         *
-         * This is used by {@link PaseCommissioner} so that a lightweight commissioner can perform the PASE phase and
-         * then hand off to a full controller to finish commissioning.
-         * TODO: Revisit when we decide how to continue with the PaseCommissioner approach at all
-         */
-        finalizeCommissioning?: (address: ProtocolPeerAddress, discoveryData?: DiscoveryData) => Promise<void>;
-        /**
-         * Timing overrides for the step-18 CASE reconnect.
-         *
-         * After commissioning the commissioner establishes the first operational CASE session.  The device is freshly
-         * online at that point so tighter timing is appropriate.  Any fields provided here are merged on top of the
-         * global peer timing defaults for that single connection only.
-         *
-         * Defaults to `{ delayBeforeNextAddress: Seconds(15), maxDelayBetweenInitialContactRetries: Seconds(60), delayAfterPeerError: Minutes(2) }`.
-         */
-        caseConnectionTiming?: Partial<PeerTimingParameters>;
-    }
-    interface PasscodeOptions extends BaseCommissioningOptions {
-        /**
-         * The device's passcode.
-         */
-        passcode: number;
-        /**
-         * The device's long discriminator.
-         */
-        discriminator?: number;
-    }
-    interface PairingCodeOptions extends BaseCommissioningOptions {
-        /**
-         * The device's pairing code.
-         */
-        pairingCode: string;
-    }
-    type CommissioningOptions = PasscodeOptions | PairingCodeOptions;
-    function PasscodeOptions<T extends CommissioningOptions>(options: T): T & PasscodeOptions;
-}
-//# sourceMappingURL=CommissioningClient.d.ts.map

package/dist/cjs/behavior/system/commissioning/CommissioningClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommissioningClient.d.ts","sourceRoot":"","sources":["../../../../../src/behavior/system/commissioning/CommissioningClient.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAI3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EACH,YAAY,EAEZ,QAAQ,EAMR,UAAU,EAEV,aAAa,EAGb,SAAS,EACZ,MAAM,iBAAiB,CAAC;AAmBzB,OAAO,KAAK,EAAqC,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AACrG,OAAO,EACH,iBAAiB,EAEjB,2BAA2B,EAC3B,kCAAkC,EAClC,aAAa,EACb,MAAM,EACN,eAAe,EAOf,oBAAoB,EACpB,WAAW,IAAI,mBAAmB,EAClC,iBAAiB,IAAI,yBAAyB,EAC9C,SAAS,EACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,oBAAoB,EACpB,YAAY,EACZ,2BAA2B,EAC3B,WAAW,EAEX,MAAM,EACN,wBAAwB,EACxB,QAAQ,EACX,MAAM,eAAe,CAAC;AAIvB,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAIzD;;;;GAIG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ;;IACrC,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,CAAC;IAC/C,SAAiB,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC;IAClD,SAAiB,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAEpD,gBAAyB,KAAK,QAAQ;IAEtC,gBAAyB,EAAE,mBAAmB;IAErC,UAAU,CAAC,OAAO,EAAE;QAAE,UAAU,CAAC,EAAE,gBAAgB,CAAA;KAAE,QAoB7D;IAEQ,CAAC,MAAM,CAAC,YAAY,CAAC,SAK7B;IAWD,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3D,UAAU,CAAC,OAAO,EAAE,mBAAmB,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAsInF;;;;;;;OAOG;IACG,YAAY,kBAyCjB;IAED;;;;;OAKG;IACH,UAAgB,qBAAqB,CAAC,QAAQ,EAAE,mBAAmB,EAAE,cAAc,CAAC,EAAE,aAAa,iBAElG;IAED,IAAI,UAAU,IAIa,gBAAgB,GAAG,SAAS,CAFtD;IAED,IAAI,UAAU,CAAC,UAAU,EAAE,gBAAgB,GAAG,SAAS,EAEtD;CA4JJ;AAiBD,yBAAiB,mBAAmB,CAAC,CAAC;IAClC;;OAEG;IACH,MAAa,WAAY,YAAW,mBAAmB;QAEnD,WAAW,EAAE,WAAW,CAAC;QAGzB,MAAM,EAAE,MAAM,CAAC;QAEf,YAAY,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAGnD;KACJ;IAED;;OAEG;IACH,MACa,mBAAoB,YAAW,OAAO,CAAC,yBAAyB,CAAC;QAE1E,SAAS,CAAC,EAAE,OAAO,CAAC;QAGpB,SAAS,CAAC,EAAE,OAAO,CAAC;KACvB;IAED;;OAEG;IACH,MAAa,iBAAkB,YAAW,OAAO,CAAC,yBAAyB,CAAC;QAExE,YAAY,CAAC,EAAE,QAAQ,CAAC;QAGxB,cAAc,CAAC,EAAE,QAAQ,CAAC;QAG1B,eAAe,CAAC,EAAE,QAAQ,CAAC;QAG3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAG3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAGlC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAG9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAG3B,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;QAG1C,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED;;OAEG;IACH,MAAa,cAAc;QAEvB,IAAI,EAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;QAG7B,EAAE,CAAC,EAAE,MAAM,CAAC;QAGZ,IAAI,CAAC,EAAE,MAAM,CAAC;QAGd,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAG3B,GAAG,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAG3B,YAAY,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAErC,YAAY,OAAO,EAAE,cAAc,EAiBlC;KACJ;IAED,MAAa,QAAQ;QACjB,YAAY,CAAC,EAAE,UAAU,CAAC;KAC7B;IAED,MAAa,KAAK;QACd;;WAEG;QAEH,WAAW,CAAC,EAAE,WAAW,CAAC;QAE1B;;;;WAIG;QAEH,qBAAqB,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAC;QAExD;;;WAGG;QAEH,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;QAE5B;;WAEG;QAEH,YAAY,CAAC,EAAE,SAAS,CAAC;QAEzB;;WAEG;QAEH,QAAQ,CAAC,EAAE,SAAS,CAAC;QAErB;;WAEG;QAEH,SAAS,CAAC,EAAE,SAAS,CAAC;QAEtB;;WAEG;QAEH,cAAc,CAAC,EAAE,SAAS,CAAC;QAE3B;;WAEG;QAEH,GAAG,CAAC,EAAE,QAAQ,CAAC;QAEf;;WAEG;QAEH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QAEH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QAEH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QAEtC;;WAEG;QAEH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QAEH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QAEH,UAAU,CAAC,EAAE,YAAY,CAAC;QAE1B;;WAEG;QAEH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QAEH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;WAEG;QAEH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QAEH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QAEH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QAEtC;;WAEG;QAEH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QAEH,yBAAyB,CAAC,EAAE,OAAO,CAAC;KACvC;IAED,MAAa,MAAO,SAAQ,UAAU;QAClC,mBAAmB,wGAEf;QAEJ,iBAAiB,gGAEb;QAEJ,6BAA6B,8GAEzB;KACP;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACrC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,eAAe,CAAC,EAAE,eAAe,CAAC;QAElC;;WAEG;QACH,qBAAqB,CAAC,EAAE,YAAY,CAAC,2BAA2B,CAAC,CAAC;QAElE;;;WAGG;QACH,KAAK,CAAC,EAAE,WAAW,CAAC;QAEpB;;;;;;;WAOG;QACH,8BAA8B,CAAC,EAAE,MAAM,OAAO,CAAC;QAE/C;;;WAGG;QACH,OAAO,CAAC,EAAE,QAAQ,CAAC;QAEnB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,wBAAwB,CAAC,OAAO,2BAA2B,CAAC,CAAC;QAErF;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,mBAAmB,CAAC,EAAE,SAAS,CAAC;QAEhC;;;;;WAKG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,qBAAqB,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAE/C;;;WAGG;QACH,WAAW,CAAC,EAAE,kCAAkC,CAAC,aAAa,CAAC,CAAC;QAEhE;;;WAGG;QACH,aAAa,CAAC,EAAE,kCAAkC,CAAC,eAAe,CAAC,CAAC;QAEpE;;;WAGG;QACH,kBAAkB,CAAC,EAAE,kCAAkC,CAAC,oBAAoB,CAAC,CAAC;QAE9E;;;WAGG;QACH,qBAAqB,CAAC,EAAE,kCAAkC,CAAC,uBAAuB,CAAC,CAAC;QAEpF;;;;;;;;;;WAUG;QACH,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvG;;;;;;;;WAQG;QACH,oBAAoB,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;KACxD;IAED,UAAiB,eAAgB,SAAQ,wBAAwB;QAC7D;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,kBAAmB,SAAQ,wBAAwB;QAChE;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACvB;IAED,KAAY,oBAAoB,GAAG,eAAe,GAAG,kBAAkB,CAAC;IAExE,SAAgB,eAAe,CAAC,CAAC,SAAS,oBAAoB,EAAE,OAAO,EAAE,CAAC,uBAsBzE;CACJ"}