@project-chip/matter.js 0.2.1 → 0.4.0

package/dist/es/cluster/AccessControlCluster.d.ts

@@ -0,0 +1,136 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Event, OptionalWritableAttribute, WritableAttribute } from "./Cluster.js";
+/**
+ * List of privileges that can be granted to a subject.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.10.5.3
+ */
+export declare const enum Privilege {
+    /** Can read and observe all (except Access Control Cluster and as seen by a non-Proxy). */
+    View = 1,
+    /** An read and observe all (as seen by a Proxy). */
+    ProxyView = 2,
+    /** View privileges, and can perform the primary function of this Node (except Access Control Cluster). */
+    Operate = 3,
+    /** Operate privileges, and can modify persistent configuration of this Node (except Access Control Cluster). */
+    Manage = 4,
+    /** Manage privileges, and can observe and modify the Access Control Cluster. */
+    Administer = 5
+}
+/**
+ * List of Auth Modes that can be used to authenticate a subject.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.10.5.3
+ */
+export declare const enum AuthMode {
+    /** Passcode authenticated session. */
+    PASE = 1,
+    /** Certificate authenticated session. */
+    CASE = 2,
+    /** Group authenticated session. */
+    Group = 3
+}
+/** @see {@link MatterCoreSpecificationV1_0} § 9.10.8.1 */
+export declare const enum ChangeTypeEnum {
+    /** Entry or extension was changed. */
+    Changed = 0,
+    /** Entry or extension was added. */
+    Added = 1,
+    /** Entry or extension was removed. */
+    Removed = 2
+}
+/**
+ * The Access Control Cluster exposes a data model view of a Node’s Access Control List (ACL),
+ * which codifies the rules used to manage and enforce Access Control for the Node’s endpoints
+ * and their associated cluster instances. Access to this Access Control Cluster itself requires
+ * a special Administer privilege level, such that only Nodes granted such privilege (hereafter
+ * termed "Administrators") can manage the Access Control Cluster.
+ * The Access Control Cluster SHALL be present on the root node endpoint of each Node, and SHALL
+ * NOT be present on any other Endpoint of any Node.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.10
+ */
+export declare const AccessControlCluster: Cluster<import("../schema/BitmapSchema.js").BitSchema, import("../schema/BitmapSchema.js").TypeFromBitSchema<import("../schema/BitmapSchema.js").BitSchema>, import("../util/Type.js").Merge<{
+    /** Codifies a single grant of privilege on this Node. */
+    acl: WritableAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+        /** Specifies the level of privilege granted by this Access Control Entry. */
+        privilege: import("../tlv/TlvObject.js").FieldType<Privilege>;
+        /** Specifies the authentication mode required by this Access Control Entry. */
+        authMode: import("../tlv/TlvObject.js").FieldType<AuthMode>;
+        /** Specifies a list of Subject IDs, to which this Access Control Entry grants access. */
+        subjects: import("../tlv/TlvObject.js").FieldType<import("../datatype/NodeId.js").NodeId[] | null>;
+        /** Specifies a list of TargetStruct, which define the clusters on this Node to which this Access Control Entry grants access. */
+        targets: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+            /** Cluster to grant access on. */
+            cluster: import("../tlv/TlvObject.js").FieldType<import("../datatype/ClusterId.js").ClusterId | null>;
+            /** Endpoint to grant access on. */
+            endpoint: import("../tlv/TlvObject.js").FieldType<import("../datatype/EndpointNumber.js").EndpointNumber | null>;
+            /** Device type to grant access on. */
+            deviceType: import("../tlv/TlvObject.js").FieldType<import("../datatype/DeviceTypeId.js").DeviceTypeId | null>;
+        }>[] | null>;
+    }>[]>;
+    /** MAY be used by Administrators to store arbitrary data related to fabric’s Access Control Entries. */
+    extension: OptionalWritableAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
+        /** Used by manufacturers to store arbitrary TLV-encoded data related to a fabric’s Access Control Entries. */
+        data: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    }>[]>;
+    /** Provide the minimum number of Subjects per entry that are supported by this server. */
+    subjectsPerAccessControlEntry: Attribute<number>;
+    /** Provides the minimum number of Targets per entry that are supported by this server. */
+    targetsPerAccessControlEntry: Attribute<number>;
+    /** Provides the minimum number of ACL Entries per fabric that are supported by this server. */
+    accessControlEntriesPerFabric: Attribute<number>;
+}, import("./Cluster.js").GlobalAttributes<import("../schema/BitmapSchema.js").BitSchema>>, import("./Cluster.js").Commands, {
+    /**
+     * The cluster SHALL send AccessControlEntryChanged events whenever its ACL attribute data is changed by an
+     * Administrator.
+     */
+    accessControlEntryChanged: Event<import("../tlv/TlvObject.js").TypeFromFields<{
+        /** The Node ID of the Administrator that made the change, if the change occurred via a CASE session. */
+        adminNodeID: import("../tlv/TlvObject.js").FieldType<import("../datatype/NodeId.js").NodeId | null>;
+        /** The Passcode ID of the Administrator that made the change, if the change occurred via a PASE session. */
+        adminPasscodeID: import("../tlv/TlvObject.js").FieldType<number | null>;
+        /** The type of change as appropriate. */
+        changeType: import("../tlv/TlvObject.js").FieldType<ChangeTypeEnum>;
+        /** The latest value of the changed entry. */
+        latestValue: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+            /** Specifies the level of privilege granted by this Access Control Entry. */
+            privilege: import("../tlv/TlvObject.js").FieldType<Privilege>;
+            /** Specifies the authentication mode required by this Access Control Entry. */
+            authMode: import("../tlv/TlvObject.js").FieldType<AuthMode>;
+            /** Specifies a list of Subject IDs, to which this Access Control Entry grants access. */
+            subjects: import("../tlv/TlvObject.js").FieldType<import("../datatype/NodeId.js").NodeId[] | null>;
+            /** Specifies a list of TargetStruct, which define the clusters on this Node to which this Access Control Entry grants access. */
+            targets: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+                /** Cluster to grant access on. */
+                cluster: import("../tlv/TlvObject.js").FieldType<import("../datatype/ClusterId.js").ClusterId | null>;
+                /** Endpoint to grant access on. */
+                endpoint: import("../tlv/TlvObject.js").FieldType<import("../datatype/EndpointNumber.js").EndpointNumber | null>;
+                /** Device type to grant access on. */
+                deviceType: import("../tlv/TlvObject.js").FieldType<import("../datatype/DeviceTypeId.js").DeviceTypeId | null>;
+            }>[] | null>;
+        }> | null>;
+    }>>;
+    /**
+     * The cluster SHALL send AccessControlExtensionChanged events whenever its extension attribute data is changed
+     * by an Administrator.
+     */
+    accessControlExtensionChanged: Event<import("../tlv/TlvObject.js").TypeFromFields<{
+        /** The Node ID of the Administrator that made the change, if the change occurred via a CASE session. */
+        adminNodeID: import("../tlv/TlvObject.js").FieldType<import("../datatype/NodeId.js").NodeId | null>;
+        /** The Passcode ID of the Administrator that made the change, if the change occurred via a PASE session. */
+        adminPasscodeID: import("../tlv/TlvObject.js").FieldType<number | null>;
+        /** The type of change as appropriate. */
+        changeType: import("../tlv/TlvObject.js").FieldType<ChangeTypeEnum>;
+        /** The latest value of the changed entry. */
+        latestValue: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
+            /** Used by manufacturers to store arbitrary TLV-encoded data related to a fabric’s Access Control Entries. */
+            data: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+        }> | null>;
+    }>>;
+}>;
+//# sourceMappingURL=AccessControlCluster.d.ts.map

