@matter/types 0.11.0-alpha.0-20241005-e3e4e4a7a

package/dist/esm/cluster/ClusterHelper.js

@@ -0,0 +1,158 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Diagnostic, Logger } from "#general";
+import { Cluster } from "./Cluster.js";
+import { ClusterRegistry } from "./ClusterRegistry.js";
+const logger = Logger.get("ClusterHelper");
+const clusterAttributeCache = /* @__PURE__ */ new Map();
+const clusterEventCache = /* @__PURE__ */ new Map();
+const clusterCommandCache = /* @__PURE__ */ new Map();
+const UnknownCluster = (clusterId) => Cluster({
+  id: clusterId,
+  name: `Unknown cluster ${toHex(clusterId)}`,
+  revision: 0,
+  unknown: true
+});
+function getClusterNameById(clusterId) {
+  return ClusterRegistry.get(clusterId)?.name ?? `Unknown cluster ${Diagnostic.hex(clusterId)}`;
+}
+function getClusterById(clusterId) {
+  let cluster = ClusterRegistry.get(clusterId);
+  if (cluster === void 0) {
+    logger.info(`Unknown cluster ${toHex(clusterId)} requested: UnknownCluster instance added.`);
+    cluster = UnknownCluster(clusterId);
+    ClusterRegistry.register(cluster);
+  }
+  return cluster;
+}
+function getClusterAttributeById(clusterDef, attributeId) {
+  if (!clusterAttributeCache.has(clusterDef.id)) {
+    const attributeMap2 = /* @__PURE__ */ new Map();
+    const { attributes } = clusterDef;
+    for (const attributeName in attributes) {
+      const attribute = attributes[attributeName];
+      attributeMap2.set(attribute.id, { attribute, name: attributeName });
+    }
+    clusterAttributeCache.set(clusterDef.id, attributeMap2);
+    return attributeMap2.get(attributeId);
+  }
+  const attributeMap = clusterAttributeCache.get(clusterDef.id);
+  if (attributeMap === void 0) {
+    return void 0;
+  }
+  return attributeMap.get(attributeId);
+}
+function getClusterEventById(clusterDef, eventId) {
+  if (!clusterEventCache.has(clusterDef.id)) {
+    const eventMap2 = /* @__PURE__ */ new Map();
+    const { events } = clusterDef;
+    for (const eventName in events) {
+      const event = events[eventName];
+      eventMap2.set(event.id, { event, name: eventName });
+    }
+    clusterEventCache.set(clusterDef.id, eventMap2);
+    return eventMap2.get(eventId);
+  }
+  const eventMap = clusterEventCache.get(clusterDef.id);
+  if (eventMap === void 0) {
+    return void 0;
+  }
+  return eventMap.get(eventId);
+}
+function getClusterCommandById(clusterDef, commandId) {
+  if (!clusterCommandCache.has(clusterDef.id)) {
+    const commandMap2 = /* @__PURE__ */ new Map();
+    const { commands } = clusterDef;
+    for (const commandName in commands) {
+      const command = commands[commandName];
+      commandMap2.set(command.requestId, { command, name: commandName });
+    }
+    clusterCommandCache.set(clusterDef.id, commandMap2);
+    return commandMap2.get(commandId);
+  }
+  const commandMap = clusterCommandCache.get(clusterDef.id);
+  if (commandMap === void 0) {
+    return void 0;
+  }
+  return commandMap.get(commandId);
+}
+function toHex(value) {
+  return value === void 0 ? "*" : `0x${value.toString(16)}`;
+}
+function resolveEndpointClusterName(nodeId, endpointId, clusterId) {
+  let elementName = nodeId === void 0 ? "" : `${toHex(nodeId)}/`;
+  if (endpointId === void 0) {
+    elementName += "*";
+  } else {
+    elementName += `${toHex(endpointId)}`;
+  }
+  if (clusterId === void 0) {
+    return `${elementName}/*`;
+  }
+  const cluster = getClusterById(clusterId);
+  if (cluster.unknown) {
+    return `${elementName}/unknown(${toHex(clusterId)})`;
+  }
+  return `${elementName}/${cluster.name}(${toHex(clusterId)})`;
+}
+function resolveAttributeName({
+  nodeId,
+  endpointId,
+  clusterId,
+  attributeId
+}) {
+  const endpointClusterName = resolveEndpointClusterName(nodeId, endpointId, clusterId);
+  if (endpointId === void 0 || clusterId === void 0 || attributeId === void 0) {
+    return `${endpointClusterName}/${toHex(attributeId)}`;
+  }
+  const cluster = getClusterById(clusterId);
+  const attribute = getClusterAttributeById(cluster, attributeId);
+  if (attribute === void 0) {
+    return `${endpointClusterName}/unknown(${toHex(attributeId)})`;
+  }
+  return `${endpointClusterName}/${attribute.name}(${toHex(attributeId)})`;
+}
+function resolveEventName({
+  nodeId,
+  endpointId,
+  clusterId,
+  eventId,
+  isUrgent
+}) {
+  const isUrgentStr = isUrgent ? "!" : "";
+  const endpointClusterName = resolveEndpointClusterName(nodeId, endpointId, clusterId);
+  if (endpointId === void 0 || clusterId === void 0 || eventId === void 0) {
+    return `${isUrgentStr}${endpointClusterName}/${toHex(eventId)}`;
+  }
+  const event = getClusterEventById(getClusterById(clusterId), eventId);
+  if (event === void 0) {
+    return `${isUrgentStr}${endpointClusterName}/unknown(${toHex(eventId)})`;
+  }
+  return `${isUrgentStr}${endpointClusterName}/${event.name}(${toHex(eventId)})`;
+}
+function resolveCommandName({ endpointId, clusterId, commandId }) {
+  const endpointClusterName = resolveEndpointClusterName(void 0, endpointId, clusterId);
+  if (endpointId === void 0 || clusterId === void 0 || commandId === void 0) {
+    return `${endpointClusterName}/${toHex(commandId)}`;
+  }
+  const command = getClusterCommandById(getClusterById(clusterId), commandId);
+  if (command === void 0) {
+    return `${endpointClusterName}/unknown(${toHex(commandId)})`;
+  }
+  return `${endpointClusterName}/${command.name}(${toHex(commandId)})`;
+}
+export {
+  UnknownCluster,
+  getClusterAttributeById,
+  getClusterById,
+  getClusterCommandById,
+  getClusterEventById,
+  getClusterNameById,
+  resolveAttributeName,
+  resolveCommandName,
+  resolveEventName
+};
+//# sourceMappingURL=ClusterHelper.js.map

