@project-chip/matter.js 0.11.0-alpha.0-20241002-e7b377c34 → 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-20241002-e7b377c34",
+    "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-20241002-e7b377c34",
-        "@matter.js/model": "0.11.0-alpha.0-20241002-e7b377c34",
-        "@matter.js/types": "0.11.0-alpha.0-20241002-e7b377c34",
-        "@matter.js/protocol": "0.11.0-alpha.0-20241002-e7b377c34",
-        "@matter.js/node": "0.11.0-alpha.0-20241002-e7b377c34"
+        "@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-20241002-e7b377c34",
-        "@matter.js/codegen": "0.11.0-alpha.0-20241002-e7b377c34"
+        "@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,
@@ -14,7 +13,6 @@ import {
     Network,
     NoProviderError,
     StorageContext,
-    SupportedStorageTypes,
     SyncStorage,
     UdpInterface,
 } from "#general";
@@ -32,15 +30,12 @@ import {
     NodeDiscoveryType,
     PeerCommissioningOptions,
     ScannerSet,
-    SupportedAttributeClient,
 } from "#protocol";
 import {
     CaseAuthenticatedTag,
     DiscoveryCapabilitiesBitmap,
-    EndpointNumber,
     FabricId,
     FabricIndex,
-    GlobalAttributes,
     NodeId,
     TypeFromPartialBitSchema,
     VendorId,
@@ -138,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>>();
 
     /**
@@ -248,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:
@@ -256,6 +251,7 @@ export class CommissioningController extends MatterNode {
                 subscribeMaxIntervalCeilingSeconds:
                     nodeOptions.subscribeMaxIntervalCeilingSeconds ?? this.options.subscribeMaxIntervalCeilingSeconds,
             });
+            await node.events.initialized;
         }
 
         return nodeId;
@@ -286,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) {
@@ -301,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!`);
         }
@@ -323,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);
@@ -331,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.
@@ -415,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());
     }
 
     /**
@@ -463,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. */
@@ -482,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/MatterController.ts

@@ -12,20 +12,20 @@
 
 import { GeneralCommissioning } from "#clusters";
 import { NodeCommissioningOptions } from "#CommissioningController.js";
+import { DeviceInformationData } from "#device/DeviceInformation.js";
 import {
-    CRYPTO_SYMMETRIC_KEY_LENGTH,
     ChannelType,
     Construction,
     Crypto,
+    CRYPTO_SYMMETRIC_KEY_LENGTH,
     ImplementationError,
     Logger,
     NetInterfaceSet,
     ServerAddressIp,
+    serverAddressToString,
     StorageBackendMemory,
     StorageContext,
     StorageManager,
-    SupportedStorageTypes,
-    serverAddressToString,
 } from "#general";
 import {
     ChannelManager,
@@ -58,28 +58,14 @@ import {
     FabricId,
     FabricIndex,
     NodeId,
-    TlvEnum,
-    TlvField,
-    TlvObject,
-    TlvString,
     TypeFromPartialBitSchema,
-    TypeFromSchema,
     VendorId,
 } from "#types";
 
-const TlvCommissioningSuccessFailureResponse = TlvObject({
-    /** Contain the result of the operation. */
-    errorCode: TlvField(0, TlvEnum<GeneralCommissioning.CommissioningError>()),
-
-    /** Should help developers in troubleshooting errors. The value MAY go into logs or crash reports, not User UIs. */
-    debugText: TlvField(1, TlvString.bound({ maxLength: 128 })),
-});
-export type CommissioningSuccessFailureResponse = TypeFromSchema<typeof TlvCommissioningSuccessFailureResponse>;
-
 export type CommissionedNodeDetails = {
     operationalServerAddress?: ServerAddressIp;
     discoveryData?: DiscoveryData;
-    basicInformationData?: Record<string, SupportedStorageTypes>;
+    deviceData?: DeviceInformationData;
 };
 
 const DEFAULT_ADMIN_VENDOR_ID = VendorId(0xfff1);
@@ -92,7 +78,7 @@ const CONTROLLER_MAX_PATHS_PER_INVOKE = 10;
 const logger = Logger.get("MatterController");
 
 // Operational peer extended with basic information as required for conversion to CommissionedNodeDetails
-type CommissionedPeer = OperationalPeer & { basicInformationData?: Record<string, SupportedStorageTypes> };
+type CommissionedPeer = OperationalPeer & { deviceData?: DeviceInformationData };
 
 // Backward-compatible persistence record for nodes
 type StoredOperationalPeer = [NodeId, CommissionedNodeDetails];
@@ -420,27 +406,38 @@ export class MatterController {
 
     getCommissionedNodesDetails() {
         return this.peers.map(peer => {
-            const { address, operationalAddress, discoveryData, basicInformationData } = peer as CommissionedPeer;
+            const { address, operationalAddress, discoveryData, deviceData } = peer as CommissionedPeer;
             return {
                 nodeId: address.nodeId,
                 operationalAddress: operationalAddress ? serverAddressToString(operationalAddress) : undefined,
                 advertisedName: discoveryData?.DN,
                 discoveryData,
-                basicInformationData,
+                deviceData,
             };
         });
     }
 
-    async enhanceCommissionedNodeDetails(
-        nodeId: NodeId,
-        data: { basicInformationData: Record<string, SupportedStorageTypes> },
-    ) {
+    getCommissionedNodeDetails(nodeId: NodeId) {
+        const nodeDetails = this.peers.get(this.fabric.addressOf(nodeId)) as CommissionedPeer;
+        if (nodeDetails === undefined) {
+            throw new Error(`Node ${nodeId} is not commissioned.`);
+        }
+        const { address, operationalAddress, discoveryData, deviceData } = nodeDetails;
+        return {
+            nodeId: address.nodeId,
+            operationalAddress: operationalAddress ? serverAddressToString(operationalAddress) : undefined,
+            advertisedName: discoveryData?.DN,
+            discoveryData,
+            deviceData,
+        };
+    }
+
+    async enhanceCommissionedNodeDetails(nodeId: NodeId, deviceData: DeviceInformationData) {
         const nodeDetails = this.peers.get(this.fabric.addressOf(nodeId)) as CommissionedPeer;
         if (nodeDetails === undefined) {
             throw new Error(`Node ${nodeId} is not commissioned.`);
         }
-        const { basicInformationData } = data;
-        nodeDetails.basicInformationData = basicInformationData;
+        nodeDetails.deviceData = deviceData;
         await this.nodesStore.save();
     }
 
@@ -502,12 +499,12 @@ class CommissionedNodeStore extends PeerStore {
 
         const commissionedNodes = await this.nodesStorage.get<StoredOperationalPeer[]>("commissionedNodes");
         return commissionedNodes.map(
-            ([nodeId, { operationalServerAddress, discoveryData, basicInformationData }]) =>
+            ([nodeId, { operationalServerAddress, discoveryData, deviceData }]) =>
                 ({
                     address: this.fabric.addressOf(nodeId),
                     operationalAddress: operationalServerAddress,
                     discoveryData,
-                    basicInformationData,
+                    deviceData,
                 }) satisfies CommissionedPeer,
         );
     }
@@ -527,12 +524,12 @@ class CommissionedNodeStore extends PeerStore {
                 const {
                     address,
                     operationalAddress: operationalServerAddress,
-                    basicInformationData,
                     discoveryData,
+                    deviceData,
                 } = peer as CommissionedPeer;
                 return [
                     address.nodeId,
-                    { operationalServerAddress, basicInformationData, discoveryData },
+                    { operationalServerAddress, discoveryData, deviceData },
                 ] satisfies StoredOperationalPeer;
             }),
         );