chore: convert to typescript

Converts this module to typescript

Track: libp2p/js-libp2p#1021

BREAKING CHANGE: No more default exports, no more CJS

Author: achingbrain

package.json

@@ -3,8 +3,27 @@
   "version": "0.4.1",
   "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
   "leadMaintainer": "Vasco Santos <[email protected]>",
-  "main": "src/index.js",
-  "types": "dist/src/index.d.ts",
+  "type": "module",
+  "exports": {
+    "multiaddr/is-loopback": {
+      "import": "./dist/src/multiaddr/is-loopback.js"
+    },
+    "multiaddr/is-private": {
+      "import": "./dist/src/multiaddr/is-private.js"
+    },
+    "address-sort": {
+      "import": "./dist/src/address-sort.js"
+    },
+    "array-equals": {
+      "import": "./dist/src/array-equals.js"
+    },
+    "ip-port-to-multiaddr": {
+      "import": "./dist/src/ip-port-to-multiaddr.js"
+    },
+    "stream-to-ma-conn": {
+      "import": "./dist/src/stream-to-ma-connr.js"
+    }
+  },
   "typesVersions": {
     "*": {
       "src/*": [
@@ -18,17 +37,16 @@
     "dist"
   ],
   "scripts": {
-    "prepare": "aegir build --no-bundle",
-    "test": "aegir test",
-    "test:browser": "aegir test -t browser",
-    "test:node": "aegir test -t node",
-    "test:electron": "aegir test -t electron-main",
-    "test:electron-renderer": "aegir test -t electron-renderer",
+    "pretest": "npm run build",
+    "test": "aegir test -f ./dist/test/*.js",
+    "test:browser": "aegir test -t browser -f ./dist/test/*.js",
+    "test:node": "aegir test -t node -f ./dist/test/*.js",
+    "test:electron": "aegir test -t electron-main -f ./dist/test/*.js",
     "lint": "aegir lint",
     "release": "aegir release --docs",
     "release-minor": "aegir release --target node --type minor --docs",
     "release-major": "aegir release --type major --docs",
-    "build": "aegir build"
+    "build": "tsc"
   },
   "pre-push": [
     "lint"
@@ -44,10 +62,10 @@
   "homepage": "https://github.com/libp2p/js-libp2p-utils#readme",
   "devDependencies": {
     "@types/debug": "^4.1.5",
-    "aegir": "^33.0.0",
+    "aegir": "^36.0.0",
     "it-pair": "^1.0.0",
     "it-pipe": "^1.1.0",
-    "libp2p-interfaces": "^1.0.0",
+    "libp2p-interfaces": "^2.0.0",
     "streaming-iterables": "^6.0.0",
     "util": "^0.12.3"
   },

src/address-sort.js renamed to src/address-sort.ts

@@ -1,10 +1,10 @@
-'use strict'
+import type { Multiaddr } from 'multiaddr'
+import { isPrivate } from './multiaddr/is-private.js'
 
-const isPrivate = require('./multiaddr/is-private')
-
-/**
- * @typedef {import('multiaddr').Multiaddr} Multiaddr
- */
+interface Address {
+  multiaddr: Multiaddr
+  isCertified: boolean
+}
 
 /**
  * @typedef {Object} Address
@@ -21,7 +21,7 @@ const isPrivate = require('./multiaddr/is-private')
  * @param {Address} b
  * @returns {number}
  */
-function addressesPublicFirstCompareFunction (a, b) {
+function addressesPublicFirstCompareFunction (a: Address, b: Address) {
   const isAPrivate = isPrivate(a.multiaddr)
   const isBPrivate = isPrivate(b.multiaddr)
 
@@ -43,12 +43,7 @@ function addressesPublicFirstCompareFunction (a, b) {
 /**
  * Sort given addresses by putting public addresses first.
  * In case of equality, a certified address will come first.
- *
- * @param {Array<Address>} addresses
- * @returns {Array<Address>}
  */
-function publicAddressesFirst (addresses) {
+export function publicAddressesFirst (addresses: Address[]) {
   return [...addresses].sort(addressesPublicFirstCompareFunction)
 }
-
-module.exports.publicAddressesFirst = publicAddressesFirst

src/array-equals.js

@@ -0,0 +1,8 @@
+/**
+ * Verify if two arrays of non primitive types with the "equals" function are equal.
+ * Compatible with multiaddr, peer-id and others.
+ */
+export function arrayEquals (a: any[], b: any[]) {
+  const sort = (a: any, b: any) => a.toString().localeCompare(b.toString())
+  return a.length === b.length && b.sort(sort) && a.sort(sort).every((item, index) => b[index].equals(item))
+}

src/array-equals.ts

@@ -1,36 +1,32 @@
-'use strict'
+import debug from 'debug'
+import { Multiaddr } from 'multiaddr'
+import errCode from 'err-code'
+import { Address4, Address6 } from 'ip-address'
 
-const debug = require('debug')
 const log = Object.assign(debug('libp2p:ip-port-to-multiaddr'), {
   error: debug('libp2p:ip-port-to-multiaddr:err')
 })
-const { Multiaddr } = require('multiaddr')
-const errCode = require('err-code')
-const { Address4, Address6 } = require('ip-address')
 
-const errors = {
+export const Errors = {
   ERR_INVALID_IP_PARAMETER: 'ERR_INVALID_IP_PARAMETER',
   ERR_INVALID_PORT_PARAMETER: 'ERR_INVALID_PORT_PARAMETER',
   ERR_INVALID_IP: 'ERR_INVALID_IP'
 }
 
 /**
  * Transform an IP, Port pair into a multiaddr
- *
- * @param {string} ip
- * @param {number|string} port
  */
-function ipPortToMultiaddr (ip, port) {
+export function ipPortToMultiaddr (ip: string, port: number | string) {
   if (typeof ip !== 'string') {
-    throw errCode(new Error(`invalid ip provided: ${ip}`), errors.ERR_INVALID_IP_PARAMETER)
+    throw errCode(new Error(`invalid ip provided: ${ip}`), Errors.ERR_INVALID_IP_PARAMETER) // eslint-disable-line @typescript-eslint/restrict-template-expressions
   }
 
   if (typeof port === 'string') {
     port = parseInt(port)
   }
 
   if (isNaN(port)) {
-    throw errCode(new Error(`invalid port provided: ${port}`), errors.ERR_INVALID_PORT_PARAMETER)
+    throw errCode(new Error(`invalid port provided: ${port}`), Errors.ERR_INVALID_PORT_PARAMETER)
   }
 
   try {
@@ -48,10 +44,6 @@ function ipPortToMultiaddr (ip, port) {
   } catch (err) {
     const errMsg = `invalid ip:port for creating a multiaddr: ${ip}:${port}`
     log.error(errMsg)
-    throw errCode(new Error(errMsg), errors.ERR_INVALID_IP)
+    throw errCode(new Error(errMsg), Errors.ERR_INVALID_IP)
   }
 }
-
-module.exports = ipPortToMultiaddr
-
-module.exports.Errors = errors

src/index.js

@@ -0,0 +1,12 @@
+// @ts-expect-error is-loopback-addr does not publish types
+import isLoopbackAddr from 'is-loopback-addr'
+import type { Multiaddr } from 'multiaddr'
+
+/**
+ * Check if a given multiaddr is a loopback address.
+ */
+export function isLoopback (ma: Multiaddr) {
+  const { address } = ma.nodeAddress()
+
+  return isLoopbackAddr(address)
+}

src/ip-port-to-multiaddr.js renamed to src/ip-port-to-multiaddr.ts

@@ -0,0 +1,11 @@
+import type { Multiaddr } from 'multiaddr'
+import isIpPrivate from 'private-ip'
+
+/**
+ * Check if a given multiaddr has a private address.
+ */
+export function isPrivate (ma: Multiaddr) {
+  const { address } = ma.nodeAddress()
+
+  return isIpPrivate(address)
+}