package/dist/esm/cluster/ClusterHelper.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/cluster/ClusterHelper.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,SAAS,YAAY,cAAc;AASnC,SAAoB,eAA+B;AACnD,SAAS,uBAAuB;AAEhC,MAAM,SAAS,OAAO,IAAI,eAAe;AAczC,MAAM,wBAAwB,oBAAI,IAAsD;AACxF,MAAM,oBAAoB,oBAAI,IAA8C;AAC5E,MAAM,sBAAsB,oBAAI,IAAkD;AAE3E,MAAM,iBAAiB,CAAC,cAC3B,QAAQ;AAAA,EACJ,IAAI;AAAA,EACJ,MAAM,mBAAmB,MAAM,SAAS,CAAC;AAAA,EACzC,UAAU;AAAA,EACV,SAAS;AACb,CAAC;AAEE,SAAS,mBAAmB,WAA8B;AAC7D,SAAO,gBAAgB,IAAI,SAAS,GAAG,QAAQ,mBAAmB,WAAW,IAAI,SAAS,CAAC;AAC/F;AAEO,SAAS,eAAe,WAAwD;AACnF,MAAI,UAAU,gBAAgB,IAAI,SAAS;AAC3C,MAAI,YAAY,QAAW;AACvB,WAAO,KAAK,mBAAmB,MAAM,SAAS,CAAC,4CAA4C;AAC3F,cAAU,eAAe,SAAS;AAClC,oBAAgB,SAAS,OAAO;AAAA,EACpC;AACA,SAAO;AACX;AAEO,SAAS,wBACZ,YACA,aAC+B;AAC/B,MAAI,CAAC,sBAAsB,IAAI,WAAW,EAAE,GAAG;AAC3C,UAAMA,gBAAe,oBAAI,IAAsC;AAE/D,UAAM,EAAE,WAAW,IAAI;AAGvB,eAAW,iBAAiB,YAAY;AACpC,YAAM,YAAY,WAAW,aAAa;AAC1C,MAAAA,cAAa,IAAI,UAAU,IAAI,EAAE,WAAW,MAAM,cAAc,CAAC;AAAA,IACrE;AAEA,0BAAsB,IAAI,WAAW,IAAIA,aAAY;AACrD,WAAOA,cAAa,IAAI,WAAW;AAAA,EACvC;AACA,QAAM,eAAe,sBAAsB,IAAI,WAAW,EAAE;AAC5D,MAAI,iBAAiB,QAAW;AAC5B,WAAO;AAAA,EACX;AACA,SAAO,aAAa,IAAI,WAAW;AACvC;AAEO,SAAS,oBACZ,YACA,SAC2B;AAC3B,MAAI,CAAC,kBAAkB,IAAI,WAAW,EAAE,GAAG;AACvC,UAAMC,YAAW,oBAAI,IAA8B;AAEnD,UAAM,EAAE,OAAO,IAAI;AAGnB,eAAW,aAAa,QAAQ;AAC5B,YAAM,QAAQ,OAAO,SAAS;AAC9B,MAAAA,UAAS,IAAI,MAAM,IAAI,EAAE,OAAO,MAAM,UAAU,CAAC;AAAA,IACrD;AAEA,sBAAkB,IAAI,WAAW,IAAIA,SAAQ;AAC7C,WAAOA,UAAS,IAAI,OAAO;AAAA,EAC/B;AACA,QAAM,WAAW,kBAAkB,IAAI,WAAW,EAAE;AACpD,MAAI,aAAa,QAAW;AACxB,WAAO;AAAA,EACX;AACA,SAAO,SAAS,IAAI,OAAO;AAC/B;AAEO,SAAS,sBACZ,YACA,WAC6B;AAC7B,MAAI,CAAC,oBAAoB,IAAI,WAAW,EAAE,GAAG;AACzC,UAAMC,cAAa,oBAAI,IAAkC;AAEzD,UAAM,EAAE,SAAS,IAAI;AAGrB,eAAW,eAAe,UAAU;AAChC,YAAM,UAAU,SAAS,WAAW;AACpC,MAAAA,YAAW,IAAI,QAAQ,WAAW,EAAE,SAAS,MAAM,YAAY,CAAC;AAAA,IACpE;AAEA,wBAAoB,IAAI,WAAW,IAAIA,WAAU;AACjD,WAAOA,YAAW,IAAI,SAAS;AAAA,EACnC;AACA,QAAM,aAAa,oBAAoB,IAAI,WAAW,EAAE;AACxD,MAAI,eAAe,QAAW;AAC1B,WAAO;AAAA,EACX;AACA,SAAO,WAAW,IAAI,SAAS;AACnC;AAEA,SAAS,MAAM,OAAoC;AAC/C,SAAO,UAAU,SAAY,MAAM,KAAK,MAAM,SAAS,EAAE,CAAC;AAC9D;AAEA,SAAS,2BACL,QACA,YACA,WACF;AACE,MAAI,cAAc,WAAW,SAAY,KAAK,GAAG,MAAM,MAAM,CAAC;AAC9D,MAAI,eAAe,QAAW;AAC1B,mBAAe;AAAA,EACnB,OAAO;AACH,mBAAe,GAAG,MAAM,UAAU,CAAC;AAAA,EACvC;AAEA,MAAI,cAAc,QAAW;AACzB,WAAO,GAAG,WAAW;AAAA,EACzB;AACA,QAAM,UAAU,eAAe,SAAS;AACxC,MAAI,QAAQ,SAAS;AACjB,WAAO,GAAG,WAAW,YAAY,MAAM,SAAS,CAAC;AAAA,EACrD;AACA,SAAO,GAAG,WAAW,IAAI,QAAQ,IAAI,IAAI,MAAM,SAAS,CAAC;AAC7D;AAEO,SAAS,qBAAqB;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ,GAA4C;AACxC,QAAM,sBAAsB,2BAA2B,QAAQ,YAAY,SAAS;AACpF,MAAI,eAAe,UAAa,cAAc,UAAa,gBAAgB,QAAW;AAClF,WAAO,GAAG,mBAAmB,IAAI,MAAM,WAAW,CAAC;AAAA,EACvD;AACA,QAAM,UAAU,eAAe,SAAS;AACxC,QAAM,YAAY,wBAAwB,SAAS,WAAW;AAC9D,MAAI,cAAc,QAAW;AACzB,WAAO,GAAG,mBAAmB,YAAY,MAAM,WAAW,CAAC;AAAA,EAC/D;AACA,SAAO,GAAG,mBAAmB,IAAI,UAAU,IAAI,IAAI,MAAM,WAAW,CAAC;AACzE;AAEO,SAAS,iBAAiB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ,GAAwC;AACpC,QAAM,cAAc,WAAW,MAAM;AACrC,QAAM,sBAAsB,2BAA2B,QAAQ,YAAY,SAAS;AACpF,MAAI,eAAe,UAAa,cAAc,UAAa,YAAY,QAAW;AAC9E,WAAO,GAAG,WAAW,GAAG,mBAAmB,IAAI,MAAM,OAAO,CAAC;AAAA,EACjE;AACA,QAAM,QAAQ,oBAAoB,eAAe,SAAS,GAAG,OAAO;AACpE,MAAI,UAAU,QAAW;AACrB,WAAO,GAAG,WAAW,GAAG,mBAAmB,YAAY,MAAM,OAAO,CAAC;AAAA,EACzE;AACA,SAAO,GAAG,WAAW,GAAG,mBAAmB,IAAI,MAAM,IAAI,IAAI,MAAM,OAAO,CAAC;AAC/E;AAEO,SAAS,mBAAmB,EAAE,YAAY,WAAW,UAAU,GAA0C;AAC5G,QAAM,sBAAsB,2BAA2B,QAAW,YAAY,SAAS;AACvF,MAAI,eAAe,UAAa,cAAc,UAAa,cAAc,QAAW;AAChF,WAAO,GAAG,mBAAmB,IAAI,MAAM,SAAS,CAAC;AAAA,EACrD;AACA,QAAM,UAAU,sBAAsB,eAAe,SAAS,GAAG,SAAS;AAC1E,MAAI,YAAY,QAAW;AACvB,WAAO,GAAG,mBAAmB,YAAY,MAAM,SAAS,CAAC;AAAA,EAC7D;AACA,SAAO,GAAG,mBAAmB,IAAI,QAAQ,IAAI,IAAI,MAAM,SAAS,CAAC;AACrE;",
+  "names": ["attributeMap", "eventMap", "commandMap"]
+}