package/dist/es/cluster/AccessControlCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessControlCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/AccessControlCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAe,SAAS,EAAE,OAAO,EAAE,KAAK,EAAiB,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAcnI;;;;GAIG;AACH,0BAAkB,SAAS;IACvB,2FAA2F;IAC3F,IAAI,IAAI;IAER,oDAAoD;IACpD,SAAS,IAAI;IAEb,0GAA0G;IAC1G,OAAO,IAAI;IAEX,gHAAgH;IAChH,MAAM,IAAI;IAEV,gFAAgF;IAChF,UAAU,IAAI;CACjB;AAED;;;;GAIG;AACH,0BAAkB,QAAQ;IACtB,sCAAsC;IACtC,IAAI,IAAI;IAER,yCAAyC;IACzC,IAAI,IAAI;IAER,mCAAmC;IACnC,KAAK,IAAI;CACZ;AAED,0DAA0D;AAC1D,0BAAkB,cAAc;IAC5B,sCAAsC;IACtC,OAAO,IAAI;IAEX,oCAAoC;IACpC,KAAK,IAAI;IAET,sCAAsC;IACtC,OAAO,IAAI;CACd;AA0DD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB;IAOzB,yDAAyD;;QApD7D,6EAA6E;;QAG7E,+EAA+E;;QAG/E,yFAAyF;;QAGzF,iIAAiI;;YArBjI,kCAAkC;;YAGlC,mCAAmC;;YAGnC,sCAAsC;;;;IA6DlC,wGAAwG;;QAxC5G,8GAA8G;;;IA2C1G,0FAA0F;;IAG1F,0FAA0F;;IAG1F,+FAA+F;;;IAM/F;;;OAGG;;QApDP,wGAAwG;;QAGxG,4GAA4G;;QAG5G,yCAAyC;;QAGzC,6CAA6C;;YA9B7C,6EAA6E;;YAG7E,+EAA+E;;YAG/E,yFAAyF;;YAGzF,iIAAiI;;gBArBjI,kCAAkC;;gBAGlC,mCAAmC;;gBAGnC,sCAAsC;;;;;IAkFlC;;;OAGG;;QA1DP,wGAAwG;;QAGxG,4GAA4G;;QAG5G,yCAAyC;;QAGzC,6CAA6C;;YAf7C,8GAA8G;;;;EAmEhH,CAAC"}

