@matter/node 0.16.0-alpha.0-20251101-70c8d51d7 → 0.16.0-alpha.0-20251103-b47ffa15b

package/dist/esm/behaviors/scenes-management/ScenesManagementServer.d.ts

@@ -3,11 +3,130 @@
  * Copyright 2022-2025 Matter.js Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-/*** THIS FILE WILL BE REGENERATED IF YOU DO NOT REMOVE THIS MESSAGE ***/
-import { ScenesManagementBehavior } from "./ScenesManagementBehavior.js";
+import { ClusterBehavior } from "#behavior/cluster/ClusterBehavior.js";
+import { ScenesManagement } from "#clusters/scenes-management";
+import { BasicSet, ObserverGroup } from "#general";
+import { Val } from "#protocol";
+import { AttributeId, ClusterId, FabricIndex, GroupId, TlvSchema } from "#types";
+import { MaybePromise } from "@matter/general";
+/** Internal meta information for sceneable attributes on the endpoint */
+type AttributeDetails = {
+    id: AttributeId;
+    name: string;
+    schema: TlvSchema<any>;
+    type: string;
+    mappedType: AttributeValuePairDataFields;
+    nullable: boolean;
+};
+/** Enum for the allowed fields in AttributeValuePair */
+declare const enum AttributeValuePairDataFields {
+    ValueUnsigned8 = "valueUnsigned8",
+    ValueSigned8 = "valueSigned8",
+    ValueUnsigned16 = "valueUnsigned16",
+    ValueSigned16 = "valueSigned16",
+    ValueUnsigned32 = "valueUnsigned32",
+    ValueSigned32 = "valueSigned32",
+    ValueUnsigned64 = "valueUnsigned64",
+    ValueSigned64 = "valueSigned64"
+}
+/** Mapping from Datatypes to the AttributeValuePair field to use and expect */
+export declare const DataTypeToSceneAttributeDataMap: Record<string, AttributeValuePairDataFields | undefined>;
+declare const ScenesManagementBase: ClusterBehavior.Type<import("#types").ClusterComposer.WithFeatures<ScenesManagement.Cluster, readonly [ScenesManagement.Feature]>, import("./ScenesManagementBehavior.js").ScenesManagementBehaviorConstructor, import("./ScenesManagementInterface.js").ScenesManagementInterface>;
 /**
  * This is the default server implementation of {@link ScenesManagementBehavior}.
+ * We implement the full Scenes Management cluster as specified in the Matter Spec.
+ * The SceneName feature is enabled by default.
+ *
+ * When a scene is applied/recalled then the relevant clusters are informed via the "applySceneValues" event they need
+ * to implement. If they do not implement the scene is not applied for that cluster.
  */
