@matter/types 0.12.4-alpha.0-20250211-56b2c53a0 → 0.12.4-alpha.0-20250213-1187f81eb

package/src/cluster/mutation/ClusterComposer.ts

@@ -4,12 +4,19 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { camelize, isDeepEqual, MatterError, serialize } from "#general";
+import { camelize, MatterError, serialize } from "#general";
+import { FeatureSet } from "@matter/model";
 import { BitFlags } from "../../schema/BitmapSchema.js";
 import { ClusterType } from "../ClusterType.js";
 
 export class IllegalClusterError extends MatterError {}
 
+/**
+ * To save memory we cache clusters with specific feature variants.  Otherwise code that configures clusters dynamically
+ * may create multiple redundant copies.
+ */
+const featureSelectionCache = new WeakMap<ClusterType, Record<string, WeakRef<ClusterType>>>();
+
 /**
  * A "cluster composer" manages cluster configuration based on feature selection.
  */
@@ -26,9 +33,28 @@ export class ClusterComposer<const T extends ClusterType> {
         this.validateFeatureSelection(selection);
 
         const extensions = this.cluster.extensions;
-        let cluster: ClusterType;
+        let cluster: ClusterType | undefined;
+
+        // First check cache
+        const cacheKey = [...selection].sort().join("␜");
+        cluster = featureSelectionCache.get(this.cluster)?.[cacheKey]?.deref();
+
+        // Next check whether feature set remains unchanged
+        if (!cluster) {
+            const currentCacheKey = [...new FeatureSet(this.cluster.supportedFeatures)].sort().join("␜");
+            if (currentCacheKey === cacheKey) {
+                cluster = featureSelectionCache.get(this.cluster)?.[cacheKey]?.deref();
+            }
+        }
+
+        // Done if either optimization above succeeded
+        if (cluster) {
+            return cluster as ClusterComposer.Of<T, SelectionT>;
+        }
 
+        // Modify feature selection
         if (extensions) {
+            // Feature selection modifies elements
             const base = this.cluster.base ?? this.cluster;
 
             const baseElements = (type: "attributes" | "commands" | "events") => {
@@ -57,16 +83,21 @@ export class ClusterComposer<const T extends ClusterType> {
                 }
             }
         } else {
+            // Feature selection does not modify elements
             const supportedFeatures = BitFlags(this.cluster.features, ...selection);
-            if (isDeepEqual(supportedFeatures, this.cluster.supportedFeatures)) {
-                cluster = this.cluster;
-            } else {
-                cluster = ClusterType({
-                    ...this.cluster,
-                    supportedFeatures,
-                    base: this.cluster.base ?? this.cluster,
-                });
-            }
+            cluster = ClusterType({
+                ...this.cluster,
+                supportedFeatures,
+                base: this.cluster.base ?? this.cluster,
+            });
+        }
+
+        // Update cache
+        const baseVariants = featureSelectionCache.get(this.cluster);
+        if (baseVariants === undefined) {
+            featureSelectionCache.set(this.cluster, { [cacheKey]: new WeakRef(cluster) });
+        } else {
+            baseVariants[cacheKey] = new WeakRef(cluster);
         }
 
         return cluster as ClusterComposer.Of<T, SelectionT>;

package/src/globals/Status.ts

@@ -231,5 +231,10 @@ export enum Status {
      *
      * @see {@link MatterSpecification.v13.Core} § 8.10.1
      */
-    NoCommandResponse = 204
+    NoCommandResponse = 204,
+
+    /**
+     * Matter 1.4, temporarily patched in manually.
+     */
+    AccessRestricted = 0x9d,
 }

package/src/protocol/messages/TlvDataReport.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvArray } from "../../tlv/TlvArray.js";
 import { TlvBoolean } from "../../tlv/TlvBoolean.js";
 import { TlvUInt32, TlvUInt8 } from "../../tlv/TlvNumber.js";