package/dist/es/cluster/AccessControlCluster.js

@@ -1,19 +1,19 @@
 /**
  * @license
- * Copyright 2022 Project CHIP Authors
+ * Copyright 2022-2023 Project CHIP Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Cluster, WritableAttribute, Attribute, Event, OptionalWritableAttribute } from "./Cluster.js";
-import { TlvClusterId } from "../common/ClusterId.js";
-import { TlvEndpointNumber } from "../common/EndpointNumber.js";
-import { TlvDeviceTypeId } from "../common/DeviceTypeId.js";
-import { TlvNodeId } from "../common/NodeId.js";
-import { TlvSubjectId } from "../common/SubjectId.js";
+import { Attribute, Cluster, Event, OptionalWritableAttribute, WritableAttribute } from "./Cluster.js";
 import { TlvField, TlvObject } from "../tlv/TlvObject.js";
 import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvClusterId } from "../datatype/ClusterId.js";
+import { TlvEndpointNumber } from "../datatype/EndpointNumber.js";
+import { TlvDeviceTypeId } from "../datatype/DeviceTypeId.js";
 import { TlvEnum, TlvUInt16 } from "../tlv/TlvNumber.js";
+import { TlvSubjectId } from "../datatype/SubjectId.js";
 import { TlvArray } from "../tlv/TlvArray.js";
 import { TlvByteString } from "../tlv/TlvString.js";
+import { TlvNodeId } from "../datatype/NodeId.js";
 /**
  *
  * Defines the clusters on this Node to which this Access Control Entry grants access.
@@ -29,7 +29,7 @@ const TlvTarget = TlvObject({
     /** Endpoint to grant access on. */
     endpoint: TlvField(1, TlvNullable(TlvEndpointNumber)),
     /** Device type to grant access on. */
