@dxos/messaging 0.9.1-staging.ee54ba693a → 0.11.0

package/dist/types/src/signal-methods.d.ts

@@ -1,5 +1,5 @@
 import { type Event } from '@dxos/async';
-import { type Context, type Lifecycle } from '@dxos/context';
+import { type Context } from '@dxos/context';
 import { type Peer, type SwarmResponse } from '@dxos/protocols/proto/dxos/edge/messenger';
 import { type JoinRequest, type LeaveRequest, type Message, type QueryRequest, type SwarmEvent } from '@dxos/protocols/proto/dxos/edge/signal';
 import { type SignalState } from '@dxos/protocols/proto/dxos/mesh/signal';
@@ -14,6 +14,29 @@ export type SignalStatus = {
     connectionStarted: Date;
     lastStateChange: Date;
 };
+/**
+ * Parameters for {@link SignalMethods.subscribeMessages}.
+ */
+export type SubscribeMessagesParams = {
+    /**
+     * The subscribing peer. Point-to-point messages addressed to this `peerKey` are delivered.
+     */
+    peer: PeerInfo;
+    /**
+     * OR-subscription tags (DX-1125). When provided, swarm broadcasts whose tags intersect this set are
+     * also delivered. Only meaningful for edge signaling; other transports ignore them.
+     */
+    tags?: string[];
+    /**
+     * Invoked for every message delivered to this subscription (point-to-point or matching broadcast).
+     */
+    onMessage: (message: Message) => void;
+};
+/**
+ * Tears down a subscription created by {@link SignalMethods.subscribeMessages} and releases its
+ * transport resources (edge tag registration / receive stream). The subscriber owns this lifecycle.
+ */
+export type UnsubscribeCallback = () => Promise<void>;
 /**
  * Message routing interface.
  */