@@ -28,3 +29,5 @@ export const TlvDataReport = TlvObject({
     suppressResponse: TlvOptionalField(4, TlvBoolean),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type DataReport = TypeFromSchema<typeof TlvDataReport>;

package/src/protocol/messages/TlvInvokeRequest.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvArray } from "../../tlv/TlvArray.js";
 import { TlvBoolean } from "../../tlv/TlvBoolean.js";
 import { TlvUInt8 } from "../../tlv/TlvNumber.js";
@@ -23,3 +24,5 @@ export const TlvInvokeRequest = TlvObject({
     invokeRequests: TlvField(2, TlvArray(TlvCommandData)),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type InvokeRequest = TypeFromSchema<typeof TlvInvokeRequest>;

package/src/protocol/messages/TlvInvokeResponse.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvArray } from "../../tlv/TlvArray.js";
 import { TlvBoolean } from "../../tlv/TlvBoolean.js";
 import { TlvUInt8 } from "../../tlv/TlvNumber.js";
@@ -21,3 +22,5 @@ export const TlvInvokeResponse = TlvObject({
     moreChunkedMessages: TlvOptionalField(2, TlvBoolean),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type InvokeResponse = TypeFromSchema<typeof TlvInvokeResponse>;

package/src/protocol/messages/TlvReadRequest.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvArray } from "../../tlv/TlvArray.js";
 import { TlvBoolean } from "../../tlv/TlvBoolean.js";
 import { TlvUInt8 } from "../../tlv/TlvNumber.js";
@@ -32,3 +33,5 @@ export const TlvReadRequest = TlvObject({
     dataVersionFilters: TlvOptionalField(4, TlvArray(TlvDataVersionFilter)),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type ReadRequest = TypeFromSchema<typeof TlvReadRequest>;

package/src/protocol/messages/TlvSubscribeRequest.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvArray } from "../../tlv/TlvArray.js";
 import { TlvBoolean } from "../../tlv/TlvBoolean.js";
 import { TlvUInt16, TlvUInt8 } from "../../tlv/TlvNumber.js";
@@ -41,3 +42,5 @@ export const TlvSubscribeRequest = TlvObject({
     dataVersionFilters: TlvOptionalField(8, TlvArray(TlvDataVersionFilter)),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type SubscribeRequest = TypeFromSchema<typeof TlvSubscribeRequest>;

package/src/protocol/messages/TlvSubscribeResponse.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvUInt16, TlvUInt32, TlvUInt8 } from "../../tlv/TlvNumber.js";
 import { TlvField, TlvObject } from "../../tlv/TlvObject.js";
 
@@ -17,3 +18,5 @@ export const TlvSubscribeResponse = TlvObject({
     maxInterval: TlvField(2, TlvUInt16),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type SubscribeResponse = TypeFromSchema<typeof TlvSubscribeResponse>;

package/src/protocol/messages/TlvTimedRequest.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvUInt16, TlvUInt8 } from "../../tlv/TlvNumber.js";
 import { TlvField, TlvObject } from "../../tlv/TlvObject.js";
 
@@ -14,3 +15,5 @@ export const TlvTimedRequest = TlvObject({
     timeout: TlvField(0, TlvUInt16),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type TimedRequest = TypeFromSchema<typeof TlvTimedRequest>;

package/src/protocol/messages/TlvWriteRequest.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvArray } from "../../tlv/TlvArray.js";
 import { TlvBoolean } from "../../tlv/TlvBoolean.js";
 import { TlvUInt8 } from "../../tlv/TlvNumber.js";
@@ -24,3 +25,5 @@ export const TlvWriteRequest = TlvObject({
     moreChunkedMessages: TlvOptionalField(3, TlvBoolean),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type WriteRequest = TypeFromSchema<typeof TlvWriteRequest>;

package/src/protocol/messages/TlvWriteResponse.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvArray } from "../../tlv/TlvArray.js";
 import { TlvUInt8 } from "../../tlv/TlvNumber.js";
 import { TlvField, TlvObject } from "../../tlv/TlvObject.js";
@@ -16,3 +17,5 @@ export const TlvWriteResponse = TlvObject({
     writeResponses: TlvField(0, TlvArray(TlvAttributeStatus)),
     interactionModelRevision: TlvField(0xff, TlvUInt8),
 });
+
+export type WriteResponse = TypeFromSchema<typeof TlvWriteResponse>;

package/src/protocol/types/TlvAttributePath.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvAttributeId } from "../../datatype/AttributeId.js";
 import { TlvClusterId } from "../../datatype/ClusterId.js";
 import { TlvEndpointNumber } from "../../datatype/EndpointNumber.js";
@@ -26,3 +27,5 @@ export const TlvAttributePath = TlvTaggedList({
     listIndex: TlvOptionalField(5, TlvNullable(TlvUInt16)),
     wildcardPathFlags: TlvOptionalField(6, TlvBitmap(TlvUInt32, WildcardPathFlagsBitmap)),
 });
+
+export type AttributePath = TypeFromSchema<typeof TlvAttributePath>;

package/src/protocol/types/TlvAttributeReport.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvObject, TlvOptionalField } from "../../tlv/TlvObject.js";
 import { TlvAttributeReportData } from "./TlvAttributeReportData.js";
 import { TlvAttributeStatus } from "./TlvAttributeStatus.js";
@@ -15,3 +16,5 @@ export const TlvAttributeReport = TlvObject({
     attributeStatus: TlvOptionalField(0, TlvAttributeStatus),
     attributeData: TlvOptionalField(1, TlvAttributeReportData),
 });
+
+export type AttributeReport = TypeFromSchema<typeof TlvAttributeReport>;

package/src/protocol/types/TlvAttributeReportData.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvAny } from "../../tlv/TlvAny.js";
 import { TlvUInt32 } from "../../tlv/TlvNumber.js";
 import { TlvField, TlvObject, TlvOptionalField } from "../../tlv/TlvObject.js";
@@ -15,3 +16,5 @@ export const TlvAttributeReportData = TlvObject({
     path: TlvField(1, TlvAttributePath),
     data: TlvField(2, TlvAny),
 });
+
+export type AttributeReportData = TypeFromSchema<typeof TlvAttributeReportData>;

package/src/protocol/types/TlvAttributeStatus.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvField, TlvObject } from "../../tlv/TlvObject.js";
 import { TlvAttributePath } from "./TlvAttributePath.js";
 import { TlvStatus } from "./TlvStatus.js";
@@ -15,3 +16,5 @@ export const TlvAttributeStatus = TlvObject({
     path: TlvField(0, TlvAttributePath),
     status: TlvField(1, TlvStatus),
 });
+
+export type AttributeStatus = TypeFromSchema<typeof TlvAttributeStatus>;

package/src/protocol/types/TlvCommandData.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvAny } from "../../tlv/TlvAny.js";
 import { TlvUInt16 } from "../../tlv/TlvNumber.js";
 import { TlvField, TlvObject, TlvOptionalField } from "../../tlv/TlvObject.js";
@@ -17,3 +18,5 @@ export const TlvCommandData = TlvObject({
     commandFields: TlvOptionalField(1, TlvAny),
     commandRef: TlvOptionalField(2, TlvUInt16),
 });
+
+export type CommandData = TypeFromSchema<typeof TlvCommandData>;

package/src/protocol/types/TlvDataVersionFilter.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvUInt32 } from "../../tlv/TlvNumber.js";
 import { TlvField, TlvObject } from "../../tlv/TlvObject.js";
 import { TlvClusterPath } from "./TlvClusterPath.js";
@@ -15,3 +16,5 @@ export const TlvDataVersionFilter = TlvObject({
     path: TlvField(0, TlvClusterPath),
     dataVersion: TlvField(1, TlvUInt32),
 });
+
+export type DataVersionFilter = TypeFromSchema<typeof TlvDataVersionFilter>;

package/src/protocol/types/TlvEventData.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { EventPriority } from "../../cluster/Cluster.js";
 import { TlvEventNumber } from "../../datatype/EventNumber.js";
 import { TlvAny } from "../../tlv/TlvAny.js";
@@ -24,3 +25,5 @@ export const TlvEventData = TlvObject({
     deltaSystemTimestamp: TlvOptionalField(6, TlvSysTimeMS),
     data: TlvOptionalField(7, TlvAny),
 });
+
+export type EventData = TypeFromSchema<typeof TlvEventData>;

package/src/protocol/types/TlvEventFilter.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvNodeId } from "../../datatype/NodeId.js";
 import { TlvUInt64 } from "../../tlv/TlvNumber.js";
 import { TlvField, TlvObject, TlvOptionalField } from "../../tlv/TlvObject.js";
@@ -15,3 +16,5 @@ export const TlvEventFilter = TlvObject({
     nodeId: TlvOptionalField(0, TlvNodeId),
     eventMin: TlvField(1, TlvUInt64),
 });
+
+export type EventFilter = TypeFromSchema<typeof TlvEventFilter>;

package/src/protocol/types/TlvEventPath.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvClusterId } from "../../datatype/ClusterId.js";
 import { TlvEndpointNumber } from "../../datatype/EndpointNumber.js";
 import { TlvEventId } from "../../datatype/EventId.js";