-    deviceType: TlvField(1, TlvNullable(TlvDeviceTypeId)),
+    deviceType: TlvField(2, TlvNullable(TlvDeviceTypeId)),
 });
 /** @see {@link MatterCoreSpecificationV1_0} § 9.10.5.3 */
 const TlvAccessControlEntry = TlvObject({
@@ -40,12 +40,12 @@ const TlvAccessControlEntry = TlvObject({
     /** Specifies a list of Subject IDs, to which this Access Control Entry grants access. */
     subjects: TlvField(3, TlvNullable(TlvArray(TlvSubjectId))),
     /** Specifies a list of TargetStruct, which define the clusters on this Node to which this Access Control Entry grants access. */
-    targets: TlvField(4, TlvNullable(TlvArray(TlvTarget))), /* maxArrayLength: targetsPerAccessControlEntry */
+    targets: TlvField(4, TlvNullable(TlvArray(TlvTarget))), /* maxArrayLength: targetsPerAccessControlEntry, fabricSensitive: true */
 });
 /** @see {@link MatterCoreSpecificationV1_0} § 9.10.5.4 */
 const TlvAccessControlExtensionEntry = TlvObject({
     /** Used by manufacturers to store arbitrary TLV-encoded data related to a fabric’s Access Control Entries. */
-    data: TlvField(1, TlvByteString.bound({ maxLength: 128 })),
+    data: TlvField(1, TlvByteString.bound({ maxLength: 128 })), /* fabricSensitive: true */
 });
 /** @see {@link MatterCoreSpecificationV1_0} § 9.10.7.1 */
 const AccessChangeEvent = (entrySchema) => ({
@@ -71,7 +71,7 @@ const AccessChangeEvent = (entrySchema) => ({
  */
 export const AccessControlCluster = Cluster({
     id: 0x1f,
-    name: "Access Control",
+    name: "AccessControl",
     revision: 1,
     /** @see {@link MatterCoreSpecificationV1_0} § 9.10.5 */
     attributes: {
@@ -97,6 +97,7 @@ export const AccessControlCluster = Cluster({
          * The cluster SHALL send AccessControlExtensionChanged events whenever its extension attribute data is changed
          * by an Administrator.
          */
-        accessControlExtensionChanged: Event(1, 1 /* EventPriority.Info */, AccessChangeEvent(TlvAccessControlExtensionEntry)), /* readAcl: AccessLevel.Administer */
+        accessControlExtensionChanged: Event(1, 1 /* EventPriority.Info */, AccessChangeEvent(TlvAccessControlExtensionEntry)), /* readAcl: AccessLevel.Administer, fabricSensitive: true */
     },
 });
+//# sourceMappingURL=AccessControlCluster.js.map

package/dist/es/cluster/AccessControlCluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessControlCluster.js","sourceRoot":"","sources":["../../../src/cluster/AccessControlCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAe,SAAS,EAAE,OAAO,EAAE,KAAK,EAAiB,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEnI,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAoDlD;;;;;;;;GAQG;AACH,MAAM,SAAS,GAAG,SAAS,CAAC;IACxB,kCAAkC;IAClC,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;IAE/C,mCAAmC;IACnC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAErD,sCAAsC;IACtC,UAAU,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;CACxD,CAAC,CAAC;AAEH,0DAA0D;AAC1D,MAAM,qBAAqB,GAAG,SAAS,CAAC;IACpC,6EAA6E;IAC7E,SAAS,EAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAa,CAAC;IAE5C,+EAA+E;IAC/E,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAY,CAAC;IAE1C,yFAAyF;IACzF,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;IAE1D,iIAAiI;IACjI,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,yEAAyE;CACpI,CAAC,CAAC;AAEH,0DAA0D;AAC1D,MAAM,8BAA8B,GAAG,SAAS,CAAC;IAC7C,8GAA8G;IAC9G,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,EAAG,2BAA2B;CAC3F,CAAC,CAAC;AAEH,0DAA0D;AAC1D,MAAM,iBAAiB,GAAG,CAAI,WAAyB,EAAE,EAAE,CAAC,CAAC;IACzD,wGAAwG;IACxG,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAEhD,4GAA4G;IAC5G,eAAe,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAEpD,yCAAyC;IACzC,UAAU,EAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAkB,CAAC;IAElD,6CAA6C;IAC7C,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;CACrD,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,OAAO,CAAC;IACxC,EAAE,EAAE,IAAI;IACR,IAAI,EAAE,eAAe;IACrB,QAAQ,EAAE,CAAC;IAEX,wDAAwD;IACxD,UAAU,EAAE;QACR,yDAAyD;QACzD,GAAG,EAAE,iBAAiB,CAAC,CAAC,EAAE,QAAQ,CAAC,qBAAqB,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,gCAAwB,EAAE,OAAO,gCAAwB,EAAE,CAAC;QAE9I,wGAAwG;QACxG,SAAS,EAAE,yBAAyB,CAAC,CAAC,EAAE,QAAQ,CAAC,8BAA8B,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,gCAAwB,EAAE,OAAO,gCAAwB,EAAE,CAAC;QAErK,0FAA0F;QAC1F,6BAA6B,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAExF,0FAA0F;QAC1F,4BAA4B,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAEvF,+FAA+F;QAC/F,6BAA6B,EAAE,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;KAC3F;IAED,wDAAwD;IACxD,MAAM,EAAE;QACJ;;;WAGG;QACH,yBAAyB,EAAE,KAAK,CAAC,CAAC,8BAAsB,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAEjG;;;WAGG;QACH,6BAA6B,EAAE,KAAK,CAAC,CAAC,8BAAsB,iBAAiB,CAAC,8BAA8B,CAAC,CAAC,EAAE,4DAA4D;KAC/K;CACJ,CAAC,CAAC"}

package/dist/es/cluster/ActionsCluster.d.ts

@@ -0,0 +1,217 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Event, OptionalAttribute, OptionalCommand } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+/**
+ * Action error.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.9.3
+ */
+export declare const enum ActionErrorEnum {
+    /** Other reason not listed below */
+    Unknown = 0,
+    /** The action was inter­rupted by another com­mand or interaction */
+    Interrupted = 1
+}
+/**
+ * Action state.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.9.3
+ */
+export declare const enum ActionStateEnum {
+    /** The action is not active */
+    Inactive = 0,
+    /** The action is active */
+    Active = 1,
+    /** The action has been paused */
+    Paused = 2,
+    /** The action has been disabled */
+    Disabled = 3
+}
+/**
+ * Types of actions.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.9.2
+ */
+export declare const enum ActionTypeEnum {
+    /** Use this only when none of the other values applies */
+    Other = 0,
+    /** Bring the endpoints into a certain state */
+    Scene = 1,
+    /** A sequence of states with a certain time pattern */
+    Sequence = 2,
+    /** Control an automation (e.g. motion sensor controlling lights) */
+    Automation = 3,
+    /** Sequence that will run when something doesn’t happen*/
+    Exception = 4,
+    /** Use the endpoints to send a message to user*/
+    Notification = 5,
+    /** Higher priority notification */
+    Alarm = 6
+}
+/**
+ * Types of endpoint lists.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.9.6
+ */
+export declare const enum EndpointListType {
+    /** Another group of endpoints, tied specifically to this action, not independently created by the user.  */
+    Other = 0,
+    /** User-configured group of endpoints where an endpoint can be in only one room */
+    Room = 1,
+    /** User-configured group of endpoints where an endpoint can be in any number of zones */
+    Zone = 2
+}
+/**
+ * This cluster provides a standardized way for a Node (typically a Bridge, but could be any Node) to expose
+ *  * information about logical grouping of endpoints on the Node (example: lights in a room)
+ *  * information about named actions that can be performed on such a group of endpoints (example: recall a
+ *    scene for a group of lights by its name)
+ *  * commands to trigger such actions
+ *  * events to receive feedback on the state of such actions.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14
+ */
+export declare const ActionsCluster: Cluster<import("../schema/BitmapSchema.js").BitSchema, import("../schema/BitmapSchema.js").TypeFromBitSchema<import("../schema/BitmapSchema.js").BitSchema>, import("../util/Type.js").Merge<{
+    /** List of actions. */
+    actionList: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
+        /** Indicates the device type definition */
+        actionID: import("../tlv/TlvObject.js").FieldType<number>;
+        /** Indicates the implemented revision of the device type definition */
+        name: import("../tlv/TlvObject.js").FieldType<string>;
+        /** Indicates the type of endpoint list */
+        type: import("../tlv/TlvObject.js").FieldType<ActionTypeEnum>;
+        /** Provide a reference to the associated endpoint list, which specifies the endpoints on this Node which will be impacted by this ActionID */
+        endpointListId: import("../tlv/TlvObject.js").FieldType<number>;
+        /** A bitmap used to indicate which of the cluster’s commands are supported for this particular action */
+        supportedCommands: import("../tlv/TlvObject.js").FieldType<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+            /** This command triggers an action (state change) on the involved endpoints. */
+            instantAction: BitFlag;
+            /** This command triggers an action (state change) on the involved endpoints, with a specified time to transition from the current state to the new state. */
+            instantActionWithTransition: BitFlag;
+            /** This command triggers the commencement of an action on the involved endpoints. */
+            startAction: BitFlag;
+            /** This command triggers the commencement of an action (with a duration) on the involved endpoints. */
+            startActionWithDuration: BitFlag;
+            /** This command stops the ongoing action on the involved endpoints. */
+            stopAction: BitFlag;
+            /** This command pauses an ongoing action. */
+            pauseAction: BitFlag;
+            /** This command pauses an ongoing action with a duration. */
+            pauseActionWithDuration: BitFlag;
+            /** This command resumes a previously paused action. */
+            resumeAction: BitFlag;
+            /** This command enables a certain action or automation. */
+            enableAction: BitFlag;
+            /** This command enables a certain action or automation with a duration. */
+            enableActionWithDuration: BitFlag;
+            /** This command disables a certain action or automation. */
+            disableAction: BitFlag;
+            /** This command disables a certain action or automation with a duration. */
+            disableActionWithDuration: BitFlag;
+        }>>;
+        /** Indicates the current state of this action */
+        state: import("../tlv/TlvObject.js").FieldType<ActionStateEnum>;
+    }>[]>;
+    /** List of endpoint lists. */
+    endpointLists: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
+        /** Indicates the device type definition */
+        endpointListId: import("../tlv/TlvObject.js").FieldType<number>;
+        /** Indicates the implemented revision of the device type definition */
+        name: import("../tlv/TlvObject.js").FieldType<string>;
+        /** Indicates the type of endpoint list. */
+        type: import("../tlv/TlvObject.js").FieldType<EndpointListType>;
+        /** A list of endpoint numbers */
+        endpoints: import("../tlv/TlvObject.js").FieldType<import("../datatype/EndpointNumber.js").EndpointNumber[]>;
+    }>[]>;
+    /**
+     * When used without suffix, provides information about the various actions which
+     * the cluster provides.
+     * When used with a suffix of "/?a=" and the decimal value of ActionID for one of
+     * the actions, it may provide information about that particular action. */
+    setupURL: OptionalAttribute<string>;
+}, import("./Cluster.js").GlobalAttributes<import("../schema/BitmapSchema.js").BitSchema>>, {
+    /** This command triggers an action (state change) on the involved endpoints. */
+    instantAction: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+    }>, void>;
+    /** This command triggers an action (state change) on the involved endpoints, with a specified time to transition from the current state to the new state. */
+    instantActionWithTransition: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+        transitionTime: import("../tlv/TlvObject.js").FieldType<number>;
+    }>, void>;
+    /** This command triggers the commencement of an action on the involved endpoints. */
+    startAction: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+    }>, void>;
+    /** This command triggers the commencement of an action (with a duration) on the involved endpoints. */
+    startActionWithDuration: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+        duration: import("../tlv/TlvObject.js").FieldType<number>;
+    }>, void>;
+    /** This command stops the ongoing action on the involved endpoints. */
+    stopAction: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+    }>, void>;
+    /** This command pauses an ongoing action. */
+    pauseAction: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+    }>, void>;
+    /** This command pauses an ongoing action with a duration. */
+    pauseActionWithDuration: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+        duration: import("../tlv/TlvObject.js").FieldType<number>;
+    }>, void>;
+    /** This command resumes a previously paused action. */
+    resumeAction: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+    }>, void>;
+    /** This command enables a certain action or automation. */
+    enableAction: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+    }>, void>;
+    /** This command enables a certain action or automation with a duration. */
+    enableActionWithDuration: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+        duration: import("../tlv/TlvObject.js").FieldType<number>;
+    }>, void>;
+    /** This command disables a certain action or automation. */
+    disableAction: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+    }>, void>;
+    /** This command disables a certain action or automation with a duration. */
+    disableActionWithDuration: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").OptionalFieldType<number>;
+        duration: import("../tlv/TlvObject.js").FieldType<number>;
+    }>, void>;
+}, {
+    /** This event shall be generated when there is a change in the Status of an ActionID. */
+    stateChanged: Event<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").FieldType<number>;
+        newState: import("../tlv/TlvObject.js").FieldType<ActionStateEnum>;
+    }>>;
+    /** This event shall be generated when there is some error which prevents the action from its normal planned execution. */
+    actionFailed: Event<import("../tlv/TlvObject.js").TypeFromFields<{
+        actionId: import("../tlv/TlvObject.js").FieldType<number>;
+        invokeId: import("../tlv/TlvObject.js").FieldType<number>;
+        newState: import("../tlv/TlvObject.js").FieldType<ActionStateEnum>;
+        error: import("../tlv/TlvObject.js").FieldType<ActionErrorEnum>;
+    }>>;
+}>;
+//# sourceMappingURL=ActionsCluster.d.ts.map