package/dist/esm/cluster/ClusterRegistry.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ClusterType } from "./ClusterType.js";
+/**
+ * The formal definitions of clusters in Matter.js are generated
+ * programmatically.
+ *
+ * This singleton acts as a registry for generated {@link ClusterType}s.
+ */
+export declare namespace ClusterRegistry {
+    /**
+     * Obtain a cluster for a given ID.
+     */
+    function get(id: number): ClusterType | undefined;
+    /**
+     * Register a cluster for global access.
+     */
+    function register(cluster: ClusterType): void;
+}
+//# sourceMappingURL=ClusterRegistry.d.ts.map

package/dist/esm/cluster/ClusterRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClusterRegistry.d.ts","sourceRoot":"","sources":["../../../src/cluster/ClusterRegistry.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C;;;;;GAKG;AACH,yBAAiB,eAAe,CAAC;IAC7B;;OAEG;IACH,SAAgB,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAEvD;IAED;;OAEG;IACH,SAAgB,QAAQ,CAAC,OAAO,EAAE,WAAW,QAU5C;CACJ"}

package/dist/esm/cluster/ClusterRegistry.js

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const registered = {};
+var ClusterRegistry;
+((ClusterRegistry2) => {
+  function get(id) {
+    return registered[id];
+  }
+  ClusterRegistry2.get = get;
+  function register(cluster) {
+    if (!cluster) {
+      return;
+    }
+    if (cluster.id === void 0) {
+      return;
+    }
+    registered[cluster.id] = cluster;
+  }
+  ClusterRegistry2.register = register;
+})(ClusterRegistry || (ClusterRegistry = {}));
+export {
+  ClusterRegistry
+};
+//# sourceMappingURL=ClusterRegistry.js.map

