@libp2p/interface-internal - npm Package Compare versions

Comparing version 1.2.4 to 1.3.0

dist/src/connection-manager/index.d.ts

@@ -1,5 +0,8 @@
-import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions } from '@libp2p/interface';
+import type { TransportManagerDialProgressEvents } from '../transport-manager/index.js';
+import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, Address, OutboundConnectionUpgradeEvents } from '@libp2p/interface';
 import type { PeerMap } from '@libp2p/peer-collections';
 import type { Multiaddr } from '@multiformats/multiaddr';
-export interface OpenConnectionOptions extends AbortOptions {
+import type { ProgressOptions, ProgressEvent } from 'progress-events';
+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;
+export interface OpenConnectionOptions extends AbortOptions, ProgressOptions<OpenConnectionProgressEvents> {
     /**
@@ -6,0 +9,0 @@ * Connection requests with a higher priority will be executed before those

dist/src/transport-manager/index.d.ts

@@ -1,3 +0,7 @@
-import type { Connection, Listener, Transport } from '@libp2p/interface';
+import type { AbortOptions, Connection, Listener, Transport } from '@libp2p/interface';
 import type { Multiaddr } from '@multiformats/multiaddr';
+import type { ProgressOptions, ProgressEvent } from 'progress-events';
+export type TransportManagerDialProgressEvents = ProgressEvent<'transport-manager:selected-transport', string>;
+export interface TransportManagerDialOptions extends AbortOptions, ProgressOptions<TransportManagerDialProgressEvents> {
+}
 export interface TransportManager {
@@ -14,3 +18,3 @@ /**
      */
-    dial(ma: Multiaddr, options?: any): Promise<Connection>;
+    dial(ma: Multiaddr, options?: TransportManagerDialOptions): Promise<Connection>;
     /**
@@ -17,0 +21,0 @@ * Return all addresses currently being listened on

dist/typedoc-urls.json

@@ -13,3 +13,6 @@ {
   "StreamHandlerRecord": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html",
-  "TransportManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManager.html"
+  "TransportManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManager.html",
+  "TransportManagerDialOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html",
+  "OpenConnectionProgressEvents": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface_internal.OpenConnectionProgressEvents.html",
+  "TransportManagerDialProgressEvents": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface_internal.TransportManagerDialProgressEvents.html"
 }

package.json

 {
   "name": "@libp2p/interface-internal",
-  "version": "1.2.4",
+  "version": "1.3.0",
   "description": "Interfaces implemented by internal libp2p components",
@@ -51,5 +51,6 @@ "license": "Apache-2.0 OR MIT",
   "dependencies": {
-    "@libp2p/interface": "^1.5.0",
-    "@libp2p/peer-collections": "^5.2.4",
+    "@libp2p/interface": "^1.6.0",
+    "@libp2p/peer-collections": "^5.2.5",
     "@multiformats/multiaddr": "^12.2.3",
+    "progress-events": "^1.0.0",
     "uint8arraylist": "^2.4.8"
@@ -56,0 +57,0 @@ },

src/connection-manager/index.ts

@@ -1,6 +0,17 @@
-import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions } from '@libp2p/interface'
+import type { TransportManagerDialProgressEvents } from '../transport-manager/index.js'
+import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, Address, OutboundConnectionUpgradeEvents } from '@libp2p/interface'
 import type { PeerMap } from '@libp2p/peer-collections'
 import type { Multiaddr } from '@multiformats/multiaddr'
+import type { ProgressOptions, ProgressEvent } from 'progress-events'
 
-export interface OpenConnectionOptions extends AbortOptions {
+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
+
+export interface OpenConnectionOptions extends AbortOptions, ProgressOptions<OpenConnectionProgressEvents> {
   /**
@@ -7,0 +18,0 @@ * Connection requests with a higher priority will be executed before those

src/transport-manager/index.ts

@@ -1,4 +0,12 @@
-import type { Connection, Listener, Transport } from '@libp2p/interface'
+import type { AbortOptions, Connection, Listener, Transport } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
+import type { ProgressOptions, ProgressEvent } from 'progress-events'
 
+export type TransportManagerDialProgressEvents =
+  ProgressEvent<'transport-manager:selected-transport', string>
+
+export interface TransportManagerDialOptions extends AbortOptions, ProgressOptions<TransportManagerDialProgressEvents> {
+
+}
+
 export interface TransportManager {
@@ -16,3 +24,3 @@ /**
    */
-  dial(ma: Multiaddr, options?: any): Promise<Connection>
+  dial(ma: Multiaddr, options?: TransportManagerDialOptions): Promise<Connection>
 
@@ -19,0 +27,0 @@ /**

No alert changes

Improved metrics

Total package byte prevSize

33400

9.73%

Lines of code

643

4.21%

Worsened metrics

Dependency count

5

25%

Dependency changes

• + Added

  progress-events@^1.0.0

• Updated

  @libp2p/interface@^1.6.0

• Updated

  @libp2p/peer-collections@^5.2.5