@libp2p/interface-internal 1.2.4 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/src/connection-manager/index.d.ts +5 -2
  2. package/dist/src/connection-manager/index.d.ts.map +1 -1
  3. package/dist/src/transport-manager/index.d.ts +6 -2
  4. package/dist/src/transport-manager/index.d.ts.map +1 -1
  5. package/dist/typedoc-urls.json +4 -1
  6. package/package.json +4 -3
  7. package/src/connection-manager/index.ts +13 -2
  8. package/src/transport-manager/index.ts +10 -2
package/dist/src/connection-manager/index.d.ts CHANGED
@@ -1,7 +1,10 @@
1
- import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions } from '@libp2p/interface';
1
+ import type { TransportManagerDialProgressEvents } from '../transport-manager/index.js';
2
+ import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, Address, OutboundConnectionUpgradeEvents } from '@libp2p/interface';
2
3
  import type { PeerMap } from '@libp2p/peer-collections';
3
4
  import type { Multiaddr } from '@multiformats/multiaddr';
4
- export interface OpenConnectionOptions extends AbortOptions {
5
+ import type { ProgressOptions, ProgressEvent } from 'progress-events';
6
+ export type OpenConnectionProgressEvents = TransportManagerDialProgressEvents | ProgressEvent<'dial-queue:already-connected'> | ProgressEvent<'dial-queue:already-in-dial-queue'> | ProgressEvent<'dial-queue:add-to-dial-queue'> | ProgressEvent<'dial-queue:start-dial'> | ProgressEvent<'dial-queue:calculated-addresses', Address[]> | OutboundConnectionUpgradeEvents;
7
+ export interface OpenConnectionOptions extends AbortOptions, ProgressOptions<OpenConnectionProgressEvents> {
5
8
  /**
6
9
  * Connection requests with a higher priority will be executed before those
7
10
  * with a lower priority. (default: 50)
package/dist/src/connection-manager/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC9H,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;OASG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAE7C;;;;;;;;OAQG;IACH,iBAAiB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE1C;;;;;;;;OAQG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5G;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;OAKG;IACH,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEvE;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;;;;;OAQG;IACH,YAAY,IAAI,WAAW,EAAE,CAAA;IAE7B;;;;;;;;OAQG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9F"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,+BAA+B,CAAA;AACvF,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,+BAA+B,EAAE,MAAM,mBAAmB,CAAA;AACxK,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,4BAA4B,GACtC,kCAAkC,GAClC,aAAa,CAAC,8BAA8B,CAAC,GAC7C,aAAa,CAAC,kCAAkC,CAAC,GACjD,aAAa,CAAC,8BAA8B,CAAC,GAC7C,aAAa,CAAC,uBAAuB,CAAC,GACtC,aAAa,CAAC,iCAAiC,EAAE,OAAO,EAAE,CAAC,GAC3D,+BAA+B,CAAA;AAEjC,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,eAAe,CAAC,4BAA4B,CAAC;IACxG;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;OASG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAE7C;;;;;;;;OAQG;IACH,iBAAiB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE1C;;;;;;;;OAQG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5G;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;OAKG;IACH,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEvE;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;;;;;OAQG;IACH,YAAY,IAAI,WAAW,EAAE,CAAA;IAE7B;;;;;;;;OAQG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9F"}
package/dist/src/transport-manager/index.d.ts CHANGED
@@ -1,5 +1,9 @@
1
- import type { Connection, Listener, Transport } from '@libp2p/interface';
1
+ import type { AbortOptions, Connection, Listener, Transport } from '@libp2p/interface';
2
2
  import type { Multiaddr } from '@multiformats/multiaddr';
3
+ import type { ProgressOptions, ProgressEvent } from 'progress-events';
4
+ export type TransportManagerDialProgressEvents = ProgressEvent<'transport-manager:selected-transport', string>;
5
+ export interface TransportManagerDialOptions extends AbortOptions, ProgressOptions<TransportManagerDialProgressEvents> {
6
+ }
3
7
  export interface TransportManager {
4
8
  /**
5
9
  * Add a transport to the transport manager
@@ -11,7 +15,7 @@ export interface TransportManager {
11
15
  * a multiaddr, you may want to call openConnection on the connection manager
12
16
  * instead.
13
17
  */
14
- dial(ma: Multiaddr, options?: any): Promise<Connection>;
18
+ dial(ma: Multiaddr, options?: TransportManagerDialOptions): Promise<Connection>;
15
19
  /**
16
20
  * Return all addresses currently being listened on
17
21
  */
package/dist/src/transport-manager/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAE/B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvD;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IAEvB;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAA;IAE5B;;OAEG;IACH,YAAY,IAAI,QAAQ,EAAE,CAAA;IAE1B;;OAEG;IACH,yBAAyB,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAA;IAE/D;;;OAGG;IACH,2BAA2B,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAA;IAEjE;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACtF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,kCAAkC,GAC5C,aAAa,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAA;AAE/D,MAAM,WAAW,2BAA4B,SAAQ,YAAY,EAAE,eAAe,CAAC,kCAAkC,CAAC;CAErH;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAE/B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE/E;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IAEvB;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAA;IAE5B;;OAEG;IACH,YAAY,IAAI,QAAQ,EAAE,CAAA;IAE1B;;OAEG;IACH,yBAAyB,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAA;IAE/D;;;OAGG;IACH,2BAA2B,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAA;IAEjE;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B"}
package/dist/typedoc-urls.json CHANGED
@@ -10,5 +10,8 @@
10
10
  "StreamHandler": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.StreamHandler.html",
11
11
  "StreamHandlerOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html",
12
12
  "StreamHandlerRecord": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html",
13
- "TransportManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManager.html"
13
+ "TransportManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManager.html",
14
+ "TransportManagerDialOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html",
15
+ "OpenConnectionProgressEvents": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface_internal.OpenConnectionProgressEvents.html",
16
+ "TransportManagerDialProgressEvents": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface_internal.TransportManagerDialProgressEvents.html"
14
17
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/interface-internal",
3
- "version": "1.2.4",
3
+ "version": "1.3.0",
4
4
  "description": "Interfaces implemented by internal libp2p components",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface-internal#readme",
@@ -48,9 +48,10 @@
48
48
  "build": "aegir build"
49
49
  },
50
50
  "dependencies": {
51
- "@libp2p/interface": "^1.5.0",
52
- "@libp2p/peer-collections": "^5.2.4",
51
+ "@libp2p/interface": "^1.6.0",
52
+ "@libp2p/peer-collections": "^5.2.5",
53
53
  "@multiformats/multiaddr": "^12.2.3",
54
+ "progress-events": "^1.0.0",
54
55
  "uint8arraylist": "^2.4.8"
55
56
  },
56
57
  "devDependencies": {
package/src/connection-manager/index.ts CHANGED
@@ -1,8 +1,19 @@
1
- import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions } from '@libp2p/interface'
1
+ import type { TransportManagerDialProgressEvents } from '../transport-manager/index.js'
2
+ import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, Address, OutboundConnectionUpgradeEvents } from '@libp2p/interface'
2
3
  import type { PeerMap } from '@libp2p/peer-collections'