package/dist/esm/cluster/ClusterRegistry.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/cluster/ClusterRegistry.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,MAAM,aAAa,CAAC;AAQb,IAAU;AAAA,CAAV,CAAUA,qBAAV;AAII,WAAS,IAAI,IAAqC;AACrD,WAAO,WAAW,EAAE;AAAA,EACxB;AAFO,EAAAA,iBAAS;AAOT,WAAS,SAAS,SAAsB;AAC3C,QAAI,CAAC,SAAS;AACV;AAAA,IACJ;AAEA,QAAI,QAAQ,OAAO,QAAW;AAC1B;AAAA,IACJ;AAEA,eAAW,QAAQ,EAAE,IAAI;AAAA,EAC7B;AAVO,EAAAA,iBAAS;AAAA,GAXH;",
+  "names": ["ClusterRegistry"]
+}

package/dist/esm/cluster/ClusterType.d.ts

@@ -0,0 +1,227 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Branded, Merge } from "#general";
+import { ClusterId } from "../datatype/ClusterId.js";
+import { BitSchema, TypeFromPartialBitSchema } from "../schema/BitmapSchema.js";
+import { TlvSchema } from "../tlv/TlvSchema.js";
+import { Attribute as ClusterAttribute, Command as ClusterCommand, Event as ClusterEvent, GlobalAttributes } from "./Cluster.js";
+/**
+ * A "cluster" is a grouping of related functionality that a Matter endpoint supports.
+ *
+ * ClusterType describes the functionality of a specific type of cluster.
+ */
+export interface ClusterType extends ClusterType.Identity, ClusterType.Features<BitSchema>, ClusterType.Elements {
+}
+/**
+ * Define a cluster.
+ */
+export declare function ClusterType<const T extends ClusterType.Options>(options: T): ClusterType.Of<T>;
+export declare namespace ClusterType {
+    /**
+     * Definition of a cluster attribute.
+     */
+    type Attribute = ClusterAttribute<any, any>;
+    /**
+     * Definition of a cluster command.
+     */
+    type Command = ClusterCommand<any, any, any>;
+    /**
+     * Definition of a cluster event.
+     */
+    type Event = ClusterEvent<any, any>;
+    /**
+     * A fully typed {@link ClusterType} for an {@link Options} type.
+     */
+    interface Of<T extends Options> {
+        id: Branded<T["id"], "ClusterId">;
+        name: T["name"];
+        revision: T["revision"];
+        features: T["features"] extends {} ? T["features"] : {};
+        supportedFeatures: T["supportedFeatures"] extends {} ? T["supportedFeatures"] : {};
+        attributes: T["attributes"] extends infer A extends {} ? Merge<A, GlobalAttributes<T["features"] extends {} ? T["features"] : {}>> : {};
+        commands: T["commands"] extends {} ? T["commands"] : {};
+        events: T["events"] extends {} ? T["events"] : {};
+        unknown: T["unknown"] extends boolean ? T["unknown"] : false;
+        base: T["base"] extends {} ? T["base"] : undefined;
+        extensions: T["extensions"] extends {} ? T["extensions"] : undefined;
+    }
+    /**
+     * Input to {@link ClusterType} function.  This is a relaxed extension of
+     * {@link ClusterType} with empty objects optional.
+     */
+    type Options<F extends BitSchema = {}> = {
+        id: number;
+    } & Omit<ClusterType.Identity, "id"> & Partial<ClusterType.Features<F>> & {
+        attributes?: ClusterType.ElementSet<ClusterType.Attribute>;
+        commands?: ClusterType.ElementSet<ClusterType.Command>;
+        events?: ClusterType.ElementSet<ClusterType.Event>;
+    };
+    /**
+     * Fields that uniquely identify a cluster.
+     */
+    interface Identity {
+        readonly id: ClusterId;
+        readonly name: string;
+        readonly revision: number;
+    }
+    /**
+     * An "element set" defines the set of elements (commands, attributes or events) of a cluster.
+     */
+    type ElementSet<T> = Record<string, T>;
+    /**
+     * Cluster "elements" are attributes, commands and events that may comprise a cluster.
+     */
+    interface Elements {
+        /**
+         * Attributes supported by the cluster.
+         */
+        readonly attributes: ElementSet<Attribute>;
+        /**
+         * Commands supported by the cluster.
+         */
+        readonly commands: ElementSet<Command>;
+        /**
+         * Events supported by the cluster.
+         */
+        readonly events: ElementSet<Event>;
+    }
+    /**
+     * Cluster "features" describe the features supported by a cluster.
+     */
+    interface Features<F extends BitSchema = {}> {
+        /**
+         * Features the cluster may support.
+         */
+        readonly features: F;
+        /**
+         * Features the cluster does support.
+         */
+        readonly supportedFeatures: TypeFromPartialBitSchema<F>;
+        /**
+         * Metadata controlling how enabled features affect cluster structure.
+         */
+        readonly extensions?: readonly Extension<F>[];
+        /**
+         * If you enable features, this property tracks the shape of the cluster with no features enabled.
+         */
+        readonly base?: ClusterType;
+        /**
+         * If true, this flag indicates that the cluster is not known to matter.js.  This implies a cluster ID for which
+         * we do not have a cluster definition.
+         *
+         * Some functionality is available for unknown clusters but an official Matter definition is generally required
+         * for full functionality.
+         */
+        readonly unknown: boolean;
+    }
+    /**
+     * Extract the type of a cluster's attributes (excluding global attributes).
+     */
+    type AttributesOf<C> = C extends {
+        attributes: infer E extends {
+            [K in string]: ClusterType.Attribute;
+        };
+    } ? {
+        -readonly [K in keyof E as string extends K ? never : K extends keyof GlobalAttributes<any> ? never : K]: C["attributes"][K];
+    } : EmptyElementSet<Attribute>;
+    /**
+     * Extract the type of a cluster's commands.
+     */
+    type CommandsOf<C> = C extends {
+        commands: infer E extends {
+            [K in string]: ClusterType.Command;
+        };
+    } ? {
+        -readonly [K in keyof E as string extends K ? never : K]: E[K];
+    } : EmptyElementSet<Command>;
+    /**
+     * Extract the type of a cluster's events.
+     */
+    type EventsOf<C> = C extends {
+        events: infer E extends {
+            [K in string]: ClusterType.Event;
+        };
+    } ? {
+        -readonly [K in keyof E as string extends K ? never : K]: E[K];
+    } : EmptyElementSet<Event>;
+    /**
+     * This bit of hackery describes a set that has no elements but for which typescript thinks it knows the type if you
+     * index generically by string.
+     */
+    type EmptyElementSet<T> = Record<string, never> & Record<string, T>;
+    /**
+     * The collective object type of the cluster's attributes.
+     */
+    type AttributeValues<T> = ValuesOfAttributes<ClusterType.AttributesOf<T>>;
+    type ValuesOfAttributes<AttrsT extends {
+        [K: string]: Attribute;
+    }> = {
+        [K in keyof AttrsT as [AttrsT[K]] extends [{
+            optional: true;
+        }] ? never : K]: AttrsT[K] extends {
+            schema: TlvSchema<infer T>;
+        } ? T : never;
+    } & {
+        [K in keyof AttrsT as [AttrsT[K]] extends [{
+            optional: true;
+        }] ? K : never]?: AttrsT[K] extends {
+            schema: TlvSchema<infer T>;
+        } ? T : never;
+    };
+    type RelaxTypes<V> = V extends number ? number : V extends bigint ? bigint : V extends object ? V extends (...args: any[]) => any ? V : {
+        [K in keyof V]: RelaxTypes<V[K]>;
+    } : V;
+    type PatchType<V> = V extends (infer E)[] ? Record<`${number}`, PatchType<E>> | PatchType<E>[] : V extends number ? number : V extends bigint ? bigint : V extends object ? V extends (...args: any[]) => any ? never : {
+        [K in keyof V]?: PatchType<V[K]>;
+    } : V;
+    /**
+     * A slightly relaxed version of AttributeValues for input.
+     */
+    type InputAttributeValues<T extends ClusterType> = RelaxTypes<AttributeValues<T>>;
+    /**
+     * Matter clusters support named "features" that enable sets of optional functionality.
+     *
+     * There is not a 1:1 mapping between features and cluster elements.  Some elements are enabled only when specific
+     * features are enabled or disabled in combination.
+     *
+     * Further, some features are mutually exclusive and thus do not generate a valid cluster when used in combination.
+     *
+     * This type describes a feature combination and how it alters a cluster. ClusterComposer uses this metadata to
+     * generate clusters based on selected features.
+     */
+    interface Extension<F extends BitSchema = {}> {
+        /**
+         * Flags indicating the features for which this extension applies.
+         *
+         * For each feature the flag is a tri-state component:
+         *
+         *   - true = feature is required to enable extension
+         *
+         *   - false = extension cannot be enabled if feature is enabled
+         *
+         *   - undefined = feature is not irrelevant for the extension
+         */
+        flags: TypeFromPartialBitSchema<F>;
+        /**
+         * The elements to inject if the flags match active features.  If the component is "false" the cluster cannot be
+         * instantiated with the feature combination.
+         */
+        component: false | Partial<Elements>;
+    }
+    /**
+     * A placeholder cluster.
+     */
+    const Unknown: Of<{
+        readonly id: 0;
+        readonly revision: 0;
+        readonly name: "Unknown";
+        readonly attributes: {};
+        readonly commands: {};
+        readonly events: {};
+    }>;
+    type Unknown = typeof Unknown;
+}
+//# sourceMappingURL=ClusterType.d.ts.map