@@ -24,10 +47,6 @@ export interface SignalMethods {
      * TODO(mykola): Use swarmState in network-manager instead.
      */
     swarmEvent: Event<SwarmEvent>;
-    /**
-     * Emits when a message is received.
-     */
-    onMessage: Event<Message>;
     /**
      * Emits when the swarm state changes.
      */
@@ -45,26 +64,18 @@ export interface SignalMethods {
      */
     query: (ctx: Context, params: QueryRequest) => Promise<SwarmResponse>;
     /**
-     * Send message to peer.
+     * Send a message. Point-to-point when `recipient` is set; a swarm broadcast (DX-1125) when `tags`
+     * are set — fanned out to every peer whose tag subscription intersects, with the target swarm taken
+     * from `author.swarmKey`. Exactly one of `recipient` / `tags` must be present. Broadcasts are only
+     * supported by edge signaling.
      */
     sendMessage: (ctx: Context, message: Message) => Promise<void>;
     /**
-     * Start receiving messages from peer.
-     * @deprecated
-     */
-    subscribeMessages: (peer: PeerInfo) => Promise<void>;
-    /**
-     * Stop receiving messages from peer.
-     * @deprecated
+     * Start receiving messages for `peer`: its point-to-point messages, plus — when `tags` are provided
+     * (DX-1125) — swarm broadcasts whose tags intersect. Matching messages are routed to
+     * `params.onMessage`; routing and the transport stream are owned here. Returns a callback that tears
+     * the subscription down; the subscriber owns that lifecycle.
      */
-    unsubscribeMessages: (peer: PeerInfo) => Promise<void>;
-}
-/**
- * Signaling client.
- * TODO(mykola): Delete.
- * @deprecated
- */
-export interface SignalClientMethods extends SignalMethods, Required<Lifecycle> {
-    getStatus(): SignalStatus;
+    subscribeMessages: (params: SubscribeMessagesParams) => Promise<UnsubscribeCallback>;
 }
 //# sourceMappingURL=signal-methods.d.ts.map

package/dist/types/src/signal-methods.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signal-methods.d.ts","sourceRoot":"","sources":["../../../src/signal-methods.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,aAAa,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,UAAU,EAChB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAE1E,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACpC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC;AAC5B,eAAO,MAAM,YAAY,gBAAiB,QAAQ,WAAY,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,WAAW,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,IAAI,CAAC;IACxB,eAAe,EAAE,IAAI,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAEtE;;OAEG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;OAGG;IAEH,iBAAiB,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;OAGG;IACH,mBAAmB,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACxD;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,aAAa,EAAE,QAAQ,CAAC,SAAS,CAAC;IAC7E,SAAS,IAAI,YAAY,CAAC;CAC3B"}
+{"version":3,"file":"signal-methods.d.ts","sourceRoot":"","sources":["../../../src/signal-methods.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,aAAa,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,UAAU,EAChB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAE1E,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACpC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC;AAC5B,eAAO,MAAM,YAAY,gBAAiB,QAAQ,WAAY,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,WAAW,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,IAAI,CAAC;IACxB,eAAe,EAAE,IAAI,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACtF"}

package/dist/types/src/testing/index.d.ts

@@ -1,4 +1,5 @@
 export * from './test-builder';
+export * from './test-edge-mesh';
 export * from './test-peer';
 export * from './test-messages';
 export * from './utils';

package/dist/types/src/testing/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/testing/index.ts"],"names":[],"mappings":"AAIA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/testing/index.ts"],"names":[],"mappings":"AAIA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}

package/dist/types/src/testing/test-edge-mesh.d.ts

@@ -0,0 +1,61 @@
+import { type Context } from '@dxos/context';
+import { type EdgeConnection } from '@dxos/edge-client';
+import { type Message } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
+/**
+ * In-memory stand-in for the EDGE router + swarm, feature-complete for the messaging paths
+ * {@link EdgeSignalManager} exercises: swarm membership (JOIN/LEAVE), tag subscriptions (SUBSCRIBE),
+ * point-to-point relay, and tag broadcast fan-out (DX-1125). Multiple {@link TestEdgeConnection}s
+ * attach to one mesh, so a broadcast from one client is delivered to the matching subscribers of
+ * another — mirroring the real edge without a WebSocket or Durable Object.
+ */
+export declare class TestEdgeMesh {
+    /** peerKey -> connection. */
+    private readonly _connections;
+    /** swarmKey -> (peerKey -> subscription tags). */
+    private readonly _subscriptions;
+    /** swarmKey -> set of member peerKeys. */
+    private readonly _members;
+    createConnection({ peerKey, identityDid }: {
+        peerKey: string;
+        identityDid: string;
+    }): TestEdgeConnection;
+    removeConnection(peerKey: string): void;
+    /** Handle a message sent by a client connection. */
+    receive(fromPeerKey: string, message: Message): void;
+    private _handleSwarmRequest;
+    private _handleSignal;
+    private _memberSet;
+    private _subscriptionMap;
+}
+/**
+ * In-memory {@link EdgeConnection} bound to a {@link TestEdgeMesh}. Only the members
+ * {@link EdgeSignalManager} uses are functional; the rest are inert stubs.
+ */
+export declare class TestEdgeConnection implements EdgeConnection {
+    readonly statusChanged: EdgeConnection['statusChanged'];
+    private readonly _messageListeners;
+    private readonly _peerKey;
+    private readonly _identityDid;
+    private readonly _mesh;
+    constructor({ peerKey, identityDid, mesh }: {
+        peerKey: string;
+        identityDid: string;
+        mesh: TestEdgeMesh;
+    });
+    get info(): any;
+    get identityDid(): string;
+    get peerKey(): string;
+    get isOpen(): boolean;
+    get status(): EdgeConnection['status'];
+    setIdentity(): void;
+    send(_ctx: Context, message: Message): Promise<void>;
+    onMessage(listener: (message: Message) => void): () => void;
+    onReconnected(listener: () => void, opts?: {
+        emitCurrentState?: boolean;
+    }): () => void;
+    /** Deliver a message from the mesh to this connection's listeners. */
+    deliver(message: Message): void;
+    open(): Promise<void>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=test-edge-mesh.d.ts.map

package/dist/types/src/testing/test-edge-mesh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-edge-mesh.d.ts","sourceRoot":"","sources":["../../../../src/testing/test-edge-mesh.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,KAAK,cAAc,EAAY,MAAM,mBAAmB,CAAC;AAElE,OAAO,EACL,KAAK,OAAO,EAGb,MAAM,4CAA4C,CAAC;AAEpD;;;;;;GAMG;AACH,qBAAa,YAAY;IACvB,6BAA6B;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyC;IACtE,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4C;IAC3E,0CAA0C;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkC;IAE3D,gBAAgB,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,kBAAkB,CAIvG;IAED,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAQtC;IAED,oDAAoD;IACpD,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CASnD;IAED,OAAO,CAAC,mBAAmB;IAwB3B,OAAO,CAAC,aAAa;IA6BrB,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,gBAAgB;CAQzB;AAED;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,SAAgB,aAAa,EAAE,cAAc,CAAC,eAAe,CAAC,CAAoB;IAClF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyC;IAC3E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;IAErC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,YAAY,CAAA;KAAE,EAIvG;IAED,IAAI,IAAI,IAAI,GAAG,CAEd;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAErC;IAED,WAAW,IAAI,IAAI,CAAG;IAEhB,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAEzD;IAED,SAAS,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI,CAG1D;IAED,aAAa,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,IAAI,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,MAAM,IAAI,CAKrF;IAED,sEAAsE;IACtE,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAI9B;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAG;IACxB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAE3B;CACF"}