chore: add typedefs (#802)

src/pnet/crypto.js

@@ -1,16 +1,17 @@
 'use strict'
 
 const debug = require('debug')
+const log = Object.assign(debug('libp2p:pnet'), {
+  trace: debug('libp2p:pnet:trace'),
+  error: debug('libp2p:pnet:err')
+})
+
 const Errors = require('./errors')
 const xsalsa20 = require('xsalsa20')
 const KEY_LENGTH = require('./key-generator').KEY_LENGTH
 const uint8ArrayFromString = require('uint8arrays/from-string')
 const uint8ArrayToString = require('uint8arrays/to-string')
 
-const log = debug('libp2p:pnet')
-log.trace = debug('libp2p:pnet:trace')
-log.error = debug('libp2p:pnet:err')
-
 /**
  * Creates a stream iterable to encrypt messages in a private network
  *

src/pnet/index.js

@@ -1,12 +1,16 @@
 'use strict'
 
-const pipe = require('it-pipe')
+const debug = require('debug')
+const log = Object.assign(debug('libp2p:pnet'), {
+  error: debug('libp2p:pnet:err')
+})
+const { pipe } = require('it-pipe')
 const errcode = require('err-code')
 const duplexPair = require('it-pair/duplex')
 const crypto = require('libp2p-crypto')
 const Errors = require('./errors')
 const {
-  ERR_INVALID_PARAMETERS
+  codes: { ERR_INVALID_PARAMETERS }
 } = require('../errors')
 const {
   createBoxStream,
@@ -15,16 +19,16 @@ const {
 } = require('./crypto')
 const handshake = require('it-handshake')
 const { NONCE_LENGTH } = require('./key-generator')
-const debug = require('debug')
-const log = debug('libp2p:pnet')
-log.error = debug('libp2p:pnet:err')
 
 /**
- * Takes a Private Shared Key (psk) and provides a `protect` method
- * for wrapping existing connections in a private encryption stream
+ * @typedef {import('libp2p-interfaces/src/transport/types').MultiaddrConnection} MultiaddrConnection
  */
+
 class Protector {
   /**
+   * Takes a Private Shared Key (psk) and provides a `protect` method
+   * for wrapping existing connections in a private encryption stream.
+   *
    * @param {Uint8Array} keyBuffer - The private shared key buffer
    * @class
    */
@@ -39,8 +43,8 @@ class Protector {
    * between its two peers from the PSK the Protector instance was
    * created with.
    *
-   * @param {Connection} connection - The connection to protect
-   * @returns {*} A protected duplex iterable
+   * @param {MultiaddrConnection} connection - The connection to protect
+   * @returns {Promise<MultiaddrConnection>} A protected duplex iterable
    */
   async protect (connection) {
     if (!connection) {

src/pnet/key-generator.js

@@ -22,6 +22,8 @@ module.exports = generate
 module.exports.NONCE_LENGTH = 24
 module.exports.KEY_LENGTH = KEY_LENGTH
 
+// @ts-ignore This condition will always return 'false' since the types 'Module | undefined'
 if (require.main === module) {
+  // @ts-ignore
   generate(process.stdout)
 }