-export declare class ScenesManagementServer extends ScenesManagementBehavior {
+export declare class ScenesManagementServer extends ScenesManagementBase {
+    #private;
+    state: ScenesManagementServer.State;
+    protected internal: ScenesManagementServer.Internal;
+    initialize(): void;
+    /**
+     * Handles removal of one group in a fabric.
+     * This method is called by the GroupsServer implementation and also internally by this cluster.
+     */
+    removeScenesForGroupOnFabric(fabricIndex: FabricIndex, groupId: GroupId): void;
+    /** Handles removal of all groups in a fabric. This method is called by the GroupsServer implementation. */
+    removeScenesForAllGroupsForFabric(fabricIndex: FabricIndex): void;
+    /** Implements the AddScene command */
+    addScene({ groupId: reqGroupId, sceneId, sceneName, transitionTime, extensionFieldSetStructs, }: ScenesManagement.AddSceneRequest): ScenesManagement.AddSceneResponse;
+    /** Implements the ViewScene command */
+    viewScene({ groupId: reqGroupId, sceneId, }: ScenesManagement.ViewSceneRequest): ScenesManagement.ViewSceneResponse;
+    /** Implements the RemoveScene command */
+    removeScene({ groupId: reqGroupId, sceneId, }: ScenesManagement.RemoveSceneRequest): ScenesManagement.RemoveSceneResponse;
+    /** Implements the RemoveAllScenes command */
+    removeAllScenes({ groupId: reqGroupId, }: ScenesManagement.RemoveAllScenesRequest): ScenesManagement.RemoveAllScenesResponse;
+    /** Implements the StoreScene command */
+    storeScene({ groupId: reqGroupId, sceneId, }: ScenesManagement.StoreSceneRequest): ScenesManagement.StoreSceneResponse;
+    /** Implements the RecallScene command */
+    recallScene({ groupId: reqGroupId, sceneId, transitionTime }: ScenesManagement.RecallSceneRequest): Promise<void>;
+    /** Implements the GetSceneMembership command */
+    getSceneMembership({ groupId: reqGroupId, }: ScenesManagement.GetSceneMembershipRequest): ScenesManagement.GetSceneMembershipResponse;
+    /** Implements the CopyScene command */
+    copyScene({ mode, groupIdentifierFrom, sceneIdentifierFrom, groupIdentifierTo, sceneIdentifierTo, }: ScenesManagement.CopySceneRequest): ScenesManagement.CopySceneResponse;
+    /** Close the observers */
+    [Symbol.asyncDispose](): Promise<void>;
+    /** Method used by the OnOff cluster to recall the global scene */
+    recallGlobalScene(fabricIndex: FabricIndex): Promise<void>;
+    /** Method used by the OnOff cluster to store the global scene */
+    storeGlobalScene(fabricIndex: FabricIndex): void;
+    /**
+     * Main method for Clusters to Register themselves with their "Apply Scenes Callback".
+     *
+     * @param behavior ClusterBehavior implementing a cluster with sceneable attributes
+     * @param applyFunc Function that applies scene values for that cluster
+     */
+    implementScenes<T extends ClusterBehavior>(behavior: T, applyFunc: ScenesManagementServer.ApplySceneValuesFunc<T>): void;
+    /**
+     * Invalidate all fabric scene info entries.
+     * Method will be called by relevant clusters when commands change the state.
+     */
+    makeAllFabricSceneInfoEntriesInvalid(): void;
+}
+export declare namespace ScenesManagementServer {
+    /** Scene Attribute Data format used internally to store scene attribute values */
+    type SceneAttributeData = {
+        [key: string]: {
+            [key: string]: boolean | number | bigint | null;
+        };
+    };
+    /** Scene Table Entry as decorated class for persistence */
+    class ScenesTableEntry implements Omit<ScenesManagement.LogicalSceneTable, "extensionFields"> {
+        sceneGroupId: GroupId;
+        sceneId: number;
+        sceneName?: string;
+        sceneTransitionTime: number;
+        sceneValues: SceneAttributeData;
+        fabricIndex: FabricIndex;
+    }
+    class State extends ScenesManagementBase.State {
+        sceneTable: ScenesTableEntry[];
+    }
+    type ApplySceneValuesFunc<T extends ClusterBehavior> = (this: T, values: Val.Struct, transitionTime: number) => MaybePromise;
+    class Internal {
+        /** ObserverGroup for all $Changed events of sceneable attributes */
+        endpointSceneAttributeObservers: ObserverGroup;
+        /** Fabric index where a scene is currently valid, if any */
+        monitorSceneAttributesForFabric: FabricIndex | null;
+        /** Map of sceneable behaviors/clusters and their sceneable attributes on the endpoint */
+        endpointSceneableBehaviors: BasicSet<{
+            id: ClusterId;
+            name: string;
+            attributes: BasicSet<AttributeDetails>;
+            clusterBehaviorType: ClusterBehavior.Type;
+            applyFunc: ApplySceneValuesFunc<any>;
+        }, {
+            id: ClusterId;
+            name: string;
+            attributes: BasicSet<AttributeDetails>;
+            clusterBehaviorType: ClusterBehavior.Type;
+            applyFunc: ApplySceneValuesFunc<any>;
+        }>;
+    }
 }
+export {};
 //# sourceMappingURL=ScenesManagementServer.d.ts.map

package/dist/esm/behaviors/scenes-management/ScenesManagementServer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ScenesManagementServer.d.ts","sourceRoot":"","sources":["../../../../src/behaviors/scenes-management/ScenesManagementServer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,yEAAyE;AAEzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;CAAG"}
+{"version":3,"file":"ScenesManagementServer.d.ts","sourceRoot":"","sources":["../../../../src/behaviors/scenes-management/ScenesManagementServer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAEvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAA6C,aAAa,EAAa,MAAM,UAAU,CAAC;AAgCzG,OAAO,EAA0D,GAAG,EAAE,MAAM,WAAW,CAAC;AACxF,OAAO,EACH,WAAW,EACX,SAAS,EAET,WAAW,EACX,OAAO,EAWP,SAAS,EAKZ,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAc/C,yEAAyE;AACzE,KAAK,gBAAgB,GAAG;IACpB,EAAE,EAAE,WAAW,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,4BAA4B,CAAC;IACzC,QAAQ,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,wDAAwD;AACxD,mBAAW,4BAA4B;IACnC,cAAc,mBAAmB;IACjC,YAAY,iBAAiB;IAC7B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;CAClC;AAED,+EAA+E;AAC/E,eAAO,MAAM,+BAA+B,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,GAAG,SAAS,CAqBpG,CAAC;AAuEF,QAAA,MAAM,oBAAoB,qRAAqE,CAAC;AAEhG;;;;;;;GAOG;AACH,qBAAa,sBAAuB,SAAQ,oBAAoB;;IACpD,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC;IAC5C,UAAkB,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC;IAEnD,UAAU;IAenB;;;OAGG;IACH,4BAA4B,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO;IAiBvE,2GAA2G;IAC3G,iCAAiC,CAAC,WAAW,EAAE,WAAW;IAwD1D,sCAAsC;IAC7B,QAAQ,CAAC,EACd,OAAO,EAAE,UAAU,EACnB,OAAO,EACP,SAAS,EACT,cAAc,EACd,wBAAwB,GAC3B,EAAE,gBAAgB,CAAC,eAAe,GAAG,gBAAgB,CAAC,gBAAgB;IA4BvE,uCAAuC;IAC9B,SAAS,CAAC,EACf,OAAO,EAAE,UAAU,EACnB,OAAO,GACV,EAAE,gBAAgB,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,iBAAiB;IAyBzE,yCAAyC;IAChC,WAAW,CAAC,EACjB,OAAO,EAAE,UAAU,EACnB,OAAO,GACV,EAAE,gBAAgB,CAAC,kBAAkB,GAAG,gBAAgB,CAAC,mBAAmB;IA6B7E,6CAA6C;IACpC,eAAe,CAAC,EACrB,OAAO,EAAE,UAAU,GACtB,EAAE,gBAAgB,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,uBAAuB;IAWrF,wCAAwC;IAC/B,UAAU,CAAC,EAChB,OAAO,EAAE,UAAU,EACnB,OAAO,GACV,EAAE,gBAAgB,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,kBAAkB;IAyC3E,yCAAyC;IAC1B,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,gBAAgB,CAAC,kBAAkB;IAsBhH,gDAAgD;IACvC,kBAAkB,CAAC,EACxB,OAAO,EAAE,UAAU,GACtB,EAAE,gBAAgB,CAAC,yBAAyB,GAAG,gBAAgB,CAAC,0BAA0B;IAwB3F,uCAAuC;IAC9B,SAAS,CAAC,EACf,IAAI,EACJ,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,GACpB,EAAE,gBAAgB,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,iBAAiB;IAyDzE,0BAA0B;IACX,CAAC,MAAM,CAAC,YAAY,CAAC;IAIpC,kEAAkE;IAC5D,iBAAiB,CAAC,WAAW,EAAE,WAAW;IAUhD,iEAAiE;IACjE,gBAAgB,CAAC,WAAW,EAAE,WAAW;IA4PzC;;;;;OAKG;IACH,eAAe,CAAC,CAAC,SAAS,eAAe,EAAE,QAAQ,EAAE,CAAC,EAAE,SAAS,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IA4IjH;;;OAGG;IACH,oCAAoC;CAyFvC;AAED,yBAAiB,sBAAsB,CAAC;IACpC,kFAAkF;IAClF,KAAY,kBAAkB,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAA;KAAE,CAAC;IAExG,2DAA2D;IAC3D,MAAa,gBAAiB,YAAW,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;QAEhG,YAAY,EAAG,OAAO,CAAC;QAGvB,OAAO,EAAG,MAAM,CAAC;QAGjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAGnB,mBAAmB,EAAG,MAAM,CAAC;QAG7B,WAAW,EAAG,kBAAkB,CAAC;QAGjC,WAAW,EAAG,WAAW,CAAC;KAC7B;IAED,MAAa,KAAM,SAAQ,oBAAoB,CAAC,KAAK;QAEjD,UAAU,qBAAiC;KAC9C;IAED,KAAY,oBAAoB,CAAC,CAAC,SAAS,eAAe,IAAI,CAC1D,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,cAAc,EAAE,MAAM,KACrB,YAAY,CAAC;IAElB,MAAa,QAAQ;QACjB,oEAAoE;QACpE,+BAA+B,gBAAuB;QAEtD,4DAA4D;QAC5D,+BAA+B,EAAE,WAAW,GAAG,IAAI,CAAQ;QAE3D,yFAAyF;QACzF,0BAA0B;gBAClB,SAAS;kBACP,MAAM;wBACA,QAAQ,CAAC,gBAAgB,CAAC;iCACjB,eAAe,CAAC,IAAI;uBAC9B,oBAAoB,CAAC,GAAG,CAAC;;gBAJhC,SAAS;kBACP,MAAM;wBACA,QAAQ,CAAC,gBAAgB,CAAC;iCACjB,eAAe,CAAC,IAAI;uBAC9B,oBAAoB,CAAC,GAAG,CAAC;WACnC;KACR;CACJ"}