Refactor Legacy stuff (#2045)

* Refactor Legacy stuff

* typo

* remove unneeded class

Author: Apollon77

CHANGELOG.md

@@ -34,6 +34,7 @@ The main work (all changes without a GitHub username in brackets in the below li
 
 -   @matter/protocol
     - Breaking: `logEndpoint()` was removed. The Endpoints support logging directly via Diagnostics
+    - Breaking: All legacy used *Server classes (AttributeServer, EventServer, CommandServer) are moved to the matter.js legacy package
     - Feature: Added `getLocal()` to AttributeClient to retrieve the currently stored/cached value 
     - Adjustment: ACL writes are not sent chunked by default from now on like also in chip SDK
     - Fix: Handles messages only that are secured as required for the relevant protocol

packages/matter.js/src/cluster/export.ts

@@ -4,5 +4,4 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export * from "./server/ClusterServer.js";
-export * from "./server/ClusterServerTypes.js";
+export * from "./server/index.js";

packages/protocol/src/cluster/server/AttributeServer.ts renamed to packages/matter.js/src/cluster/server/AttributeServer.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { Endpoint } from "#device/Endpoint.js";
 import {
     Diagnostic,
     ImplementationError,
@@ -15,6 +16,7 @@ import {
     isDeepEqual,
 } from "#general";
 import { AccessLevel, AttributeModel, ClusterModel, DatatypeModel, FabricIndex, MatterModel } from "#model";
+import { Fabric, Message, NoAssociatedFabricError, SecureSession, Session, assertSecureSession } from "#protocol";
 import {
     Attribute,
     AttributeId,
@@ -29,11 +31,6 @@ import {
     TypeFromPartialBitSchema,
     ValidationError,
 } from "#types";
-import { Message } from "../../codec/MessageCodec.js";
-import { EndpointInterface } from "../../endpoint/EndpointInterface.js";
-import { Fabric } from "../../fabric/Fabric.js";
-import { NoAssociatedFabricError, SecureSession, assertSecureSession } from "../../session/SecureSession.js";
-import { Session } from "../../session/Session.js";
 import { ClusterDatasource } from "./ClusterDatasource.js";
 
 const logger = Logger.get("AttributeServer");
@@ -70,9 +67,9 @@ export function createAttributeServer<
     attributeName: string,
     initValue: T,
     datasource: ClusterDatasource,
-    getter?: (session?: Session, endpoint?: EndpointInterface, isFabricFiltered?: boolean, message?: Message) => T,
-    setter?: (value: T, session?: Session, endpoint?: EndpointInterface, message?: Message) => boolean,
-    validator?: (value: T, session?: Session, endpoint?: EndpointInterface) => void,
+    getter?: (session?: Session, endpoint?: Endpoint, isFabricFiltered?: boolean, message?: Message) => T,
+    setter?: (value: T, session?: Session, endpoint?: Endpoint, message?: Message) => boolean,
+    validator?: (value: T, session?: Session, endpoint?: Endpoint) => void,
 ) {
     const {
         id,
@@ -150,7 +147,7 @@ export abstract class BaseAttributeServer<T> {
      * The value is undefined when getter/setter are used. But we still handle the version number here.
      */
     protected value: T | undefined = undefined;
-    protected endpoint?: EndpointInterface;
+    protected endpoint?: Endpoint;
     readonly defaultValue: T;
     #readAcl: AccessLevel | undefined;
     #writeAcl: AccessLevel | undefined;
@@ -203,7 +200,7 @@ export abstract class BaseAttributeServer<T> {
         }
     }
 
-    assignToEndpoint(endpoint: EndpointInterface) {
+    assignToEndpoint(endpoint: Endpoint) {
         this.endpoint = endpoint;
     }
 
@@ -230,7 +227,7 @@ export class FixedAttributeServer<T> extends BaseAttributeServer<T> {
     readonly isFixed: boolean = true;
     protected readonly getter: (
         session?: Session,
-        endpoint?: EndpointInterface,
+        endpoint?: Endpoint,
         isFabricFiltered?: boolean,
         message?: Message,
     ) => T;
@@ -256,7 +253,7 @@ export class FixedAttributeServer<T> extends BaseAttributeServer<T> {
          * @param isFabricFiltered whether the read request is fabric scoped or not
          * @param message the wire message that initiated the request (if any)
          */
-        getter?: (session?: Session, endpoint?: EndpointInterface, isFabricFiltered?: boolean, message?: Message) => T,
+        getter?: (session?: Session, endpoint?: Endpoint, isFabricFiltered?: boolean, message?: Message) => T,
     ) {
         super(
             id,
@@ -375,13 +372,8 @@ export class AttributeServer<T> extends FixedAttributeServer<T> {
     override readonly isFixed = false;
     protected readonly valueChangeListeners = new Array<(value: T, version: number) => void>();
     protected readonly valueSetListeners = new Array<(newValue: T, oldValue: T) => void>();
-    protected readonly setter: (
-        value: T,
-        session?: Session,
-        endpoint?: EndpointInterface,
-        message?: Message,
-    ) => boolean;
-    protected readonly validator: (value: T, session?: Session, endpoint?: EndpointInterface) => void;
+    protected readonly setter: (value: T, session?: Session, endpoint?: Endpoint, message?: Message) => boolean;
+    protected readonly validator: (value: T, session?: Session, endpoint?: Endpoint) => void;
     protected delayedChangeData?: DelayedChangeData = undefined;
 
     constructor(
@@ -396,7 +388,7 @@ export class AttributeServer<T> extends FixedAttributeServer<T> {
         initValue: T,
         defaultValue: T | undefined,
         datasource: ClusterDatasource,
-        getter?: (session?: Session, endpoint?: EndpointInterface, isFabricFiltered?: boolean, message?: Message) => T,
+        getter?: (session?: Session, endpoint?: Endpoint, isFabricFiltered?: boolean, message?: Message) => T,
 
         /**
          * Optional setter function to handle special requirements or the data are stored in different places. If a
@@ -408,7 +400,7 @@ export class AttributeServer<T> extends FixedAttributeServer<T> {
          * @param endpoint the endpoint the cluster server of this attribute is assigned to.
          * @returns true if the value has changed, false otherwise.
          */
-        setter?: (value: T, session?: Session, endpoint?: EndpointInterface, message?: Message) => boolean,
+        setter?: (value: T, session?: Session, endpoint?: Endpoint, message?: Message) => boolean,
 
         /**
          * Optional Validator function to handle special requirements for verification of stored data. The method should
@@ -421,7 +413,7 @@ export class AttributeServer<T> extends FixedAttributeServer<T> {
          * @param session the session that is requesting the value (if any).
          * @param endpoint the endpoint the cluster server of this attribute is assigned to.
          */
-        validator?: (value: T, session?: Session, endpoint?: EndpointInterface) => void,
+        validator?: (value: T, session?: Session, endpoint?: Endpoint) => void,
     ) {
         if (
             isWritable &&
@@ -746,9 +738,9 @@ export class FabricScopedAttributeServer<T> extends AttributeServer<T> {
         defaultValue: T | undefined,
         readonly cluster: Cluster<any, any, any, any, any>,
         datasource: ClusterDatasource,
-        getter?: (session?: Session, endpoint?: EndpointInterface, isFabricFiltered?: boolean) => T,
-        setter?: (value: T, session?: Session, endpoint?: EndpointInterface, message?: Message) => boolean,
-        validator?: (value: T, session?: Session, endpoint?: EndpointInterface) => void,
+        getter?: (session?: Session, endpoint?: Endpoint, isFabricFiltered?: boolean) => T,
+        setter?: (value: T, session?: Session, endpoint?: Endpoint, message?: Message) => boolean,
+        validator?: (value: T, session?: Session, endpoint?: Endpoint) => void,
     ) {
         if (
             isWritable &&

packages/protocol/src/cluster/server/ClusterDatasource.ts renamed to packages/matter.js/src/cluster/server/ClusterDatasource.ts

@@ -4,9 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { OccurrenceManager } from "#events/OccurrenceManager.js";
-import { Fabric } from "#fabric/Fabric.js";
 import { SupportedStorageTypes } from "#general";
+import { Fabric, OccurrenceManager } from "#protocol";
 
 export interface ClusterDatasource {
     readonly version: number;

packages/matter.js/src/cluster/server/ClusterServer.ts

@@ -6,14 +6,7 @@
 
 import { capitalize, Diagnostic, ImplementationError, InternalError, Logger, MaybePromise } from "#general";
 import { AccessLevel } from "#model";
-import {
-    ClusterServer as BaseClusterServer,
-    ClusterDatasource,
-    CommandServer,
-    createAttributeServer,
-    createEventServer,
-    Fabric,
-} from "#protocol";
+import { Fabric } from "#protocol";
 import {
     AttributeId,
     BitSchema,
@@ -26,6 +19,8 @@ import {
     TypeFromPartialBitSchema,
 } from "#types";
 import { Endpoint } from "../../device/Endpoint.js";
+import { createAttributeServer } from "./AttributeServer.js";
+import { ClusterDatasource } from "./ClusterDatasource.js";
 import {
     AttributeInitialValues,
     AttributeServers,
@@ -35,6 +30,8 @@ import {
     EventServers,
     SupportedEventsList,
 } from "./ClusterServerTypes.js";
+import { CommandServer } from "./CommandServer.js";
+import { createEventServer } from "./EventServer.js";
 
 const logger = Logger.get("ClusterServer");
 
@@ -53,7 +50,7 @@ function isConditionMatching<F extends BitSchema, SF extends TypeFromPartialBitS
 /**
  * A collection of servers for a cluster's attributes, commands and events.
  */
-export interface ClusterServer<T extends ClusterType = ClusterType> extends BaseClusterServer {
+export interface ClusterServer<T extends ClusterType = ClusterType> {
     /**
      * Cluster ID
      */

packages/matter.js/src/cluster/server/ClusterServerTypes.ts

@@ -5,17 +5,7 @@
  */
 
 import { Merge } from "#general";
-import {
-    AnyEventServer,
-    AttributeServer,
-    ClusterClientObj,
-    CommandServer,
-    Fabric,
-    FabricScopedAttributeServer,
-    FixedAttributeServer,
-    Message,
-    Session,
-} from "#protocol";
+import { ClusterClientObj, Fabric, Message, Session } from "#protocol";
 import {
     Attribute,
     AttributeId,
@@ -48,7 +38,10 @@ import {
     WritableFabricScopedAttribute,
 } from "#types";
 import { Endpoint } from "../../device/Endpoint.js";
+import { AttributeServer, FabricScopedAttributeServer, FixedAttributeServer } from "./AttributeServer.js";
 import { type ClusterServer } from "./ClusterServer.js";
+import { CommandServer } from "./CommandServer.js";
+import { AnyEventServer } from "./EventServer.js";
 
 /** Cluster attributes accessible on the cluster server */
 type MandatoryAttributeServers<A extends Attributes> = Omit<

packages/protocol/src/cluster/server/CommandServer.ts renamed to packages/matter.js/src/cluster/server/CommandServer.ts

@@ -4,13 +4,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { Endpoint } from "#device/Endpoint.js";
 import { Diagnostic, Logger } from "#general";
 import { AccessLevel, FabricIndex } from "#model";
+import { Message, SecureSession, Session } from "#protocol";
 import { CommandId, StatusCode, TlvSchema, TlvStream } from "#types";
-import { Message } from "../../codec/MessageCodec.js";
-import { EndpointInterface } from "../../endpoint/EndpointInterface.js";
-import { SecureSession } from "../../session/SecureSession.js";
-import { Session } from "../../session/Session.js";
 
 const logger = Logger.get("CommandServer");
 
@@ -29,7 +27,7 @@ export class CommandServer<RequestT = any, ResponseT = any> {
             request: RequestT,
             session: Session,
             message: Message,
-            endpoint: EndpointInterface,
+            endpoint: Endpoint,
         ) => Promise<ResponseT> | ResponseT,
     ) {
         this.#invokeAcl = invokeAcl;
@@ -39,7 +37,7 @@ export class CommandServer<RequestT = any, ResponseT = any> {
         session: Session,
         args: TlvStream,
         message: Message,
-        endpoint: EndpointInterface,
+        endpoint: Endpoint,
     ): Promise<{
         /** Primary StatusCode of the invoke request  as defined by Interaction proptocol. */
         code: StatusCode;

packages/protocol/src/cluster/server/EventServer.ts renamed to packages/matter.js/src/cluster/server/EventServer.ts

@@ -4,8 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { NumberedOccurrence, Occurrence } from "#events/Occurrence.js";
-import { OccurrenceManager } from "#events/OccurrenceManager.js";
+import { Endpoint } from "#device/Endpoint.js";
 import {
     ImplementationError,
     InternalError,
@@ -17,6 +16,7 @@ import {
     Time,
 } from "#general";
 import { AccessLevel, ClusterModel, EventModel, MatterModel } from "#model";
+import { Message, NumberedOccurrence, Occurrence, OccurrenceManager, SecureSession, Session } from "#protocol";
 import {
     Attributes,
     BitSchema,
@@ -33,10 +33,6 @@ import {
     TypeFromPartialBitSchema,
     TypeFromSchema,
 } from "#types";
-import { Message } from "../../codec/MessageCodec.js";
-import { EndpointInterface } from "../../endpoint/EndpointInterface.js";
-import { SecureSession } from "../../session/SecureSession.js";
-import { Session } from "../../session/Session.js";
 
 export type AnyEventServer<T = any, S extends Storage = any> = EventServer<T, S> | FabricSensitiveEventServer<T, S>;
 
@@ -73,7 +69,7 @@ export function createEventServer<
 export class EventServer<T = any, S extends Storage = any> {
     private eventList = new Array<Occurrence>();
     private readonly listeners = new Array<(event: NumberedOccurrence) => void>();
-    protected endpoint?: EndpointInterface;
+    protected endpoint?: Endpoint;
     protected eventHandler?: OccurrenceManager;
     #readAcl: AccessLevel | undefined;
     hasFabricSensitiveData = false;
@@ -93,7 +89,7 @@ export class EventServer<T = any, S extends Storage = any> {
         return this.#readAcl ?? AccessLevel.View; // ???
     }
 
-    assignToEndpoint(endpoint: EndpointInterface) {
+    assignToEndpoint(endpoint: Endpoint) {
         this.endpoint = endpoint;
     }
 

packages/protocol/src/cluster/server/index.ts renamed to packages/matter.js/src/cluster/server/index.ts

@@ -11,12 +11,7 @@ import {
     UserLabelCluster,
 } from "#clusters";
 import { AtLeastOne, Diagnostic, ImplementationError, InternalError, NotImplementedError } from "#general";
-import {
-    ClusterClientObj,
-    EndpointInterface,
-    SupportedAttributeClient,
-    UnknownSupportedAttributeClient,
-} from "#protocol";
+import { ClusterClientObj, SupportedAttributeClient, UnknownSupportedAttributeClient } from "#protocol";
 import {
     Attributes,
     BitSchema,
@@ -39,7 +34,7 @@ export interface EndpointOptions {
     uniqueStorageKey?: string;
 }
 
-export class Endpoint implements EndpointInterface {
+export class Endpoint {
     private readonly clusterServers = new Map<ClusterId, ClusterServerObj>();
     private readonly clusterClients = new Map<ClusterId, ClusterClientObj>();
     private readonly childEndpoints: Endpoint[] = [];
@@ -220,7 +215,7 @@ export class Endpoint implements EndpointInterface {
         this.name = deviceTypes[0].name;
     }
 
-    addChildEndpoint(endpoint: EndpointInterface): void {
+    addChildEndpoint(endpoint: Endpoint): void {
         if (!(endpoint instanceof Endpoint)) {
             throw new Error("Only supported EndpointInterface implementation is Endpoint");
         }

packages/matter.js/src/device/Endpoint.ts

@@ -27,7 +27,6 @@ import {
     ClusterClientObj,
     DecodedAttributeReportValue,
     DecodedEventReportValue,
-    EndpointInterface,
     InteractionClient,
     NodeDiscoveryType,
     PaseClient,
@@ -1179,7 +1178,7 @@ export class PairedNode {
     }
 
     /** Returns the functional devices/endpoints (the "childs" of the Root Endpoint) known for this node. */
-    getDevices(): EndpointInterface[] {
+    getDevices(): Endpoint[] {
         return this.#endpoints.get(EndpointNumber(0))?.getChildEndpoints() ?? [];
     }