package/dist/esm/cluster/ClusterType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClusterType.d.ts","sourceRoot":"","sources":["../../../src/cluster/ClusterType.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAIhD,OAAO,EACH,SAAS,IAAI,gBAAgB,EAC7B,OAAO,IAAI,cAAc,EACzB,KAAK,IAAI,YAAY,EACrB,gBAAgB,EACnB,MAAM,cAAc,CAAC;AAEtB;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,QAAQ;CAAG;AAEnH;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,qBA4B1E;AAED,yBAAiB,WAAW,CAAC;IACzB;;OAEG;IACH,KAAY,SAAS,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAEnD;;OAEG;IACH,KAAY,OAAO,GAAG,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAEpD;;OAEG;IACH,KAAY,KAAK,GAAG,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE3C;;OAEG;IACH,UAAiB,EAAE,CAAC,CAAC,SAAS,OAAO;QACjC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;QAClC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;QACxB,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QACxD,iBAAiB,EAAE,CAAC,CAAC,mBAAmB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC;QACnF,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,MAAM,CAAC,SAAS,EAAE,GAChD,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,GACzE,EAAE,CAAC;QACT,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QACxD,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QAClD,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;QAC7D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;QACnD,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;KACxE;IAED;;;OAGG;IACH,KAAY,OAAO,CAAC,CAAC,SAAS,SAAS,GAAG,EAAE,IAAI;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,GAC7F,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG;QAC/B,UAAU,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC3D,QAAQ,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;KACtD,CAAC;IAEN;;OAEG;IACH,UAAiB,QAAQ;QACrB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC;QACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC7B;IAED;;OAEG;IACH,KAAY,UAAU,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE9C;;OAEG;IACH,UAAiB,QAAQ;QACrB;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;QAE3C;;WAEG;QACH,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAEvC;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;KACtC;IAED;;OAEG;IACH,UAAiB,QAAQ,CAAC,CAAC,SAAS,SAAS,GAAG,EAAE;QAC9C;;WAEG;QACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,iBAAiB,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;QAExD;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QAE9C;;WAEG;QACH,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC;QAE5B;;;;;;WAMG;QACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;KAC7B;IAED;;OAEG;IACH,KAAY,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS;QAAE,UAAU,EAAE,MAAM,CAAC,SAAS;aAAG,CAAC,IAAI,MAAM,GAAG,WAAW,CAAC,SAAS;SAAE,CAAA;KAAE,GAC1G;QACI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,SAAS,CAAC,GACrC,KAAK,GACL,CAAC,SAAS,MAAM,gBAAgB,CAAC,GAAG,CAAC,GACnC,KAAK,GACL,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;KACjC,GACD,eAAe,CAAC,SAAS,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAY,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS;QAAE,QAAQ,EAAE,MAAM,CAAC,SAAS;aAAG,CAAC,IAAI,MAAM,GAAG,WAAW,CAAC,OAAO;SAAE,CAAA;KAAE,GACpG;QACI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACjE,GACD,eAAe,CAAC,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAY,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;QAAE,MAAM,EAAE,MAAM,CAAC,SAAS;aAAG,CAAC,IAAI,MAAM,GAAG,WAAW,CAAC,KAAK;SAAE,CAAA;KAAE,GAC9F;QACI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACjE,GACD,eAAe,CAAC,KAAK,CAAC,CAAC;IAE7B;;;OAGG;IACH,KAAY,eAAe,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE3E;;OAEG;IACH,KAAY,eAAe,CAAC,CAAC,IAAI,kBAAkB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjF,KAAY,kBAAkB,CAAC,MAAM,SAAS;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,IAAI;SACvE,CAAC,IAAI,MAAM,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAAE,QAAQ,EAAE,IAAI,CAAA;SAAE,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS;YAC3F,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;SAC9B,GACK,CAAC,GACD,KAAK;KACd,GAAG;SACC,CAAC,IAAI,MAAM,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAAE,QAAQ,EAAE,IAAI,CAAA;SAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS;YAC5F,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;SAC9B,GACK,CAAC,GACD,KAAK;KACd,CAAC;IAEF,KAAY,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACtC,MAAM,GACN,CAAC,SAAS,MAAM,GACd,MAAM,GACN,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAC7B,CAAC,GACD;SACK,CAAC,IAAI,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KACnC,GACL,CAAC,CAAC;IAEZ,KAAY,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC1C,MAAM,CAAC,GAAG,MAAM,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,GAClD,CAAC,SAAS,MAAM,GACd,MAAM,GACN,CAAC,SAAS,MAAM,GACd,MAAM,GACN,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAC7B,KAAK,GACL;SACK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KACnC,GACL,CAAC,CAAC;IAEd;;OAEG;IACH,KAAY,oBAAoB,CAAC,CAAC,SAAS,WAAW,IAAI,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzF;;;;;;;;;;OAUG;IACH,UAAiB,SAAS,CAAC,CAAC,SAAS,SAAS,GAAG,EAAE;QAC/C;;;;;;;;;;WAUG;QACH,KAAK,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;QAEnC;;;WAGG;QACH,SAAS,EAAE,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;KACxC;IAED;;OAEG;IACI,MAAM,OAAO;;;;;;;MAQlB,CAAC;IACH,KAAY,OAAO,GAAG,OAAO,OAAO,CAAC;CACxC"}

