@matter/protocol 0.15.1 → 0.15.2-alpha.0-20250703-2e16aba2b

package/dist/esm/action/client/ClientInteraction.js

@@ -3,20 +3,31 @@
  * Copyright 2022-2025 Matter.js Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Environmental, NotImplementedError } from "#general";
-import { InteractionClientMessenger } from "#interaction/InteractionMessenger.js";
-import { SubscriptionClient } from "#interaction/SubscriptionClient.js";
+import { BasicSet, Environmental, ImplementationError } from "#general";
+import { InteractionClientMessenger, MessageType } from "#interaction/InteractionMessenger.js";
 import { InteractionQueue } from "#peer/InteractionQueue.js";
 import { ExchangeProvider } from "#protocol/ExchangeProvider.js";
+import { TlvSubscribeResponse } from "#types";
+import { ClientSubscriptions } from "./ClientSubscriptions.js";
+import { InputChunk } from "./InputChunk.js";
+const DEFAULT_MIN_INTERVAL_FLOOR_SECONDS = 1;
 class ClientInteraction {
   #exchanges;
   #subscriptions;
   #queue;
+  #interactions = new BasicSet();
+  #closed = false;
   constructor(context) {
     this.#exchanges = context.exchanges;
     this.#subscriptions = context.subscriptions;
     this.#queue = context.queue;
   }
+  async close() {
+    this.#closed = true;
+    while (this.#interactions.size) {
+      await this.#interactions.deleted;
+    }
+  }
   get subscriptions() {
     return this.#subscriptions;
   }
@@ -26,100 +37,161 @@ class ClientInteraction {
   static [Environmental.create](env) {
     const instance = new ClientInteraction({
       exchanges: env.get(ExchangeProvider),
-      subscriptions: env.get(SubscriptionClient),
+      subscriptions: env.get(ClientSubscriptions),
       queue: env.get(InteractionQueue)
     });
     env.set(ClientInteraction, instance);
     return instance;
   }
-  read(_request, _session) {
-    throw new NotImplementedError();
+  async *read(request, _session) {
+    try {
+      this.#begin(request);
+      const messenger = await InteractionClientMessenger.create(this.#exchanges);
+      await messenger.sendReadRequest(request);
+      for await (const report of messenger.readDataReports()) {
+        yield InputChunk(report);
+      }
+    } finally {
+      this.#end(request);
+    }
   }
   async write(request, _session) {
-    const messenger = await InteractionClientMessenger.create(this.#exchanges);
-    const response = await messenger.sendWriteCommand(request);
-    if (request.suppressResponse) {
-      return void 0;
-    }
-    if (!response || !response.writeResponses?.length) {
-      return new Array();
-    } else {
-      return response.writeResponses.map(
-        ({
-          path: { nodeId, endpointId, clusterId, attributeId, listIndex },
-          status: { status, clusterStatus }
-        }) => ({
-          kind: "attr-status",
-          path: {
-            nodeId,
-            endpointId,
-            clusterId,
-            attributeId,
-            listIndex
-          },
-          status,
-          clusterStatus
-        })
-      );
+    let messenger;
+    try {
+      this.#begin(request);
+      messenger = await InteractionClientMessenger.create(this.#exchanges);
+      const response = await messenger.sendWriteCommand(request);
+      if (request.suppressResponse) {
+        return void 0;
+      }
+      if (!response || !response.writeResponses?.length) {
+        return new Array();
+      } else {
+        return response.writeResponses.map(
+          ({
+            path: { nodeId, endpointId, clusterId, attributeId, listIndex },
+            status: { status, clusterStatus }
+          }) => ({
+            kind: "attr-status",
+            path: {
+              nodeId,
+              endpointId,
+              clusterId,
+              attributeId,
+              listIndex
+            },
+            status,
+            clusterStatus
+          })
+        );
+      }
+    } finally {
+      await messenger?.close();
+      this.#end(request);
     }
   }
   async *invoke(request, _session) {
-    const messenger = await InteractionClientMessenger.create(this.#exchanges);
-    const result = await messenger.sendInvokeCommand(request);
-    if (!request.suppressResponse) {
-      if (result && result.invokeResponses?.length) {
-        const chunk = result.invokeResponses.map((response) => {
-          if (response.command !== void 0) {
-            const {
-              commandPath: { endpointId, clusterId, commandId },
-              commandRef,
-              commandFields
-            } = response.command;
-            const res = {
-              kind: "cmd-response",
-              path: {
-                endpointId,
-                clusterId,
-                commandId
-              },
-              commandRef,
-              data: commandFields
-              // TODO add decoding
-            };
-            return res;
-          } else if (response.status !== void 0) {
-            const {
-              commandPath: { endpointId, clusterId, commandId },
-              commandRef,
-              status: { status, clusterStatus }
-            } = response.status;
-            const res = {
-              kind: "cmd-status",
-              path: {
-                endpointId,
-                clusterId,
-                commandId
-              },
-              commandRef,
-              status,
-              clusterStatus
-            };
-            return res;
-          } else {
-            return void 0;
-          }
-        }).filter((r) => r !== void 0);
-        yield chunk;
-      } else {
-        yield [];
+    let messenger;
+    try {
+      this.#begin(request);
+      messenger = await InteractionClientMessenger.create(this.#exchanges);
+      const result = await messenger.sendInvokeCommand(request);
+      if (!request.suppressResponse) {
+        if (result && result.invokeResponses?.length) {
+          const chunk = result.invokeResponses.map((response) => {
+            if (response.command !== void 0) {
+              const {
+                commandPath: { endpointId, clusterId, commandId },
+                commandRef,
+                commandFields
+              } = response.command;
+              const res = {
+                kind: "cmd-response",
+                path: {
+                  endpointId,
+                  clusterId,
+                  commandId
+                },
+                commandRef,
+                data: commandFields
+                // TODO add decoding
+              };
+              return res;
+            } else if (response.status !== void 0) {
+              const {
+                commandPath: { endpointId, clusterId, commandId },
+                commandRef,
+                status: { status, clusterStatus }
+              } = response.status;
+              const res = {
+                kind: "cmd-status",
+                path: {
+                  endpointId,
+                  clusterId,
+                  commandId
+                },
+                commandRef,
+                status,
+                clusterStatus
+              };
+              return res;
+            } else {
+              return void 0;
+            }
+          }).filter((r) => r !== void 0);
+          yield chunk;
+        } else {
+          yield [];
+        }
       }
+    } finally {
+      await messenger?.close();
+      this.#end(request);
     }
   }
-  subscribe(_request, _session) {
-    throw new NotImplementedError();
+  async subscribe(request, _session) {
+    let messenger;
+    try {
+      this.#begin(request);
+      messenger = await InteractionClientMessenger.create(this.#exchanges);
+      await messenger.sendSubscribeRequest({
+        ...request,
+        minIntervalFloorSeconds: DEFAULT_MIN_INTERVAL_FLOOR_SECONDS,
+        maxIntervalCeilingSeconds: DEFAULT_MIN_INTERVAL_FLOOR_SECONDS
+      });
+      await this.#handleSubscriptionResponse(request, readChunks(messenger));
+      const responseMessage = await messenger.nextMessage(MessageType.SubscribeResponse);
+      const response = TlvSubscribeResponse.decode(responseMessage.payload);
+      return this.#subscriptions.add(request, response);
+    } finally {
+      await messenger?.close();
+      this.#end(request);
+    }
+  }
+  async #handleSubscriptionResponse(request, result) {
+    if (request.updated) {
+      await request.updated(result);
+    } else {
+      for await (const _chunk of result) ;
+    }
+  }
+  #begin(request) {
+    if (this.#closed) {
+      throw new ImplementationError("Client interaction unavailable after close");
+    }
+    this.#interactions.add(request);
+  }
+  #end(request) {
+    this.#interactions.delete(request);
+  }
+}
+async function* readChunks(messenger) {
+  for await (const report of messenger.readDataReports()) {
+    yield InputChunk(report);
   }
 }
 export {
-  ClientInteraction
+  ClientInteraction,
+  DEFAULT_MIN_INTERVAL_FLOOR_SECONDS
 };
 //# sourceMappingURL=ClientInteraction.js.map

package/dist/esm/action/client/ClientInteraction.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../../../src/action/client/ClientInteraction.ts"],
-  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAeA,SAAsB,eAAe,2BAAyC;AAC9E,SAAS,kCAAkC;AAC3C,SAAS,0BAA0B;AACnC,SAAS,wBAAwB;AACjC,SAAS,wBAAwB;AAW1B,MAAM,kBAEb;AAAA,EACa;AAAA,EACA;AAAA,EACA;AAAA,EAET,YAAY,SAAoC;AAC5C,SAAK,aAAa,QAAQ;AAC1B,SAAK,iBAAiB,QAAQ;AAC9B,SAAK,SAAS,QAAQ;AAAA,EAC1B;AAAA,EAEA,IAAI,gBAAgB;AAChB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,QAAQ;AACR,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,QAAQ,cAAc,MAAM,EAAE,KAAkB;AAC5C,UAAM,WAAW,IAAI,kBAAkB;AAAA,MACnC,WAAW,IAAI,IAAI,gBAAgB;AAAA,MACnC,eAAe,IAAI,IAAI,kBAAkB;AAAA,MACzC,OAAO,IAAI,IAAI,gBAAgB;AAAA,IACnC,CAAC;AACD,QAAI,IAAI,mBAAmB,QAAQ;AACnC,WAAO;AAAA,EACX;AAAA,EAEA,KAAK,UAAgB,UAAiC;AAElD,UAAM,IAAI,oBAAoB;AAAA,EAClC;AAAA,EAEA,MAAM,MAAuB,SAAY,UAAqC;AAC1E,UAAM,YAAY,MAAM,2BAA2B,OAAO,KAAK,UAAU;AACzE,UAAM,WAAW,MAAM,UAAU,iBAAiB,OAAO;AACzD,QAAI,QAAQ,kBAAkB;AAC1B,aAAO;AAAA,IACX;AACA,QAAI,CAAC,YAAY,CAAC,SAAS,gBAAgB,QAAQ;AAC/C,aAAO,IAAI,MAAmC;AAAA,IAClD,OAAO;AACH,aAAO,SAAS,eAAe;AAAA,QAC3B,CAAC;AAAA,UACG,MAAM,EAAE,QAAQ,YAAY,WAAW,aAAa,UAAU;AAAA,UAC9D,QAAQ,EAAE,QAAQ,cAAc;AAAA,QACpC,OAAO;AAAA,UACH,MAAM;AAAA,UACN,MAAM;AAAA,YACF;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACJ;AAAA,UACA;AAAA,UACA;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA,EAEA,OAAO,OAAO,SAAiB,UAAmC;AAC9D,UAAM,YAAY,MAAM,2BAA2B,OAAO,KAAK,UAAU;AACzE,UAAM,SAAS,MAAM,UAAU,kBAAkB,OAAO;AACxD,QAAI,CAAC,QAAQ,kBAAkB;AAC3B,UAAI,UAAU,OAAO,iBAAiB,QAAQ;AAC1C,cAAM,QAA4B,OAAO,gBACpC,IAAI,cAAY;AACb,cAAI,SAAS,YAAY,QAAW;AAChC,kBAAM;AAAA,cACF,aAAa,EAAE,YAAY,WAAW,UAAU;AAAA,cAChD;AAAA,cACA;AAAA,YACJ,IAAI,SAAS;AACb,kBAAM,MAAoC;AAAA,cACtC,MAAM;AAAA,cACN,MAAM;AAAA,gBACF;AAAA,gBACA;AAAA,gBACA;AAAA,cACJ;AAAA,cACA;AAAA,cACA,MAAM;AAAA;AAAA,YACV;AACA,mBAAO;AAAA,UACX,WAAW,SAAS,WAAW,QAAW;AACtC,kBAAM;AAAA,cACF,aAAa,EAAE,YAAY,WAAW,UAAU;AAAA,cAChD;AAAA,cACA,QAAQ,EAAE,QAAQ,cAAc;AAAA,YACpC,IAAI,SAAS;AACb,kBAAM,MAAkC;AAAA,cACpC,MAAM;AAAA,cACN,MAAM;AAAA,gBACF;AAAA,gBACA;AAAA,gBACA;AAAA,cACJ;AAAA,cACA;AAAA,cACA;AAAA,cACA;AAAA,YACJ;AACA,mBAAO;AAAA,UACX,OAAO;AAEH,mBAAO;AAAA,UACX;AAAA,QACJ,CAAC,EACA,OAAO,OAAK,MAAM,MAAS;AAChC,cAAM;AAAA,MACV,OAAO;AACH,cAAM,CAAC;AAAA,MACX;AAAA,IACJ;AAAA,EACJ;AAAA,EAEA,UAAU,UAAqB,UAAsC;AAEjE,UAAM,IAAI,oBAAoB;AAAA,EAClC;AACJ;",
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAeA,SAAS,UAAuB,eAAe,2BAAyC;AACxF,SAAS,4BAA4B,mBAAmB;AACxD,SAAS,wBAAwB;AACjC,SAAS,wBAAwB;AACjC,SAAS,4BAA4B;AACrC,SAAS,2BAA2B;AACpC,SAAS,kBAAkB;AAQpB,MAAM,qCAAqC;AAK3C,MAAM,kBAEb;AAAA,EACa;AAAA,EACA;AAAA,EACA;AAAA,EACA,gBAAgB,IAAI,SAA4C;AAAA,EACzE,UAAU;AAAA,EAEV,YAAY,SAAmC;AAC3C,SAAK,aAAa,QAAQ;AAC1B,SAAK,iBAAiB,QAAQ;AAC9B,SAAK,SAAS,QAAQ;AAAA,EAC1B;AAAA,EAEA,MAAM,QAAQ;AACV,SAAK,UAAU;AAEf,WAAO,KAAK,cAAc,MAAM;AAC5B,YAAM,KAAK,cAAc;AAAA,IAC7B;AAAA,EACJ;AAAA,EAEA,IAAI,gBAAgB;AAChB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,QAAQ;AACR,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,QAAQ,cAAc,MAAM,EAAE,KAAkB;AAC5C,UAAM,WAAW,IAAI,kBAAkB;AAAA,MACnC,WAAW,IAAI,IAAI,gBAAgB;AAAA,MACnC,eAAe,IAAI,IAAI,mBAAmB;AAAA,MAC1C,OAAO,IAAI,IAAI,gBAAgB;AAAA,IACnC,CAAC;AACD,QAAI,IAAI,mBAAmB,QAAQ;AACnC,WAAO;AAAA,EACX;AAAA,EAEA,OAAO,KAAK,SAAe,UAAiC;AACxD,QAAI;AACA,WAAK,OAAO,OAAO;AACnB,YAAM,YAAY,MAAM,2BAA2B,OAAO,KAAK,UAAU;AAEzE,YAAM,UAAU,gBAAgB,OAAO;AAEvC,uBAAiB,UAAU,UAAU,gBAAgB,GAAG;AACpD,cAAM,WAAW,MAAM;AAAA,MAC3B;AAAA,IACJ,UAAE;AACE,WAAK,KAAK,OAAO;AAAA,IACrB;AAAA,EACJ;AAAA,EAEA,MAAM,MAAuB,SAAY,UAAqC;AAC1E,QAAI;AACJ,QAAI;AACA,WAAK,OAAO,OAAO;AACnB,kBAAY,MAAM,2BAA2B,OAAO,KAAK,UAAU;AACnE,YAAM,WAAW,MAAM,UAAU,iBAAiB,OAAO;AACzD,UAAI,QAAQ,kBAAkB;AAC1B,eAAO;AAAA,MACX;AACA,UAAI,CAAC,YAAY,CAAC,SAAS,gBAAgB,QAAQ;AAC/C,eAAO,IAAI,MAAmC;AAAA,MAClD,OAAO;AACH,eAAO,SAAS,eAAe;AAAA,UAC3B,CAAC;AAAA,YACG,MAAM,EAAE,QAAQ,YAAY,WAAW,aAAa,UAAU;AAAA,YAC9D,QAAQ,EAAE,QAAQ,cAAc;AAAA,UACpC,OAAO;AAAA,YACH,MAAM;AAAA,YACN,MAAM;AAAA,cACF;AAAA,cACA;AAAA,cACA;AAAA,cACA;AAAA,cACA;AAAA,YACJ;AAAA,YACA;AAAA,YACA;AAAA,UACJ;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ,UAAE;AACE,YAAM,WAAW,MAAM;AACvB,WAAK,KAAK,OAAO;AAAA,IACrB;AAAA,EACJ;AAAA,EAEA,OAAO,OAAO,SAAiB,UAAmC;AAC9D,QAAI;AACJ,QAAI;AACA,WAAK,OAAO,OAAO;AACnB,kBAAY,MAAM,2BAA2B,OAAO,KAAK,UAAU;AACnE,YAAM,SAAS,MAAM,UAAU,kBAAkB,OAAO;AACxD,UAAI,CAAC,QAAQ,kBAAkB;AAC3B,YAAI,UAAU,OAAO,iBAAiB,QAAQ;AAC1C,gBAAM,QAA4B,OAAO,gBACpC,IAAI,cAAY;AACb,gBAAI,SAAS,YAAY,QAAW;AAChC,oBAAM;AAAA,gBACF,aAAa,EAAE,YAAY,WAAW,UAAU;AAAA,gBAChD;AAAA,gBACA;AAAA,cACJ,IAAI,SAAS;AACb,oBAAM,MAAoC;AAAA,gBACtC,MAAM;AAAA,gBACN,MAAM;AAAA,kBACF;AAAA,kBACA;AAAA,kBACA;AAAA,gBACJ;AAAA,gBACA;AAAA,gBACA,MAAM;AAAA;AAAA,cACV;AACA,qBAAO;AAAA,YACX,WAAW,SAAS,WAAW,QAAW;AACtC,oBAAM;AAAA,gBACF,aAAa,EAAE,YAAY,WAAW,UAAU;AAAA,gBAChD;AAAA,gBACA,QAAQ,EAAE,QAAQ,cAAc;AAAA,cACpC,IAAI,SAAS;AACb,oBAAM,MAAkC;AAAA,gBACpC,MAAM;AAAA,gBACN,MAAM;AAAA,kBACF;AAAA,kBACA;AAAA,kBACA;AAAA,gBACJ;AAAA,gBACA;AAAA,gBACA;AAAA,gBACA;AAAA,cACJ;AACA,qBAAO;AAAA,YACX,OAAO;AAEH,qBAAO;AAAA,YACX;AAAA,UACJ,CAAC,EACA,OAAO,OAAK,MAAM,MAAS;AAChC,gBAAM;AAAA,QACV,OAAO;AACH,gBAAM,CAAC;AAAA,QACX;AAAA,MACJ;AAAA,IACJ,UAAE;AACE,YAAM,WAAW,MAAM;AACvB,WAAK,KAAK,OAAO;AAAA,IACrB;AAAA,EACJ;AAAA,EAEA,MAAM,UAAU,SAAoB,UAAsC;AACtE,QAAI;AACJ,QAAI;AACA,WAAK,OAAO,OAAO;AAEnB,kBAAY,MAAM,2BAA2B,OAAO,KAAK,UAAU;AAEnE,YAAM,UAAU,qBAAqB;AAAA,QACjC,GAAG;AAAA,QACH,yBAAyB;AAAA,QACzB,2BAA2B;AAAA,MAC/B,CAAC;AAED,YAAM,KAAK,4BAA4B,SAAS,WAAW,SAAS,CAAC;AAErE,YAAM,kBAAkB,MAAM,UAAU,YAAY,YAAY,iBAAiB;AACjF,YAAM,WAAW,qBAAqB,OAAO,gBAAgB,OAAO;AAEpE,aAAO,KAAK,eAAe,IAAI,SAAS,QAAQ;AAAA,IACpD,UAAE;AACE,YAAM,WAAW,MAAM;AACvB,WAAK,KAAK,OAAO;AAAA,IACrB;AAAA,EACJ;AAAA,EAEA,MAAM,4BAA4B,SAAoB,QAAoB;AACtE,QAAI,QAAQ,SAAS;AACjB,YAAM,QAAQ,QAAQ,MAAM;AAAA,IAChC,OAAO;AAMH,uBAAiB,UAAU,OAAO;AAAA,IACtC;AAAA,EACJ;AAAA,EAEA,OAAO,SAA4C;AAC/C,QAAI,KAAK,SAAS;AACd,YAAM,IAAI,oBAAoB,4CAA4C;AAAA,IAC9E;AACA,SAAK,cAAc,IAAI,OAAO;AAAA,EAClC;AAAA,EAEA,KAAK,SAA4C;AAC7C,SAAK,cAAc,OAAO,OAAO;AAAA,EACrC;AACJ;AAEA,gBAAgB,WAAW,WAAuC;AAC9D,mBAAiB,UAAU,UAAU,gBAAgB,GAAG;AACpD,UAAM,WAAW,MAAM;AAAA,EAC3B;AACJ;",
   "names": []
 }

package/dist/esm/action/client/ClientSubscription.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Subscribe } from "#action/request/Subscribe.js";
+import { ActiveSubscription } from "#action/response/SubscribeResult.js";
+/**
+ * The client view of an established Matter subscription.
+ */
+export interface ClientSubscription extends ActiveSubscription {
+    request: Subscribe;
+    timeoutAtMs?: number;
+    isClosed: boolean;
+    isReading: boolean;
+}
+//# sourceMappingURL=ClientSubscription.d.ts.map

package/dist/esm/action/client/ClientSubscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientSubscription.d.ts","sourceRoot":"","sources":["../../../../src/action/client/ClientSubscription.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC1D,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;CACtB"}

package/dist/esm/action/client/ClientSubscription.js

@@ -0,0 +1,6 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+//# sourceMappingURL=ClientSubscription.js.map

package/dist/esm/action/client/ClientSubscription.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/action/client/ClientSubscription.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;",
+  "names": []
+}

package/dist/esm/action/client/ClientSubscriptionHandler.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MessageExchange } from "#protocol/MessageExchange.js";
+import { ProtocolHandler } from "#protocol/ProtocolHandler.js";
+import { ClientSubscriptions } from "./ClientSubscriptions.js";
+/**
+ * A protocol handler that informs {@link ClientSubscriptions} of new exchanges.
+ */
+export declare class ClientSubscriptionHandler implements ProtocolHandler {
+    #private;
+    id: number;
+    requiresSecureSession: boolean;
+    constructor(subscriptions: ClientSubscriptions);
+    onNewExchange(exchange: MessageExchange): Promise<void>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=ClientSubscriptionHandler.d.ts.map

package/dist/esm/action/client/ClientSubscriptionHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientSubscriptionHandler.d.ts","sourceRoot":"","sources":["../../../../src/action/client/ClientSubscriptionHandler.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAG/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAK/D;;GAEG;AACH,qBAAa,yBAA0B,YAAW,eAAe;;IAC7D,EAAE,SAA2B;IAC7B,qBAAqB,UAAQ;gBAIjB,aAAa,EAAE,mBAAmB;IAIxC,aAAa,CAAC,QAAQ,EAAE,eAAe;IAuDvC,KAAK;CACd"}

package/dist/esm/action/client/ClientSubscriptionHandler.js

@@ -0,0 +1,97 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { DecodedDataReport } from "#interaction/DecodedDataReport.js";
+import { IncomingInteractionClientMessenger } from "#interaction/InteractionMessenger.js";
+import { INTERACTION_PROTOCOL_ID, Status } from "#types";
+import { Diagnostic, InternalError, Logger } from "@matter/general";
+import { InputChunk } from "./InputChunk.js";
+const logger = Logger.get("ClientSubscriptionHandler");
+class ClientSubscriptionHandler {
+  id = INTERACTION_PROTOCOL_ID;
+  requiresSecureSession = true;
+  #subscriptions;
+  constructor(subscriptions) {
+    this.#subscriptions = subscriptions;
+  }
+  async onNewExchange(exchange) {
+    const messenger = new IncomingInteractionClientMessenger(exchange);
+    const reports = messenger.readDataReports();
+    const initialIteration = await reports.next();
+    if (initialIteration.done) {
+      throw new InternalError("Exchange initiated with no initial message");
+    }
+    const initialReport = initialIteration.value;
+    const { subscriptionId } = initialReport;
+    if (subscriptionId === void 0) {
+      logger.debug("Ignoring unsolicited data report with no subscription ID");
+      await sendInvalid(messenger, void 0);
+      return;
+    }
+    const subscription = this.#subscriptions.get(subscriptionId);
+    if (subscription === void 0) {
+      logger.debug("Ignoring data report for unknown subscription ID", Diagnostic.strong(subscriptionId));
+      await sendInvalid(messenger, subscriptionId);
+      return;
+    }
+    if (!initialReport.attributeReports?.length && !initialReport.eventReports?.length) {
+      subscription.timeoutAtMs = void 0;
+      this.#subscriptions.resetTimer();
+      await exchange.close();
+      return;
+    }
+    try {
+      subscription.isReading = true;
+      if (subscription.request.updated) {
+        await subscription.request.updated(processReports(initialReport, reports, messenger));
+      } else {
+        for await (const _chunk of reports) ;
+      }
+    } finally {
+      subscription.isReading = false;
+      subscription.timeoutAtMs = void 0;
+      this.#subscriptions.resetTimer();
+      await exchange.close();
+    }
+  }
+  async close() {
+  }
+}
+async function sendInvalid(messenger, subscriptionId) {
+  await messenger.sendStatus(Status.InvalidSubscription, {
+    multipleMessageInteraction: true,
+    logContext: {
+      subId: subscriptionId
+    }
+  });
+  await messenger.close();
+}
+async function* processReports(initialReport, otherReports, messenger) {
+  yield InputChunk(initialReport);
+  const { subscriptionId } = initialReport;
+  for await (const report of otherReports) {
+    const decoded = DecodedDataReport(report);
+    if (decoded.subscriptionId === void 0) {
+      logger.debug(
+        "Ignoring data report for incorrect subscription id",
+        Diagnostic.strong(decoded.subscriptionId)
+      );
+      await sendInvalid(messenger, decoded.subscriptionId);
+    }
+    if (decoded.subscriptionId !== subscriptionId) {
+      logger.debug(
+        "Ignoring data report for incorrect subscription id",
+        Diagnostic.strong(decoded.subscriptionId)
+      );
+      await sendInvalid(messenger, decoded.subscriptionId);
+      continue;
+    }
+    yield InputChunk(report);
+  }
+}
+export {
+  ClientSubscriptionHandler
+};
+//# sourceMappingURL=ClientSubscriptionHandler.js.map

package/dist/esm/action/client/ClientSubscriptionHandler.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/action/client/ClientSubscriptionHandler.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,SAAS,yBAAyB;AAClC,SAAS,0CAA0C;AAInD,SAAqB,yBAAyB,cAAc;AAC5D,SAAS,YAAY,eAAe,cAAc;AAElD,SAAS,kBAAkB;AAE3B,MAAM,SAAS,OAAO,IAAI,2BAA2B;AAK9C,MAAM,0BAAqD;AAAA,EAC9D,KAAK;AAAA,EACL,wBAAwB;AAAA,EAExB;AAAA,EAEA,YAAY,eAAoC;AAC5C,SAAK,iBAAiB;AAAA,EAC1B;AAAA,EAEA,MAAM,cAAc,UAA2B;AAC3C,UAAM,YAAY,IAAI,mCAAmC,QAAQ;AAEjE,UAAM,UAAU,UAAU,gBAAgB;AAE1C,UAAM,mBAAmB,MAAM,QAAQ,KAAK;AAC5C,QAAI,iBAAiB,MAAM;AACvB,YAAM,IAAI,cAAc,4CAA4C;AAAA,IACxE;AACA,UAAM,gBAAgB,iBAAiB;AAGvC,UAAM,EAAE,eAAe,IAAI;AAC3B,QAAI,mBAAmB,QAAW;AAC9B,aAAO,MAAM,0DAA0D;AACvE,YAAM,YAAY,WAAW,MAAS;AACtC;AAAA,IACJ;AAGA,UAAM,eAAe,KAAK,eAAe,IAAI,cAAc;AAC3D,QAAI,iBAAiB,QAAW;AAC5B,aAAO,MAAM,oDAAoD,WAAW,OAAO,cAAc,CAAC;AAClG,YAAM,YAAY,WAAW,cAAc;AAC3C;AAAA,IACJ;AAGA,QAAI,CAAC,cAAc,kBAAkB,UAAU,CAAC,cAAc,cAAc,QAAQ;AAChF,mBAAa,cAAc;AAC3B,WAAK,eAAe,WAAW;AAC/B,YAAM,SAAS,MAAM;AACrB;AAAA,IACJ;AAGA,QAAI;AACA,mBAAa,YAAY;AAEzB,UAAI,aAAa,QAAQ,SAAS;AAC9B,cAAM,aAAa,QAAQ,QAAQ,eAAe,eAAe,SAAS,SAAS,CAAC;AAAA,MACxF,OAAO;AAIH,yBAAiB,UAAU,QAAQ;AAAA,MACvC;AAAA,IACJ,UAAE;AACE,mBAAa,YAAY;AACzB,mBAAa,cAAc;AAC3B,WAAK,eAAe,WAAW;AAC/B,YAAM,SAAS,MAAM;AAAA,IACzB;AAAA,EACJ;AAAA,EAEA,MAAM,QAAQ;AAAA,EAAC;AACnB;AAEA,eAAe,YAAY,WAA+C,gBAAiC;AACvG,QAAM,UAAU,WAAW,OAAO,qBAAqB;AAAA,IACnD,4BAA4B;AAAA,IAC5B,YAAY;AAAA,MACR,OAAO;AAAA,IACX;AAAA,EACJ,CAAC;AACD,QAAM,UAAU,MAAM;AAC1B;AAOA,gBAAgB,eACZ,eACA,cACA,WACU;AACV,QAAM,WAAW,aAAa;AAE9B,QAAM,EAAE,eAAe,IAAI;AAE3B,mBAAiB,UAAU,cAAc;AACrC,UAAM,UAAU,kBAAkB,MAAM;AAExC,QAAI,QAAQ,mBAAmB,QAAW;AACtC,aAAO;AAAA,QACH;AAAA,QACA,WAAW,OAAO,QAAQ,cAAc;AAAA,MAC5C;AACA,YAAM,YAAY,WAAW,QAAQ,cAAc;AAAA,IACvD;AAEA,QAAI,QAAQ,mBAAmB,gBAAgB;AAC3C,aAAO;AAAA,QACH;AAAA,QACA,WAAW,OAAO,QAAQ,cAAc;AAAA,MAC5C;AACA,YAAM,YAAY,WAAW,QAAQ,cAAc;AACnD;AAAA,IACJ;AAEA,UAAM,WAAW,MAAM;AAAA,EAC3B;AACJ;",
+  "names": []
+}

package/dist/esm/action/client/ClientSubscriptions.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Subscribe } from "#action/request/Subscribe.js";
+import { ReadResult } from "#action/response/ReadResult.js";
+import { ActiveSubscription } from "#action/response/SubscribeResult.js";
+import { Environment, Environmental } from "#general";
+import { SubscriptionId } from "#interaction/Subscription.js";
+import { SubscribeResponse } from "#types";
+import { ClientSubscription } from "./ClientSubscription.js";
+/**
+ * A managed set of {@link ClientSubscription} instances.
+ */
+export declare class ClientSubscriptions {
+    #private;
+    static [Environmental.create](env: Environment): ClientSubscriptions;
+    /**
+     * Register an active subscription.
+     */
+    add(request: Subscribe, response: SubscribeResponse): ActiveSubscription;
+    /**
+     * Retrieve a subscription by ID.
+     */
+    get(id: SubscriptionId): ClientSubscription | undefined;
+    /**
+     * Iterate over active subscriptions.
+     */
+    [Symbol.iterator](): SetIterator<ClientSubscription>;
+    /**
+     * Terminate all subscriptions.
+     */
+    close(): Promise<void>;
+    /**
+     * Restart the timeout timer for the current set of active subscriptions.
+     */
+    resetTimer(): void;
+}
+export declare namespace ClientSubscriptions {
+    interface Listener {
+        (reports: AsyncIterable<ReadResult.Chunk>): Promise<void>;
+    }
+}
+//# sourceMappingURL=ClientSubscriptions.d.ts.map

package/dist/esm/action/client/ClientSubscriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientSubscriptions.d.ts","sourceRoot":"","sources":["../../../../src/action/client/ClientSubscriptions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAIH,WAAW,EACX,aAAa,EAKhB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAI7D;;GAEG;AACH,qBAAa,mBAAmB;;IAK5B,MAAM,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,WAAW;IAM9C;;OAEG;IACH,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,GAAG,kBAAkB;IAgBxE;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,cAAc;IAItB;;OAEG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB;;OAEG;IACG,KAAK;IAUX;;OAEG;IACH,UAAU;CAwEb;AAMD,yBAAiB,mBAAmB,CAAC;IACjC,UAAiB,QAAQ;QACrB,CAAC,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC7D;CACJ"}

package/dist/esm/action/client/ClientSubscriptions.js

@@ -0,0 +1,129 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {
+  BasicSet,
+  CanceledError,
+  Diagnostic,
+  Environmental,
+  Logger,
+  Time,
+  TimeoutError
+} from "#general";
+const logger = Logger.get("ClientSubscriptions");
+class ClientSubscriptions {
+  #subscriptions = new BasicSet();
+  #timeout;
+  #nextTimeoutAt;
+  static [Environmental.create](env) {
+    const instance = new ClientSubscriptions();
+    env.set(ClientSubscriptions, instance);
+    return instance;
+  }
+  /**
+   * Register an active subscription.
+   */
+  add(request, response) {
+    const subscription = {
+      ...response,
+      request,
+      close: () => this.#closeOne(subscription, new CanceledError()),
+      timeoutAtMs: void 0,
+      isClosed: false,
+      isReading: true
+    };
+    this.#subscriptions.add(subscription);
+    this.resetTimer();
+    return subscription;
+  }
+  /**
+   * Retrieve a subscription by ID.
+   */
+  get(id) {
+    return this.#subscriptions.get("subscriptionId", id);
+  }
+  /**
+   * Iterate over active subscriptions.
+   */
+  [Symbol.iterator]() {
+    return this.#subscriptions[Symbol.iterator]();
+  }
+  /**
+   * Terminate all subscriptions.
+   */
+  async close() {
+    if (this.#timeout) {
+      this.#timeout.stop();
+      this.#timeout = void 0;
+    }
+    for (const subscription of this.#subscriptions) {
+      subscription.close();
+    }
+  }
+  /**
+   * Restart the timeout timer for the current set of active subscriptions.
+   */
+  resetTimer() {
+    const now = Time.nowMs();
+    let nextTimeoutAt;
+    for (const subscription of this.#subscriptions) {
+      if (subscription.isReading) {
+        continue;
+      }
+      let { timeoutAtMs } = subscription;
+      if (timeoutAtMs === void 0) {
+        timeoutAtMs = subscription.timeoutAtMs = timeoutFor(subscription);
+      } else if (timeoutAtMs < now) {
+        this.#timeOut(subscription);
+        continue;
+      }
+      if (nextTimeoutAt === void 0 || nextTimeoutAt > timeoutAtMs) {
+        nextTimeoutAt = timeoutAtMs;
+      }
+    }
+    if (nextTimeoutAt === void 0) {
+      this.#nextTimeoutAt = void 0;
+      this.#timeout?.stop();
+      return;
+    }
+    if (nextTimeoutAt !== this.#nextTimeoutAt) {
+      this.#nextTimeoutAt = nextTimeoutAt;
+      if (this.#timeout) {
+        this.#timeout?.stop();
+        this.#timeout.intervalMs = nextTimeoutAt - now;
+      } else {
+        this.#timeout = Time.getTimer("SubscriptionTimeout", nextTimeoutAt - now, this.resetTimer.bind(this));
+      }
+    }
+  }
+  #closeOne(subscription, cause) {
+    if (subscription.isClosed) {
+      return;
+    }
+    subscription.isClosed = true;
+    this.#subscriptions.delete(subscription);
+    try {
+      subscription.request.closed?.(cause);
+    } catch (e) {
+      logger.error("Error canceling subscription", Diagnostic.strong(subscription.subscriptionId), e);
+    }
+  }
+  #timeOut(registration) {
+    logger.info(
+      "Subscription",
+      Diagnostic.strong(registration.subscriptionId),
+      "timed out after",
+      Diagnostic.strong(`${timeoutFor(registration)}ms`)
+    );
+    this.#closeOne(registration, new TimeoutError());
+  }
+}
+function timeoutFor(subscription) {
+  return subscription.maxInterval * 1e3 + (subscription.request.maxPeerResponseTime ?? 0);
+}
+export {
+  ClientSubscriptions
+};
+//# sourceMappingURL=ClientSubscriptions.js.map

package/dist/esm/action/client/ClientSubscriptions.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/action/client/ClientSubscriptions.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AASA;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEG;AAKP,MAAM,SAAS,OAAO,IAAI,qBAAqB;AAKxC,MAAM,oBAAoB;AAAA,EAC7B,iBAAiB,IAAI,SAA6B;AAAA,EAClD;AAAA,EACA;AAAA,EAEA,QAAQ,cAAc,MAAM,EAAE,KAAkB;AAC5C,UAAM,WAAW,IAAI,oBAAoB;AACzC,QAAI,IAAI,qBAAqB,QAAQ;AACrC,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,SAAoB,UAAiD;AACrE,UAAM,eAAmC;AAAA,MACrC,GAAG;AAAA,MACH;AAAA,MACA,OAAO,MAAM,KAAK,UAAU,cAAc,IAAI,cAAc,CAAC;AAAA,MAC7D,aAAa;AAAA,MACb,UAAU;AAAA,MACV,WAAW;AAAA,IACf;AAEA,SAAK,eAAe,IAAI,YAAY;AACpC,SAAK,WAAW;AAEhB,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,IAAoB;AACpB,WAAO,KAAK,eAAe,IAAI,kBAAkB,EAAE;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA,EAKA,CAAC,OAAO,QAAQ,IAAI;AAChB,WAAO,KAAK,eAAe,OAAO,QAAQ,EAAE;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAAQ;AACV,QAAI,KAAK,UAAU;AACf,WAAK,SAAS,KAAK;AACnB,WAAK,WAAW;AAAA,IACpB;AACA,eAAW,gBAAgB,KAAK,gBAAgB;AAC5C,mBAAa,MAAM;AAAA,IACvB;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa;AACT,UAAM,MAAM,KAAK,MAAM;AACvB,QAAI;AAGJ,eAAW,gBAAgB,KAAK,gBAAgB;AAE5C,UAAI,aAAa,WAAW;AACxB;AAAA,MACJ;AAGA,UAAI,EAAE,YAAY,IAAI;AACtB,UAAI,gBAAgB,QAAW;AAE3B,sBAAc,aAAa,cAAc,WAAW,YAAY;AAAA,MACpE,WAAW,cAAc,KAAK;AAE1B,aAAK,SAAS,YAAY;AAC1B;AAAA,MACJ;AAGA,UAAI,kBAAkB,UAAa,gBAAgB,aAAa;AAC5D,wBAAgB;AAAA,MACpB;AAAA,IACJ;AAGA,QAAI,kBAAkB,QAAW;AAC7B,WAAK,iBAAiB;AACtB,WAAK,UAAU,KAAK;AACpB;AAAA,IACJ;AAGA,QAAI,kBAAkB,KAAK,gBAAgB;AACvC,WAAK,iBAAiB;AACtB,UAAI,KAAK,UAAU;AACf,aAAK,UAAU,KAAK;AACpB,aAAK,SAAS,aAAa,gBAAgB;AAAA,MAC/C,OAAO;AACH,aAAK,WAAW,KAAK,SAAS,uBAAuB,gBAAgB,KAAK,KAAK,WAAW,KAAK,IAAI,CAAC;AAAA,MACxG;AAAA,IACJ;AAAA,EACJ;AAAA,EAEA,UAAU,cAAkC,OAAqC;AAC7E,QAAI,aAAa,UAAU;AACvB;AAAA,IACJ;AACA,iBAAa,WAAW;AACxB,SAAK,eAAe,OAAO,YAAY;AAEvC,QAAI;AACA,mBAAa,QAAQ,SAAS,KAAK;AAAA,IACvC,SAAS,GAAG;AACR,aAAO,MAAM,gCAAgC,WAAW,OAAO,aAAa,cAAc,GAAG,CAAC;AAAA,IAClG;AAAA,EACJ;AAAA,EAEA,SAAS,cAAkC;AACvC,WAAO;AAAA,MACH;AAAA,MACA,WAAW,OAAO,aAAa,cAAc;AAAA,MAC7C;AAAA,MACA,WAAW,OAAO,GAAG,WAAW,YAAY,CAAC,IAAI;AAAA,IACrD;AAGA,SAAK,UAAU,cAAc,IAAI,aAAa,CAAC;AAAA,EACnD;AACJ;AAEA,SAAS,WAAW,cAAkC;AAClD,SAAO,aAAa,cAAc,OAAQ,aAAa,QAAQ,uBAAuB;AAC1F;",
+  "names": []
+}