@project-chip/matter.js 0.11.0-alpha.0-20240928-08865c2ce → 0.11.0-alpha.0-20241004-743c02ca6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@project-chip/matter.js",
-    "version": "0.11.0-alpha.0-20240928-08865c2ce",
+    "version": "0.11.0-alpha.0-20241004-743c02ca6",
     "description": "Matter protocol in pure js",
     "keywords": [
         "iot",
@@ -46,15 +46,14 @@
     },
     "dependencies": {
         "@noble/curves": "^1.5.0",
-        "@matter.js/general": "0.11.0-alpha.0-20240928-08865c2ce",
-        "@matter.js/model": "0.11.0-alpha.0-20240928-08865c2ce",
-        "@matter.js/types": "0.11.0-alpha.0-20240928-08865c2ce",
-        "@matter.js/protocol": "0.11.0-alpha.0-20240928-08865c2ce",
-        "@matter.js/node": "0.11.0-alpha.0-20240928-08865c2ce"
+        "@matter.js/general": "0.11.0-alpha.0-20241004-743c02ca6",
+        "@matter.js/model": "0.11.0-alpha.0-20241004-743c02ca6",
+        "@matter.js/types": "0.11.0-alpha.0-20241004-743c02ca6",
+        "@matter.js/protocol": "0.11.0-alpha.0-20241004-743c02ca6",
+        "@matter.js/node": "0.11.0-alpha.0-20241004-743c02ca6"
     },
     "devDependencies": {
-        "@matter.js/tools": "0.11.0-alpha.0-20240928-08865c2ce",
-        "@matter.js/codegen": "0.11.0-alpha.0-20240928-08865c2ce"
+        "@matter.js/tools": "0.11.0-alpha.0-20241004-743c02ca6"
     },
     "files": [
         "dist/**/*",
@@ -109,42 +108,42 @@
         },
         "./behavior/definitions/*": {
             "import": {
-                "types": "./dist/esm/compat/behaviors/*.d.ts",
-                "default": "./dist/esm/compat/behaviors/*.js"
+                "types": "./dist/esm/forwards/behaviors/*.d.ts",
+                "default": "./dist/esm/forwards/behaviors/*.js"
             },
             "require": {
-                "types": "./dist/cjs/compat/behaviors/*.d.ts",
-                "default": "./dist/cjs/compat/behaviors/*.js"
+                "types": "./dist/cjs/forwards/behaviors/*.d.ts",
+                "default": "./dist/cjs/forwards/behaviors/*.js"
             }
         },
         "./tags/*": {
             "import": {
-                "types": "./dist/esm/compat/tags/*.d.ts",
-                "default": "./dist/esm/compat/tags/*.js"
+                "types": "./dist/esm/forwards/tags/*.d.ts",
+                "default": "./dist/esm/forwards/tags/*.js"
             },
             "require": {
-                "types": "./dist/cjs/compat/tags/*.d.ts",
-                "default": "./dist/cjs/compat/tags/*.js"
+                "types": "./dist/cjs/forwards/tags/*.d.ts",
+                "default": "./dist/cjs/forwards/tags/*.js"
             }
         },
         "./devices/*": {
             "import": {
-                "types": "./dist/esm/compat/devices/*.d.ts",
-                "default": "./dist/esm/compat/devices/*.js"
+                "types": "./dist/esm/forwards/devices/*.d.ts",
+                "default": "./dist/esm/forwards/devices/*.js"
             },
             "require": {
-                "types": "./dist/cjs/compat/devices/*.d.ts",
-                "default": "./dist/cjs/compat/devices/*.js"
+                "types": "./dist/cjs/forwards/devices/*.d.ts",
+                "default": "./dist/cjs/forwards/devices/*.js"
             }
         },
         "./endpoints/*": {
             "import": {
-                "types": "./dist/esm/compat/endpoints/*.d.ts",
-                "default": "./dist/esm/compat/endpoints/*.js"
+                "types": "./dist/esm/forwards/endpoints/*.d.ts",
+                "default": "./dist/esm/forwards/endpoints/*.js"
             },
             "require": {
-                "types": "./dist/cjs/compat/endpoints/*.d.ts",
-                "default": "./dist/cjs/compat/endpoints/*.js"
+                "types": "./dist/cjs/forwards/endpoints/*.d.ts",
+                "default": "./dist/cjs/forwards/endpoints/*.js"
             }
         },
         "./*": {

package/src/CommissioningController.ts

@@ -4,7 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { BasicInformation } from "#clusters";
 import {
     Environment,
     ImplementationError,
@@ -13,9 +12,7 @@ import {
     NetInterfaceSet,
     Network,
     NoProviderError,
-    ServerAddress,
     StorageContext,
-    SupportedStorageTypes,
     SyncStorage,
     UdpInterface,
 } from "#general";
@@ -24,29 +21,27 @@ import {
     Ble,
     CommissionableDevice,
     CommissionableDeviceIdentifiers,
-    ControllerCommissioningOptions,
     ControllerDiscovery,
     DiscoveryData,
     InteractionClient,
     MdnsBroadcaster,
     MdnsScanner,
     MdnsService,
+    NodeDiscoveryType,
+    PeerCommissioningOptions,
     ScannerSet,
-    SupportedAttributeClient,
 } from "#protocol";
 import {
     CaseAuthenticatedTag,
     DiscoveryCapabilitiesBitmap,
-    EndpointNumber,
     FabricId,
     FabricIndex,
-    GlobalAttributes,
     NodeId,
     TypeFromPartialBitSchema,
     VendorId,
 } from "#types";
 import { CommissioningControllerNodeOptions, PairedNode } from "./device/PairedNode.js";
-import { MatterController, NodeDiscoveryType } from "./MatterController.js";
+import { MatterController } from "./MatterController.js";
 import { MatterNode } from "./MatterNode.js";
 
 const logger = new Logger("CommissioningController");
@@ -120,44 +115,8 @@ export type CommissioningControllerOptions = CommissioningControllerNodeOptions
 
 /** Options needed to commission a new node */
 export type NodeCommissioningOptions = CommissioningControllerNodeOptions & {
-    /** Commission related options. */
-    commissioning?: ControllerCommissioningOptions;
-
-    /** Discovery related options. */
-    discovery: (
-        | {
-              /**
-               * Device identifiers (Short or Long Discriminator, Product/Vendor-Ids, Device-type or a pre-discovered
-               * instance Id, or "nothing" to discover all commissionable matter devices) to use for discovery.
-               * If the property commissionableDevice is provided this property is ignored.
-               */
-              identifierData: CommissionableDeviceIdentifiers;
-          }
-        | {
-              /**
-               * Commissionable device object returned by a discovery run.
-               * If this property is provided then identifierData and knownAddress are ignored.
-               */
-              commissionableDevice: CommissionableDevice;
-          }
-    ) & {
-        /**
-         * 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>;
-
-        /**
-         * Known address of the device to use for discovery. if this is set this will be tried first before discovering
-         * the device.
-         */
-        knownAddress?: ServerAddress;
-
-        /** Timeout in seconds for the discovery process. Default: 30 seconds */
-        timeoutSeconds?: number;
-    };
-
-    /** Passcode to use for commissioning. */
+    commissioning: Omit<PeerCommissioningOptions, "fabric" | "discovery" | "passcode">;
+    discovery: PeerCommissioningOptions["discovery"];
     passcode: number;
 };
 
@@ -174,7 +133,7 @@ export class CommissioningController extends MatterNode {
     private mdnsScanner?: MdnsScanner;
 
     private controllerInstance?: MatterController;
-    private connectedNodes = new Map<NodeId, PairedNode>();
+    private initializedNodes = new Map<NodeId, PairedNode>();
     private sessionDisconnectedHandler = new Map<NodeId, () => Promise<void>>();
 
     /**
@@ -274,7 +233,8 @@ export class CommissioningController extends MatterNode {
     }
 
     /**
-     * Commissions/Pairs a new device into the controller fabric. The method returns the NodeId of the commissioned node.
+     * Commissions/Pairs a new device into the controller fabric. The method returns the NodeId of the commissioned
+     * node.
      */
     async commissionNode(nodeOptions: NodeCommissioningOptions, connectNodeAfterCommissioning = true) {
         this.assertIsAddedToMatterServer();
@@ -283,7 +243,7 @@ export class CommissioningController extends MatterNode {
         const nodeId = await controller.commission(nodeOptions);
 
         if (connectNodeAfterCommissioning) {
-            await this.connectNode(nodeId, {
+            const node = await this.connectNode(nodeId, {
                 ...nodeOptions,
                 autoSubscribe: nodeOptions.autoSubscribe ?? this.options.autoSubscribe,
                 subscribeMinIntervalFloorSeconds:
@@ -291,6 +251,7 @@ export class CommissioningController extends MatterNode {
                 subscribeMaxIntervalCeilingSeconds:
                     nodeOptions.subscribeMaxIntervalCeilingSeconds ?? this.options.subscribeMaxIntervalCeilingSeconds,
             });
+            await node.events.initialized;
         }
 
         return nodeId;
@@ -321,7 +282,7 @@ export class CommissioningController extends MatterNode {
      */
     async removeNode(nodeId: NodeId, tryDecommissioning = true) {
         const controller = this.assertControllerIsStarted();
-        const node = this.connectedNodes.get(nodeId);
+        const node = this.initializedNodes.get(nodeId);
         if (tryDecommissioning) {
             try {
                 if (node == undefined) {
@@ -336,11 +297,11 @@ export class CommissioningController extends MatterNode {
             node.close();
         }
         await controller.removeNode(nodeId);
-        this.connectedNodes.delete(nodeId);
+        this.initializedNodes.delete(nodeId);
     }
 
     async disconnectNode(nodeId: NodeId) {
-        const node = this.connectedNodes.get(nodeId);
+        const node = this.initializedNodes.get(nodeId);
         if (node === undefined) {
             throw new ImplementationError(`Node ${nodeId} is not connected!`);
         }
@@ -358,7 +319,7 @@ export class CommissioningController extends MatterNode {
             throw new ImplementationError(`Node ${nodeId} is not commissioned!`);
         }
 
-        const existingNode = this.connectedNodes.get(nodeId);
+        const existingNode = this.initializedNodes.get(nodeId);
         if (existingNode !== undefined) {
             if (!existingNode.isConnected) {
                 await existingNode.reconnect(connectOptions);
@@ -366,74 +327,23 @@ export class CommissioningController extends MatterNode {
             return existingNode;
         }
 
-        const pairedNode = await PairedNode.create(
+        const pairedNode = new PairedNode(
             nodeId,
             this,
             connectOptions,
+            this.controllerInstance?.getCommissionedNodeDetails(nodeId)?.deviceData ?? {},
             async (discoveryType?: NodeDiscoveryType) => this.createInteractionClient(nodeId, discoveryType),
             handler => this.sessionDisconnectedHandler.set(nodeId, handler),
         );
-        this.connectedNodes.set(nodeId, pairedNode);
+        this.initializedNodes.set(nodeId, pairedNode);
 
-        if (connectOptions?.autoSubscribe !== false) {
-            await this.enhanceDeviceDetailsFromCache(nodeId, pairedNode);
-        } else {
-            await this.enhanceDeviceDetailsFromRemote(nodeId, pairedNode);
-        }
+        pairedNode.events.initialized.on(
+            async deviceData => await controller.enhanceCommissionedNodeDetails(nodeId, deviceData),
+        );
 
         return pairedNode;
     }
 
-    private async enhanceDeviceDetailsFromCache(nodeId: NodeId, pairedNode: PairedNode) {
-        const controller = this.assertControllerIsStarted();
-
-        const globalAttributeKeys = Object.keys(GlobalAttributes({}));
-        const basicInformationClient = pairedNode.getRootClusterClient(BasicInformation.Cluster);
-        if (basicInformationClient === undefined) {
-            logger.info(`No basic information cluster found for node ${nodeId}`);
-            return;
-        }
-        const basicInformationData = {} as Record<string, SupportedStorageTypes>;
-        for (const attributeName of Object.keys(basicInformationClient.attributes)) {
-            if (globalAttributeKeys.includes(attributeName)) {
-                continue;
-            }
-            const attribute = (basicInformationClient.attributes as any)[attributeName];
-            if (attribute instanceof SupportedAttributeClient) {
-                try {
-                    basicInformationData[attributeName] = await attribute.get();
-                } catch (error) {
-                    logger.info(`Error while getting attribute ${attributeName} for node ${nodeId}: ${error}`);
-                }
-            }
-        }
-        await controller.enhanceCommissionedNodeDetails(nodeId, { basicInformationData });
-    }
-
-    private async enhanceDeviceDetailsFromRemote(nodeId: NodeId, pairedNode: PairedNode) {
-        const controller = this.assertControllerIsStarted();
-
-        const globalAttributeKeys = Object.keys(GlobalAttributes({}));
-        try {
-            const interactionClient = await pairedNode.getInteractionClient();
-            const basicInformationAttributes = await interactionClient.getMultipleAttributes({
-                attributes: [{ endpointId: EndpointNumber(0), clusterId: BasicInformation.Cluster.id }],
-            });
-            const basicInformationData = {} as Record<string, SupportedStorageTypes>;
-            for (const {
-                path: { attributeName },
-                value,
-            } of basicInformationAttributes) {
-                if (!globalAttributeKeys.includes(attributeName)) {
-                    basicInformationData[attributeName] = value;
-                }
-            }
-            await controller.enhanceCommissionedNodeDetails(nodeId, { basicInformationData });
-        } catch (error) {
-            logger.info(`Error while enhancing basic information for node ${nodeId}: ${error}`);
-        }
-    }
-
     /**
      * Connects to all paired nodes.
      * After connection the endpoint data of the device is analyzed and an object structure is created.
@@ -450,7 +360,7 @@ export class CommissioningController extends MatterNode {
         for (const nodeId of controller.getCommissionedNodes()) {
             await this.connectNode(nodeId, connectOptions);
         }
-        return Array.from(this.connectedNodes.values());
+        return Array.from(this.initializedNodes.values());
     }
 
     /**
@@ -498,8 +408,8 @@ export class CommissioningController extends MatterNode {
     }
 
     /** Returns the PairedNode instance for a given node id, if this node is connected. */
-    getConnectedNode(nodeId: NodeId) {
-        return this.connectedNodes.get(nodeId);
+    getPairedNode(nodeId: NodeId) {
+        return this.initializedNodes.get(nodeId);
     }
 
     /** Returns an array with the Node Ids for all commissioned nodes. */
@@ -517,12 +427,12 @@ export class CommissioningController extends MatterNode {
 
     /** Disconnects all connected nodes and Closes the network connections and other resources of the controller. */
     async close() {
-        for (const node of this.connectedNodes.values()) {
+        for (const node of this.initializedNodes.values()) {
             node.close();
         }
         await this.controllerInstance?.close();
         this.controllerInstance = undefined;
-        this.connectedNodes.clear();
+        this.initializedNodes.clear();
         this.ipv4Disabled = undefined;
         this.started = false;
     }

package/src/CommissioningServer.ts

@@ -596,8 +596,8 @@ export class CommissioningServer extends MatterNode {
                 randomizationWindowSeconds: this.options.subscriptionRandomizationWindowSeconds,
             },
             maxPathsPerInvoke,
-            initiateExchange: (fabric, nodeId, protocolId) => {
-                return deviceInstance.initiateExchange(fabric, nodeId, protocolId);
+            initiateExchange: (address, protocolId) => {
+                return deviceInstance.initiateExchange(address, protocolId);
             },
         });
         deviceInstance.addProtocolHandler(this.interactionServer);