@waku/interfaces 0.0.16 → 0.0.17

package/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The file is maintained by [Release Please](https://github.com/googleapis/release-please) based on [Conventional Commits](https://www.conventionalcommits.org) specification,
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.17](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.16...interfaces-v0.0.17) (2023-08-02)
+
+
+### Features
+
+* ConnectionManager extends EventEmitter & exposed on the Waku interface (& minor improvements) ([#1447](https://github.com/waku-org/js-waku/issues/1447)) ([0b8936f](https://github.com/waku-org/js-waku/commit/0b8936f1f1ad33f6cb90eb88d027a19e787ae7a2))
+
 ## [0.0.16](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.15...interfaces-v0.0.16) (2023-07-26)
 
 

package/dist/connection_manager.d.ts

@@ -1,5 +1,6 @@
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Peer } from "@libp2p/interface-peer-store";
+import type { EventEmitter } from "@libp2p/interfaces/events";
 export declare enum Tags {
     BOOTSTRAP = "bootstrap",
     PEER_EXCHANGE = "peer-exchange"
@@ -42,3 +43,7 @@ export interface PeersByDiscoveryResult {
         [Tags.PEER_EXCHANGE]: Peer[];
     };
 }
+export interface IConnectionManager extends EventEmitter<IPeersByDiscoveryEvents> {
+    getPeersByDiscovery(): Promise<PeersByDiscoveryResult>;
+    stop(): void;
+}

package/dist/connection_manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"connection_manager.js","sourceRoot":"","sources":["../src/connection_manager.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,uCAA+B,CAAA;AACjC,CAAC,EAHW,IAAI,KAAJ,IAAI,QAGf;AAmBD,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,gFAAqD,CAAA;IACrD,wFAA6D,CAAA;IAC7D,8EAAmD,CAAA;IACnD,sFAA2D,CAAA;AAC7D,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC"}
+{"version":3,"file":"connection_manager.js","sourceRoot":"","sources":["../src/connection_manager.ts"],"names":[],"mappings":"AAIA,MAAM,CAAN,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,uCAA+B,CAAA;AACjC,CAAC,EAHW,IAAI,KAAJ,IAAI,QAGf;AAmBD,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,gFAAqD,CAAA;IACrD,wFAA6D,CAAA;IAC7D,8EAAmD,CAAA;IACnD,sFAA2D,CAAA;AAC7D,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC"}

package/dist/index.d.ts

@@ -12,3 +12,4 @@ export * from "./sender.js";
 export * from "./receiver.js";
 export * from "./misc.js";
 export * from "./libp2p.js";
+export * from "./keep_alive_manager.js";

package/dist/index.js

@@ -12,4 +12,5 @@ export * from "./sender.js";
 export * from "./receiver.js";
 export * from "./misc.js";
 export * from "./libp2p.js";
+export * from "./keep_alive_manager.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC"}

package/dist/keep_alive_manager.d.ts

@@ -0,0 +1,4 @@
+export interface KeepAliveOptions {
+    pingKeepAlive: number;
+    relayKeepAlive: number;
+}

package/dist/keep_alive_manager.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=keep_alive_manager.js.map

package/dist/keep_alive_manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keep_alive_manager.js","sourceRoot":"","sources":["../src/keep_alive_manager.ts"],"names":[],"mappings":""}

package/dist/waku.d.ts

@@ -1,6 +1,7 @@
 import type { Stream } from "@libp2p/interface-connection";
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Multiaddr } from "@multiformats/multiaddr";
+import { IConnectionManager } from "./connection_manager.js";
 import type { IFilter } from "./filter.js";
 import type { Libp2p } from "./libp2p.js";
 import type { ILightPush } from "./light_push.js";
@@ -13,6 +14,7 @@ export interface Waku {
     store?: IStore;
     filter?: IFilter;
     lightPush?: ILightPush;
+    connectionManager: IConnectionManager;
     dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
     start(): Promise<void>;
     stop(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/interfaces",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Definition of Waku interfaces",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",

package/src/connection_manager.ts

@@ -1,5 +1,6 @@
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Peer } from "@libp2p/interface-peer-store";
+import type { EventEmitter } from "@libp2p/interfaces/events";
 
 export enum Tags {
   BOOTSTRAP = "bootstrap",
@@ -47,3 +48,9 @@ export interface PeersByDiscoveryResult {
     [Tags.PEER_EXCHANGE]: Peer[];
   };
 }
+
+export interface IConnectionManager
+  extends EventEmitter<IPeersByDiscoveryEvents> {
+  getPeersByDiscovery(): Promise<PeersByDiscoveryResult>;
+  stop(): void;
+}

package/src/index.ts

@@ -12,3 +12,4 @@ export * from "./sender.js";
 export * from "./receiver.js";
 export * from "./misc.js";
 export * from "./libp2p.js";
+export * from "./keep_alive_manager.js";

package/src/keep_alive_manager.ts

@@ -0,0 +1,4 @@
+export interface KeepAliveOptions {
+  pingKeepAlive: number;
+  relayKeepAlive: number;
+}

package/src/waku.ts

@@ -2,6 +2,7 @@ import type { Stream } from "@libp2p/interface-connection";
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Multiaddr } from "@multiformats/multiaddr";
 
+import { IConnectionManager } from "./connection_manager.js";
 import type { IFilter } from "./filter.js";
 import type { Libp2p } from "./libp2p.js";
 import type { ILightPush } from "./light_push.js";
@@ -16,6 +17,8 @@ export interface Waku {
   filter?: IFilter;
   lightPush?: ILightPush;
 
+  connectionManager: IConnectionManager;
+
   dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
 
   start(): Promise<void>;