cidr-tools 3.0.6 → 4.0.0

package/README.md

@@ -50,6 +50,13 @@ Returns an array of individual IPs contained in the networks.
 
 Returns a boolean that indicates if `networksA` overlap (intersect) with `networksB`.
 
+### cidrTools.contains(networkA, networkB)
+
+- `networkA` *String*: A CIDR or IP address.
+- `networkB` *String*: A CIDR or IP address.
+
+Returns a boolean that indicates whether `networksA` fully contains `networksB`.
+
 ### cidrTools.normalize(network)
 
 - `network` *String*: A CIDR or IP address.

package/index.d.ts

@@ -13,6 +13,7 @@ interface CIDRTools {
   expand(networks: Networks): Network[];
   overlap(networksA: Networks, networksB: Networks): boolean;
   normalize(cidr: Network): Network;
+  contains(networkA: Network, networkB: Network): boolean;
 }
 
 declare const cidrTools : CIDRTools;

package/index.js

@@ -61,11 +61,18 @@ function uniq(arr) {
   return [...new Set(arr)];
 }
 
-function doNetsOverlap(a, b) {
+// utility function that returns boundaries of two networks
+function getBoundaries(a, b) {
   const aStart = a.start({type: "bigInteger"});
   const bStart = b.start({type: "bigInteger"});
   const aEnd = a.end({type: "bigInteger"});
   const bEnd = b.end({type: "bigInteger"});
+  return {aStart, bStart, aEnd, bEnd};
+}
+
+// returns whether networks fully or partially overlap
+function doNetsOverlap(a, b) {
+  const {aStart, bStart, aEnd, bEnd} = getBoundaries(a, b);
 
   //    aaa
   // bbb
@@ -78,12 +85,24 @@ function doNetsOverlap(a, b) {
   return true;
 }
 
+// returns whether network a fully contains network b;
+function contains(a, b) {
+  const {aStart, bStart, aEnd, bEnd} = getBoundaries(a, b);
+
+  //  aaa
+  // bbbb
+  if (bStart.compareTo(aStart) < 0) return false; // a starts after b
+
+  // aaa
+  // bbbb
+  if (bEnd.compareTo(aEnd) > 0) return false; // b starts after a
+
+  return true;
+}
+
 // exclude b from a and return remainder cidrs
 function excludeNets(a, b, v) {
-  const aStart = a.start({type: "bigInteger"});
-  const bStart = b.start({type: "bigInteger"});
-  const aEnd = a.end({type: "bigInteger"});
-  const bEnd = b.end({type: "bigInteger"});
+  const {aStart, bStart, aEnd, bEnd} = getBoundaries(a, b);
   const parts = [];
 
   // compareTo returns negative if left is less than right
@@ -341,6 +360,7 @@ module.exports.overlap = (a, b) => {
     for (const b of bNets) {
       const bParsed = parse(b);
 
+      // version mismatch
       if (aParsed.address.v4 !== bParsed.address.v4) {
         continue;
       }
@@ -353,3 +373,15 @@ module.exports.overlap = (a, b) => {
 
   return false;
 };
+
+module.exports.contains = (a, b) => {
+  const aParsed = parse(a);
+  const bParsed = parse(b);
+
+  // version mismatch
+  if (aParsed.address.v4 !== bParsed.address.v4) {
+    return false;
+  }
+
+  return contains(aParsed, bParsed);
+};

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "cidr-tools",
-  "version": "3.0.6",
+  "version": "4.0.0",
   "author": "silverwind <me@silverwind.io>",
   "description": "Tools to work with IPv4 and IPv6 CIDR network lists",
   "repository": "silverwind/cidr-tools",
   "license": "BSD-2-Clause",
   "engines": {
-    "node": ">=10"
+    "node": ">=12.17.0"
   },
   "keywords": [
     "cidr",
@@ -35,14 +35,10 @@
     "string-natural-compare": "^3.0.1"
   },
   "devDependencies": {
-    "eslint": "8.4.1",
-    "eslint-config-silverwind": "47.1.0",
-    "jest": "27.4.5",
-    "updates": "12.2.3",
-    "versions": "9.1.1"
-  },
-  "jest": {
-    "verbose": false,
-    "testTimeout": 30000
+    "eslint": "8.9.0",
+    "eslint-config-silverwind": "48.1.0",
+    "jest": "27.5.1",
+    "updates": "13.0.0",
+    "versions": "9.2.1"
   }
 }