@matter/types 0.17.4 → 0.17.5-alpha.0-20260704-9ea70abfa

package/dist/cjs/clusters/groupcast.js

@@ -0,0 +1,34 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var groupcast_exports = {};
+__export(groupcast_exports, {
+  Groupcast: () => Groupcast,
+  GroupcastCluster: () => GroupcastCluster
+});
+module.exports = __toCommonJS(groupcast_exports);
+var import_ClusterType = require("../cluster/ClusterType.js");
+var import_model = require("@matter/model");
+/**
+ * @license
+ * Copyright 2022-2026 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const Groupcast = (0, import_ClusterType.ClusterType)(import_model.Groupcast);
+const GroupcastCluster = Groupcast;
+//# sourceMappingURL=groupcast.js.map

package/dist/cjs/clusters/groupcast.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/clusters/groupcast.js"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,yBAA4B;AAC5B,mBAA4C;AAT5C;AAAA;AAAA;AAAA;AAAA;AAWO,MAAM,gBAAY,gCAAY,aAAAA,SAAc;AAC5C,MAAM,mBAAmB;",
+  "names": ["GroupcastModel"]
+}

package/dist/cjs/clusters/groups.d.ts

@@ -16,6 +16,14 @@ import type { Status } from "../globals/Status.js";
 /**
  * Definitions for the Groups cluster.
  *
+ * > [!NOTE]
+ *
+ * > NOTE: Starting with the release of Matter when the Groupcast Cluster becomes certifiable, that cluster supersedes
+ *   this Groups Cluster. Groups created on devices prior to that Matter release remain operational via the PerGroup
+ *   feature in the Groupcast Cluster. All new group management operations SHOULD be performed through the Groupcast
+ *   Cluster. Device types with existing mandatory conformance to the Groups Cluster shall retain Groups server cluster
+ *   support for backward compatibility.
+ *
  * The Groups cluster manages, per endpoint, the content of the node-wide Group Table that is part of the underlying
  * interaction layer.
  *
@@ -32,7 +40,7 @@ import type { Status } from "../globals/Status.js";
  * Note that configuration of group addresses for outgoing commands is achieved using the Message Layer mechanisms where
  * the Group Table is not involved. Hence this cluster does not play a part in that.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 1.3
+ * @see {@link MatterSpecification.v16.Cluster} § 1.3
  */
 export declare namespace Groups {
     /**
@@ -46,7 +54,7 @@ export declare namespace Groups {
     export const name: "Groups";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 4;
 
@@ -66,7 +74,7 @@ export declare namespace Groups {
          * significant bit, bit 7 (GroupNames), shall be equal to bit 0 of the FeatureMap attribute (GN Feature). All
          * other bits shall be 0.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.6.1
          */
         nameSupport: NameSupportAttribute;
     }
@@ -83,7 +91,7 @@ export declare namespace Groups {
          * significant bit, bit 7 (GroupNames), shall be equal to bit 0 of the FeatureMap attribute (GN Feature). All
          * other bits shall be 0.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.6.1
          */
         nameSupport: NameSupportAttribute;
     }