3
4
  import type { Multiaddr } from '@multiformats/multiaddr'
5
+ import type { ProgressOptions, ProgressEvent } from 'progress-events'
4
6
 
5
- export interface OpenConnectionOptions extends AbortOptions {
7
+ export type OpenConnectionProgressEvents =
8
+ TransportManagerDialProgressEvents |
9
+ ProgressEvent<'dial-queue:already-connected'> |
10
+ ProgressEvent<'dial-queue:already-in-dial-queue'> |
11
+ ProgressEvent<'dial-queue:add-to-dial-queue'> |
12
+ ProgressEvent<'dial-queue:start-dial'> |
13
+ ProgressEvent<'dial-queue:calculated-addresses', Address[]> |
14
+ OutboundConnectionUpgradeEvents
15
+
16
+ export interface OpenConnectionOptions extends AbortOptions, ProgressOptions<OpenConnectionProgressEvents> {
6
17
  /**
7
18
  * Connection requests with a higher priority will be executed before those
8
19
  * with a lower priority. (default: 50)
package/src/transport-manager/index.ts CHANGED
@@ -1,5 +1,13 @@
1
- import type { Connection, Listener, Transport } from '@libp2p/interface'
1
+ import type { AbortOptions, Connection, Listener, Transport } from '@libp2p/interface'
2
2
  import type { Multiaddr } from '@multiformats/multiaddr'
3
+ import type { ProgressOptions, ProgressEvent } from 'progress-events'
4
+
5
+ export type TransportManagerDialProgressEvents =
6
+ ProgressEvent<'transport-manager:selected-transport', string>
7
+
8
+ export interface TransportManagerDialOptions extends AbortOptions, ProgressOptions<TransportManagerDialProgressEvents> {
9
+
10
+ }
3
11
 
4
12
  export interface TransportManager {
5
13
  /**
@@ -13,7 +21,7 @@ export interface TransportManager {
13
21
  * a multiaddr, you may want to call openConnection on the connection manager
14
22
  * instead.
15
23
  */
16
- dial(ma: Multiaddr, options?: any): Promise<Connection>
24
+ dial(ma: Multiaddr, options?: TransportManagerDialOptions): Promise<Connection>
17
25
 
18
26
  /**
19
27
  * Return all addresses currently being listened on