package/dist/es/cluster/ActionsCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionsCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/ActionsCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAiB,iBAAiB,EAAE,eAAe,EAAiB,MAAM,cAAc,CAAC;AAC3H,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAqDpD;;;;GAIG;AACH,0BAAkB,eAAe;IAC7B,oCAAoC;IACpC,OAAO,IAAI;IAEX,qEAAqE;IACrE,WAAW,IAAI;CAElB;AAED;;;;GAIG;AACH,0BAAkB,eAAe;IAC7B,+BAA+B;IAC/B,QAAQ,IAAI;IAEZ,2BAA2B;IAC3B,MAAM,IAAI;IAEV,iCAAiC;IACjC,MAAM,IAAI;IAEV,mCAAmC;IACnC,QAAQ,IAAI;CACf;AAED;;;;GAIG;AACH,0BAAkB,cAAc;IAC5B,0DAA0D;IAC1D,KAAK,IAAI;IAET,+CAA+C;IAC/C,KAAK,IAAI;IAET,uDAAuD;IACvD,QAAQ,IAAI;IAEZ,oEAAoE;IACpE,UAAU,IAAI;IAEd,0DAA0D;IAC1D,SAAS,IAAI;IAEb,iDAAiD;IACjD,YAAY,IAAI;IAEhB,mCAAmC;IACnC,KAAK,IAAI;CACZ;AA4BD;;;;GAIG;AACH,0BAAkB,gBAAgB;IAC9B,4GAA4G;IAC5G,KAAK,IAAI;IAET,mFAAmF;IACnF,IAAI,IAAI;IAER,yFAAyF;IACzF,IAAI,IAAI;CACX;AAuHD;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc;IAOnB,uBAAuB;;QA1K3B,2CAA2C;;QAG3C,uEAAuE;;QAGvE,0CAA0C;;QAG1C,8IAA8I;;QAG9I,yGAAyG;;YArHzG,gFAAgF;;YAGhF,6JAA6J;;YAG7J,qFAAqF;;YAGrF,uGAAuG;;YAGvG,uEAAuE;;YAGvE,6CAA6C;;YAG7C,6DAA6D;;YAG7D,uDAAuD;;YAGvD,2DAA2D;;YAG3D,2EAA2E;;YAG3E,4DAA4D;;YAG5D,4EAA4E;;;QAuF5E,iDAAiD;;;IA8J7C,8BAA8B;;QAnIlC,2CAA2C;;QAG3C,uEAAuE;;QAGvE,2CAA2C;;QAG3C,iCAAiC;;;IA6H7B;;;;+EAI2E;;;IAI3E,gFAAgF;;;;;IAGhF,6JAA6J;;;;;;IAG7J,qFAAqF;;;;;IAGrF,uGAAuG;;;;;;IAGvG,uEAAuE;;;;;IAGvE,6CAA6C;;;;;IAG7C,6DAA6D;;;;;;IAG7D,uDAAuD;;;;;IAGvD,2DAA2D;;;;;IAG3D,2EAA2E;;;;;;IAG3E,4DAA4D;;;;;IAG5D,4EAA4E;;;;;;;IAI5E,yFAAyF;;;;;;IAGzF,0HAA0H;;;;;;;EAGhI,CAAC"}