@@ -95,7 +103,7 @@ export declare namespace Groups {
         /**
          * The AddGroup command allows a client to add group membership in a particular group for the server endpoint.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.1
          */
         addGroup(request: AddGroupRequest): MaybePromise<AddGroupResponse>;
 
@@ -103,7 +111,7 @@ export declare namespace Groups {
          * The ViewGroup command allows a client to request that the server responds with a ViewGroupResponse command
          * containing the name string for a particular group.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.2
          */
         viewGroup(request: ViewGroupRequest): MaybePromise<ViewGroupResponse>;
 
@@ -111,7 +119,7 @@ export declare namespace Groups {
          * The GetGroupMembership command allows a client to inquire about the group membership of the server endpoint,
          * in a number of ways.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.3
          */
         getGroupMembership(request: GetGroupMembershipRequest): MaybePromise<GetGroupMembershipResponse>;
 
@@ -119,7 +127,7 @@ export declare namespace Groups {
          * The RemoveGroup command allows a client to request that the server removes the membership for the server
          * endpoint, if any, in a particular group.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.4
          */
         removeGroup(request: RemoveGroupRequest): MaybePromise<RemoveGroupResponse>;
 
@@ -127,7 +135,7 @@ export declare namespace Groups {
          * The RemoveAllGroups command allows a client to direct the server to remove all group associations for the
          * server endpoint.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.5
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.5
          */
         removeAllGroups(): MaybePromise;
 
@@ -141,7 +149,7 @@ export declare namespace Groups {
          *
          * This command might be used to assist configuring group membership in the absence of a commissioning tool.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.6
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.6
          */
         addGroupIfIdentifying(request: AddGroupIfIdentifyingRequest): MaybePromise;
     }
@@ -157,7 +165,7 @@ export declare namespace Groups {
     /**
      * These are optional features supported by GroupsCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.4
      */
     export enum Feature {
         /**
@@ -165,7 +173,7 @@ export declare namespace Groups {
          *
          * The Group Names feature indicates the ability to store a name for a group when a group is added.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.4.1
          */
         GroupNames = "GroupNames"
     }
@@ -175,7 +183,7 @@ export declare namespace Groups {
      * significant bit, bit 7 (GroupNames), shall be equal to bit 0 of the FeatureMap attribute (GN Feature). All other
      * bits shall be 0.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.6.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.6.1
      */
     export class NameSupportAttribute {
         constructor(values?: Partial<NameSupportAttribute> | number);
@@ -185,7 +193,7 @@ export declare namespace Groups {
     /**
      * The AddGroup command allows a client to add group membership in a particular group for the server endpoint.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.1
      */
     export class AddGroupRequest {
         constructor(values?: Partial<AddGroupRequest>);
@@ -194,7 +202,7 @@ export declare namespace Groups {
          * This field shall be used to identify the group and any associated key material to which the server endpoint
          * is to be added.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.1.1
          */
         groupId: GroupId;
 
@@ -204,7 +212,7 @@ export declare namespace Groups {
          *
          * Support of group names is optional and is indicated by the FeatureMap and NameSupport attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.1.2
          */
         groupName: string;
     }
@@ -212,7 +220,7 @@ export declare namespace Groups {
     /**
      * The AddGroupResponse is sent by the Groups cluster server in response to an AddGroup command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.7
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.7
      */
     export class AddGroupResponse {
         constructor(values?: Partial<AddGroupResponse>);
@@ -220,14 +228,14 @@ export declare namespace Groups {
         /**
          * This field is set according to the Effect on Receipt section of the AddGroup command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.7.1
          */
         status: Status;
 
         /**
          * This field is set to the GroupID field of the received AddGroup command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.7.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.7.2
          */
         groupId: GroupId;
     }
@@ -236,7 +244,7 @@ export declare namespace Groups {
      * The ViewGroup command allows a client to request that the server responds with a ViewGroupResponse command
      * containing the name string for a particular group.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.2
      */
     export class ViewGroupRequest {
         constructor(values?: Partial<ViewGroupRequest>);
@@ -246,7 +254,7 @@ export declare namespace Groups {
     /**
      * The ViewGroupResponse command is sent by the Groups cluster server in response to a ViewGroup command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.8
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.8
      */
     export class ViewGroupResponse {
         constructor(values?: Partial<ViewGroupResponse>);
@@ -254,14 +262,14 @@ export declare namespace Groups {
         /**
          * This field is according to the Effect on Receipt section of the ViewGroup command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.8.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.8.1
          */
         status: Status;
 
         /**
          * This field is set to the GroupID field of the received ViewGroup command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.8.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.8.2
          */
         groupId: GroupId;
 
@@ -269,7 +277,7 @@ export declare namespace Groups {
          * If the status is SUCCESS, and group names are supported, this field is set to the group name associated with
          * that group in the Group Table; otherwise it is set to the empty string.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.8.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.8.3
          */
         groupName: string;
     }
@@ -278,7 +286,7 @@ export declare namespace Groups {
      * The GetGroupMembership command allows a client to inquire about the group membership of the server endpoint, in a
      * number of ways.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.3
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.3
      */
     export class GetGroupMembershipRequest {
         constructor(values?: Partial<GetGroupMembershipRequest>);
@@ -289,7 +297,7 @@ export declare namespace Groups {
      * The GetGroupMembershipResponse command is sent by the Groups cluster server in response to a GetGroupMembership
      * command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.9
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.9
      */
     export class GetGroupMembershipResponse {
         constructor(values?: Partial<GetGroupMembershipResponse>);
@@ -305,7 +313,7 @@ export declare namespace Groups {
          *
          *   - null - It is unknown if any further groups may be added.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.9.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.9.1
          */
         capacity: number | null;
 
@@ -319,7 +327,7 @@ export declare namespace Groups {
          * payload length of a frame to be exceeded, then the GroupList field shall contain only as many groups as will
          * fit.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.9.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.9.2
          */
         groupList: GroupId[];
     }
@@ -328,7 +336,7 @@ export declare namespace Groups {
      * The RemoveGroup command allows a client to request that the server removes the membership for the server
      * endpoint, if any, in a particular group.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.4
      */
     export class RemoveGroupRequest {
         constructor(values?: Partial<RemoveGroupRequest>);
@@ -338,7 +346,7 @@ export declare namespace Groups {
     /**
      * The RemoveGroupResponse command is generated by the server in response to the receipt of a RemoveGroup command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.10
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.10
      */
     export class RemoveGroupResponse {
         constructor(values?: Partial<RemoveGroupResponse>);
@@ -346,14 +354,14 @@ export declare namespace Groups {
         /**
          * This field is according to the Effect on Receipt section of the RemoveGroup command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.10.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.10.1
          */
         status: Status;
 
         /**
          * This field is set to the GroupID field of the received RemoveGroup command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.10.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.10.2
          */
         groupId: GroupId;
     }
@@ -368,7 +376,7 @@ export declare namespace Groups {
      *
      * This command might be used to assist configuring group membership in the absence of a commissioning tool.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.6
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.6
      */
     export class AddGroupIfIdentifyingRequest {
         constructor(values?: Partial<AddGroupIfIdentifyingRequest>);
@@ -377,7 +385,7 @@ export declare namespace Groups {
          * This field shall be used to identify the group and any associated key material to which the server endpoint
          * is to be added.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.6.1
          */
         groupId: GroupId;
 
@@ -387,13 +395,13 @@ export declare namespace Groups {
          *
          * Support of group names is optional and is indicated by the FeatureMap and NameSupport attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.3.7.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.3.7.6.2
          */
         groupName: string;
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Cluster} § 1.3.5.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.3.5.1
      */
     export class NameSupport {
         constructor(values?: Partial<NameSupport> | number);

package/dist/cjs/clusters/hepa-filter-monitoring.d.ts

@@ -27,7 +27,7 @@ export declare namespace HepaFilterMonitoring {
     export const name: "HepaFilterMonitoring";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 1;
 
@@ -46,7 +46,7 @@ export declare namespace HepaFilterMonitoring {
          * This attribute shall be populated with a value from ChangeIndicationEnum that is indicative of the current
          * requirement to change the resource.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.3
          */
         changeIndication: ResourceMonitoring.ChangeIndication;
 
@@ -54,7 +54,7 @@ export declare namespace HepaFilterMonitoring {
          * Indicates whether a resource is currently installed. A value of true shall indicate that a resource is
          * installed. A value of false shall indicate that a resource is not installed.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.4
          */
         inPlaceIndicator?: boolean;
 
@@ -62,7 +62,7 @@ export declare namespace HepaFilterMonitoring {
          * This attribute may indicates the time at which the resource has been changed, if supported by the server. The
          * attribute shall be null if it was never set or is unknown.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.5
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.5
          */
         lastChangedTime?: number | null;
     }
@@ -74,7 +74,7 @@ export declare namespace HepaFilterMonitoring {
         /**
          * Indicates the current condition of the resource in percent.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.1
          */
         condition: number;
 
@@ -82,7 +82,7 @@ export declare namespace HepaFilterMonitoring {
          * Indicates the direction of change for the condition of the resource over time, which helps to determine
          * whether a higher or lower condition value is considered optimal.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.2
          */
         degradationDirection: ResourceMonitoring.DegradationDirection;
     }
@@ -95,7 +95,7 @@ export declare namespace HepaFilterMonitoring {
          * Indicates the list of supported products that may be used as replacements for the current resource. Each item
          * in this list represents a unique ReplacementProductStruct.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.6
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.6
          */
         replacementProductList: ResourceMonitoring.ReplacementProduct[];
     }
@@ -111,7 +111,7 @@ export declare namespace HepaFilterMonitoring {
          * This attribute shall be populated with a value from ChangeIndicationEnum that is indicative of the current
          * requirement to change the resource.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.3
          */
         changeIndication: ResourceMonitoring.ChangeIndication;
 
@@ -119,7 +119,7 @@ export declare namespace HepaFilterMonitoring {
          * Indicates whether a resource is currently installed. A value of true shall indicate that a resource is
          * installed. A value of false shall indicate that a resource is not installed.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.4
          */
         inPlaceIndicator: boolean;
 
@@ -127,14 +127,14 @@ export declare namespace HepaFilterMonitoring {
          * This attribute may indicates the time at which the resource has been changed, if supported by the server. The
          * attribute shall be null if it was never set or is unknown.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.5
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.5
          */
         lastChangedTime: number | null;
 
         /**
          * Indicates the current condition of the resource in percent.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.1
          */
         condition: number;
 
@@ -142,7 +142,7 @@ export declare namespace HepaFilterMonitoring {
          * Indicates the direction of change for the condition of the resource over time, which helps to determine
          * whether a higher or lower condition value is considered optimal.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.2
          */
         degradationDirection: ResourceMonitoring.DegradationDirection;
 
@@ -150,7 +150,7 @@ export declare namespace HepaFilterMonitoring {
          * Indicates the list of supported products that may be used as replacements for the current resource. Each item
          * in this list represents a unique ReplacementProductStruct.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.6.6
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.6.6
          */
         replacementProductList: ResourceMonitoring.ReplacementProduct[];
     }
@@ -165,7 +165,7 @@ export declare namespace HepaFilterMonitoring {
          * LastChangedTime to be updated automatically based on the clock of the server, if the server supports setting
          * the attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 2.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 2.8.7.1
          */
         resetCondition(): MaybePromise;
     }
@@ -185,7 +185,7 @@ export declare namespace HepaFilterMonitoring {
     /**
      * These are optional features supported by HepaFilterMonitoringCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 2.8.4
+     * @see {@link MatterSpecification.v16.Cluster} § 2.8.4
      */
     export enum Feature {
         /**