@@ -21,3 +22,5 @@ export const TlvEventPath = TlvTaggedList({
     eventId: TlvOptionalField(3, TlvEventId),
     isUrgent: TlvOptionalField(4, TlvBoolean),
 });
+
+export type EventPath = TypeFromSchema<typeof TlvEventPath>;

package/src/protocol/types/TlvEventReport.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvObject, TlvOptionalField } from "../../tlv/TlvObject.js";
 import { TlvEventData } from "./TlvEventData.js";
 import { TlvEventStatus } from "./TlvEventStatus.js";
@@ -15,3 +16,5 @@ export const TlvEventReport = TlvObject({
     eventStatus: TlvOptionalField(0, TlvEventStatus),
     eventData: TlvOptionalField(1, TlvEventData),
 });
+
+export type EventReport = TypeFromSchema<typeof TlvEventReport>;

package/src/protocol/types/TlvEventStatus.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvField, TlvObject } from "../../tlv/TlvObject.js";
 import { TlvEventPath } from "./TlvEventPath.js";
 import { TlvStatus } from "./TlvStatus.js";
@@ -15,3 +16,5 @@ export const TlvEventStatus = TlvObject({
     path: TlvField(0, TlvEventPath),
     status: TlvField(1, TlvStatus),
 });
+
+export type EventStatus = TypeFromSchema<typeof TlvEventStatus>;

package/src/protocol/types/TlvInvokeResponseData.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { TypeFromSchema } from "#tlv/TlvSchema.js";
 import { TlvObject, TlvOptionalField } from "../../tlv/TlvObject.js";
 import { TlvCommandData } from "./TlvCommandData.js";
 import { TlvCommandStatus } from "./TlvCommandStatus.js";
@@ -15,3 +16,5 @@ export const TlvInvokeResponseData = TlvObject({
     command: TlvOptionalField(0, TlvCommandData),
     status: TlvOptionalField(1, TlvCommandStatus),
 });
+
+export type InvokeResponseData = TypeFromSchema<typeof TlvInvokeResponseData>;