chore: update deps and types

package.json

@@ -30,12 +30,12 @@
   "devDependencies": {
     "@types/chai": "^4.2.8",
     "@types/mocha": "^8.0.0",
-    "aegir": "^32.0.2",
+    "aegir": "^33.0.0",
     "uint8arrays": "^2.0.5",
     "util": "^0.12.3"
   },
   "dependencies": {
-    "multiaddr": "^8.0.0"
+    "multiaddr": "^9.0.1"
   },
   "contributors": [
     "David Dias <[email protected]>",

src/index.js

@@ -1,6 +1,11 @@
 'use strict'
 
-const multiaddr = require('multiaddr')
+const { Multiaddr } = require('multiaddr')
+
+/**
+ * @typedef {(a: Multiaddr | string) => boolean} MatchesFunction
+ * @typedef {(a: string[]) => boolean | null | string[]} PartialMatchesFunction
+ */
 
 /*
  * Valid combinations
@@ -144,25 +149,44 @@ exports.IPFS = P2P
  * Validation funcs
  */
 
+/**
+ * @param {PartialMatchesFunction} partialMatch
+ */
 function makeMatchesFunction (partialMatch) {
-  return function matches (a) {
-    if (!multiaddr.isMultiaddr(a)) {
+  /**
+   * @type {MatchesFunction}
+   */
+  function matches (a) {
+    if (!Multiaddr.isMultiaddr(a)) {
       try {
-        a = multiaddr(a)
+        a = new Multiaddr(a)
       } catch (err) { // catch error
-        return false // also if it's invalid it's propably not matching as well so return false
+        return false // also if it's invalid it's probably not matching as well so return false
       }
     }
     const out = partialMatch(a.protoNames())
+
     if (out === null) {
       return false
     }
+
+    if (out === true || out === false) {
+      return out
+    }
+
     return out.length === 0
   }
+
+  return matches
 }
 
-function and () {
-  const args = Array.from(arguments)
+/**
+ * @param  {...any} args
+ */
+function and (...args) {
+  /**
+   * @type {PartialMatchesFunction}
+   */
   function partialMatch (a) {
     if (a.length < args.length) {
       return null
@@ -192,6 +216,9 @@ function and () {
 function or () {
   const args = Array.from(arguments)
 
+  /**
+   * @type {PartialMatchesFunction}
+   */
   function partialMatch (a) {
     let out = null
     args.some((arg) => {
@@ -218,13 +245,19 @@ function or () {
   return result
 }
 
+/**
+ * @param {string} n
+ */
 function base (n) {
   const name = n
 
+  /**
+   * @type {MatchesFunction}
+   */
   function matches (a) {
     if (typeof a === 'string') {
       try {
-        a = multiaddr(a)
+        a = new Multiaddr(a)
       } catch (err) { // catch error
         return false // also if it's invalid it's propably not matching as well so return false
       }
@@ -237,6 +270,9 @@ function base (n) {
     return false
   }
 
+  /**
+   * @type {PartialMatchesFunction}
+   */
   function partialMatch (protos) {
     if (protos.length === 0) {
       return null

test/index.spec.js

@@ -3,7 +3,7 @@
 'use strict'
 
 const { expect } = require('aegir/utils/chai')
-const multiaddr = require('multiaddr')
+const { Multiaddr } = require('multiaddr')
 const uint8ArrayFromString = require('uint8arrays/from-string')
 
 const mafmt = require('./../src')
@@ -190,13 +190,16 @@ describe('multiaddr validation', function () {
     '/dns6/nyc-2.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64'
   ].concat(goodCircuit)
 
-  function assertMatches (p) {
-    const tests = Array.from(arguments).slice(1)
+  /**
+   * @param {mafmt.Mafmt} p
+   * @param {...string[]} tests
+   */
+  function assertMatches (p, ...tests) {
     tests.forEach(function (test) {
       test.forEach(function (testcase) {
         try {
           expect(p.matches(testcase), `assertMatches: ${testcase} (string)`).to.be.eql(true)
-          const ma = multiaddr(testcase)
+          const ma = new Multiaddr(testcase)
           expect(p.matches(ma), `assertMatches: ${testcase} (multiaddr object)`).to.be.eql(true)
           expect(p.matches(ma.bytes), `assertMatches: ${testcase} (multiaddr.bytes)`).to.be.eql(true)
         } catch (err) {
@@ -207,8 +210,11 @@ describe('multiaddr validation', function () {
     })
   }
 
-  function assertMismatches (p) {
-    const tests = Array.from(arguments).slice(1)
+  /**
+   * @param {mafmt.Mafmt} p
+   * @param {...string[]} tests
+   */
+  function assertMismatches (p, ...tests) {
     tests.forEach(function (test) {
       test.forEach(function (testcase) {
         try {
@@ -217,7 +223,7 @@ describe('multiaddr validation', function () {
           try {
             // if testcase string happens to be a valid multiaddr,
             // we expect 'p' test to also return false for Multiaddr object and Uint8Array versions
-            validMultiaddrObj = multiaddr(testcase)
+            validMultiaddrObj = new Multiaddr(testcase)
           } catch (e) {
             // Ignoring testcase as the string is not a multiaddr
             // (There is a separate 'Uint8Array is invalid' test later below)

tsconfig.json

@@ -1,38 +1,10 @@
-
 {
+    "extends": "aegir/src/config/tsconfig.aegir.json",
     "compilerOptions": {
-        "module": "commonjs",
-        "lib": [
-            "es6"
-        ],
-        "target": "ES5",
-        "noImplicitAny": false,
-        "noImplicitThis": true,
-        "strictFunctionTypes": true,
-        "strictNullChecks": true,
-        "esModuleInterop": true,
-        "resolveJsonModule": true,
-        "allowJs": true,
-        "checkJs": true,
-        "baseUrl": ".",
-        "paths": {
-            "mafmt": [
-                "./src",
-                "../src"
-            ]
-        },
-        "types": [
-            "node",
-            "mocha",
-            "chai"
-        ],
-        "noEmit": true,
-        "forceConsistentCasingInFileNames": true
+      "outDir": "dist"
     },
-    "files": [
-        "./src/index.d.ts"
-    ],
     "include": [
-        "./test/**/*.spec.js"
+      "src",
+      "test"
     ]
-}
+  }