package/dist/esm/cluster/ClusterType.js

@@ -0,0 +1,46 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ClusterId } from "../datatype/ClusterId.js";
+import {
+  GlobalAttributes
+} from "./Cluster.js";
+function ClusterType(options) {
+  const cluster = {
+    id: ClusterId(options.id),
+    name: options.name,
+    revision: options.revision,
+    features: options.features ?? {},
+    supportedFeatures: options.supportedFeatures ?? {},
+    attributes: {
+      ...options.attributes,
+      ...GlobalAttributes(options.features ?? {})
+    },
+    commands: options.commands ?? {},
+    events: options.events ?? {},
+    unknown: false
+  };
+  if (options.base) {
+    cluster.base = options.base;
+  }
+  if (options.extensions) {
+    cluster.extensions = options.extensions;
+  }
+  return cluster;
+}
+((ClusterType2) => {
+  ClusterType2.Unknown = ClusterType2({
+    id: 0,
+    revision: 0,
+    name: "Unknown",
+    attributes: {},
+    commands: {},
+    events: {}
+  });
+})(ClusterType || (ClusterType = {}));
+export {
+  ClusterType
+};
+//# sourceMappingURL=ClusterType.js.map

package/dist/esm/cluster/ClusterType.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/cluster/ClusterType.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,SAAS,iBAAiB;AAM1B;AAAA,EAII;AAAA,OACG;AAYA,SAAS,YAAiD,SAAY;AACzE,QAAM,UAAU;AAAA,IACZ,IAAI,UAAU,QAAQ,EAAE;AAAA,IACxB,MAAM,QAAQ;AAAA,IACd,UAAU,QAAQ;AAAA,IAElB,UAAU,QAAQ,YAAY,CAAC;AAAA,IAC/B,mBAAmB,QAAQ,qBAAqB,CAAC;AAAA,IAEjD,YAAY;AAAA,MACR,GAAG,QAAQ;AAAA,MACX,GAAG,iBAAiB,QAAQ,YAAY,CAAC,CAAC;AAAA,IAC9C;AAAA,IACA,UAAU,QAAQ,YAAY,CAAC;AAAA,IAC/B,QAAQ,QAAQ,UAAU,CAAC;AAAA,IAE3B,SAAS;AAAA,EACb;AAEA,MAAI,QAAQ,MAAM;AACd,YAAQ,OAAO,QAAQ;AAAA,EAC3B;AAEA,MAAI,QAAQ,YAAY;AACpB,YAAQ,aAAa,QAAQ;AAAA,EACjC;AAEA,SAAO;AACX;AAAA,CAEO,CAAUA,iBAAV;AA4OI,EAAMA,aAAA,UAAUA,aAAY;AAAA,IAC/B,IAAI;AAAA,IACJ,UAAU;AAAA,IACV,MAAM;AAAA,IAEN,YAAY,CAAC;AAAA,IACb,UAAU,CAAC;AAAA,IACX,QAAQ,CAAC;AAAA,EACb,CAAC;AAAA,GApPY;",
+  "names": ["ClusterType"]
+}

package/dist/esm/cluster/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import "../clusters/index.js";
+export * from "./Cluster.js";
+export * from "./ClusterHelper.js";
+export * from "./ClusterRegistry.js";
+export * from "./ClusterType.js";
+export * from "./mutation/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/cluster/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cluster/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,sBAAsB,CAAC;AAE9B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC"}

package/dist/esm/cluster/index.js

@@ -0,0 +1,12 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import "../clusters/index.js";
+export * from "./Cluster.js";
+export * from "./ClusterHelper.js";
+export * from "./ClusterRegistry.js";
+export * from "./ClusterType.js";
+export * from "./mutation/index.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/cluster/index.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/cluster/index.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,OAAO;AAEP,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
+  "names": []
+}