cidr-tools 8.0.0 → 9.0.0

package/README.md

@@ -5,15 +5,15 @@
 ## Usage
 
 ```js
-import {merge, exclude, expand, overlap, contains, normalize, parse} from "cidr-tools";
-
-merge(["1.0.0.0/24", "1.0.1.0/24"]); //=> ["1.0.0.0/23"]
-exclude(["::1/127"], "::1/128") //=> ["::/128"]
-expand(["2001:db8::/126"]) //=> ["2001:db8::", "2001:db8::1", "2001:db8::2", "2001:db8::3"]
-overlap("1.0.0.0/24", "1.0.0.128/25") //=> true
-contains(["1.0.0.0/24", "2.0.0.0/24"], "1.0.0.1") //=> true
-normalize("::ffff/64") //=> "::/64"
-parse("::/64"); // => {cidr: "::/64", version: 6, prefix: "64", start: 0n, end: 18446744073709551615n}
+import {mergeCidr, excludeCidr, expandCidr, overlapCidr, containsCidr, normalizeCidr, parseCidr} from "cidr-tools";
+
+mergeCidr(["1.0.0.0/24", "1.0.1.0/24"]); //=> ["1.0.0.0/23"]
+excludeCidr(["::1/127"], "::1/128") //=> ["::/128"]
+expandCidr(["2001:db8::/126"]) //=> ["2001:db8::", "2001:db8::1", "2001:db8::2", "2001:db8::3"]
+overlapCidr("1.0.0.0/24", "1.0.0.128/25") //=> true
+containsCidr(["1.0.0.0/24", "2.0.0.0/24"], "1.0.0.1") //=> true
+normalizeCidr("::ffff/64") //=> "::/64"
+parseCidr("::/64"); // => {cidr: "::/64", version: 6, prefix: "64", start: 0n, end: 18446744073709551615n}
 ```
 
 ## API
@@ -24,40 +24,40 @@ It is expected that the passed CIDRs and IPs are validated as the module's own i
 
 This module requires [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#browser_compatibility) support in your environment.
 
-### merge(networks)
+### mergeCidr(networks)
 
 - `networks` *String* or *Array*: One or more CIDR or IP addresses.
 
 Returns an array of merged networks.
 
-### exclude(baseNetworks, excludeNetworks)
+### excludeCidr(baseNetworks, excludeNetworks)
 
 - `baseNetworks` *String* or *Array*: One or more CIDR or IP addresses.
 - `excludeNetworks` *String* or *Array*: One or more CIDR or IP addresses to exclude from `baseNetworks`.
 
 Returns an array of merged remaining networks.
 
-### expand(networks)
+### expandCidr(networks)
 
 - `networks` *String* or *Array*: One or more CIDR or IP addresses.
 
 Returns an array of individual IPs contained in the networks.
 
-### overlap(networksA, networksB)
+### overlapCidr(networksA, networksB)
 
 - `networksA` *String* or *Array*: One or more CIDR or IP address.
 - `networksB` *String* or *Array*: One or more CIDR or IP address.
 
 Returns a boolean that indicates if `networksA` overlap (intersect) with `networksB`.
 
-### contains(networksA, networksB)
+### containsCidr(networksA, networksB)
 
 - `networksA` *String* or *Array*: One or more CIDR or IP address.
 - `networksB` *String* or *Array*: One or more CIDR or IP address.
 
 Returns a boolean that indicates whether `networksA` fully contain all `networksB`.
 
-### normalize(networks, [opts])
+### normalizeCidr(networks, [opts])
 
 - `networks` *String* or *Array*: One or more CIDR or IP address.
 
@@ -67,7 +67,7 @@ Returns a string or array (depending on input) with a normalized representation.
   - `compress`: Whether to compress the IP. For IPv6, this means the "best representation" all-lowercase shortest possible form. Default: `true`.
   - `hexify`: Whether to convert IPv4-Mapped IPv6 addresses to hex. Default: `false`.
 
-### parse(network)
+### parseCidr(network)
 
 - `network` *String*: A CIDR or IP address.
 
@@ -76,7 +76,7 @@ Returns a `parsed` Object which is used internally by this module. It can be use
 `parsed`: `Object`
   - `cidr` String: The CIDR of the network.
   - `version` Number: IP protocol version. Either `4` or `6`.
-  - `prefix` String: The network prefix, e.g. `/64`.
+  - `prefix` String: The network prefix, e.g. `64`.
   - `start` BigInt: Start number of the network.
   - `end` BigInt: End number of the network.
 

package/index.d.ts

@@ -18,21 +18,21 @@ type NormalizeOpts = {
   hexify?: boolean;
 };
 
-export function merge(networks: Networks): Network[];
-export function exclude(baseNetworks: Networks, excludeNetworks: Networks): Network[];
-export function expand(networks: Networks): Network[];
-export function overlap(networksA: Networks, networksB: Networks): boolean;
-export function normalize(cidr: Networks, opts?: NormalizeOpts): Networks;
-export function contains(networksA: Networks, networksB: Networks): boolean;
-export function parse(network: Network): Parsed;
+export function mergeCidr(networks: Networks): Network[];
+export function excludeCidr(baseNetworks: Networks, excludeNetworks: Networks): Network[];
+export function expandCidr(networks: Networks): Network[];
+export function overlapCidr(networksA: Networks, networksB: Networks): boolean;
+export function normalizeCidr(cidr: Networks, opts?: NormalizeOpts): Networks;
+export function containsCidr(networksA: Networks, networksB: Networks): boolean;
+export function parseCidr(network: Network): Parsed;
 
 declare const _default: {
-  merge: typeof merge;
-  exclude: typeof exclude;
-  expand: typeof expand;
-  overlap: typeof overlap;
-  normalize: typeof normalize;
-  contains: typeof contains;
-  parse: typeof parse;
+  mergeCidr: typeof mergeCidr;
+  excludeCidr: typeof excludeCidr;
+  expandCidr: typeof expandCidr;
+  overlapCidr: typeof overlapCidr;
+  normalizeCidr: typeof normalizeCidr;
+  containsCidr: typeof containsCidr;
+  parseCidr: typeof parseCidr;
 };
 export default _default;

package/index.js

@@ -16,7 +16,7 @@ function compare(a, b) {
 }
 
 function doNormalize(cidr, {compress = true, hexify = false} = {}) {
-  const {start, end, prefix, version} = parse(cidr);
+  const {start, end, prefix, version} = parseCidr(cidr);
   if (start !== end) { // cidr
     // set network address to first address
     const ip = normalizeIp(stringifyIp({number: start, version}), {compress, hexify});
@@ -26,15 +26,15 @@ function doNormalize(cidr, {compress = true, hexify = false} = {}) {
   }
 }
 
-export function normalize(cidr, {compress = true, hexify = false} = {}) {
+export function normalizeCidr(cidr, {compress = true, hexify = false} = {}) {
   if (Array.isArray(cidr)) {
-    return cidr.map(entry => normalize(entry, {compress, hexify}));
+    return cidr.map(entry => normalizeCidr(entry, {compress, hexify}));
   } else {
     return doNormalize(cidr, {compress, hexify});
   }
 }
 
-export function parse(str) {
+export function parseCidr(str) {
   const cidrVer = cidrVersion(str);
   const parsed = Object.create(null);
 
@@ -152,7 +152,7 @@ function excludeNets(a, b, v) {
     }
   }
 
-  return merge(remaining);
+  return mergeCidr(remaining);
 }
 
 function biggestPowerOfTwo(num) {
@@ -223,7 +223,7 @@ function diff(a, b) {
 }
 
 function formatPart(part, version) {
-  const ip = normalize(stringifyIp({number: BigInt(part.start.toString()), version}));
+  const ip = normalizeCidr(stringifyIp({number: BigInt(part.start.toString()), version}));
   const zeroes = diff(part.end, part.start).toString(2);
   const prefix = bits[version] - (zeroes.match(/0/g) || []).length;
   return `${ip}/${prefix}`;
@@ -288,9 +288,9 @@ function doMerge(maps, v) {
   return merged;
 }
 
-export function merge(nets) {
+export function mergeCidr(nets) {
   // sort to workaround https://github.com/silverwind/cidr-tools/issues/17
-  nets = uniq((Array.isArray(nets) ? nets : [nets]).sort(compare).map(parse));
+  nets = uniq((Array.isArray(nets) ? nets : [nets]).sort(compare).map(parseCidr));
   const maps = mapNets(nets);
 
   const merged = {4: [], 6: []};
@@ -301,12 +301,12 @@ export function merge(nets) {
   return [...merged[4].sort(compare), ...merged[6].sort(compare)];
 }
 
-export function exclude(basenets, exclnets) {
+export function excludeCidr(basenets, exclnets) {
   basenets = uniq(Array.isArray(basenets) ? basenets : [basenets]);
   exclnets = uniq(Array.isArray(exclnets) ? exclnets : [exclnets]);
 
-  basenets = merge(basenets);
-  exclnets = merge(exclnets);
+  basenets = mergeCidr(basenets);
+  exclnets = mergeCidr(exclnets);
 
   const bases = {4: [], 6: []};
   const excls = {4: [], 6: []};
@@ -322,8 +322,8 @@ export function exclude(basenets, exclnets) {
   for (const v of [4, 6]) {
     for (const exclcidr of excls[v]) {
       for (const [index, basecidr] of bases[v].entries()) {
-        const base = parse(basecidr);
-        const excl = parse(exclcidr);
+        const base = parseCidr(basecidr);
+        const excl = parseCidr(exclcidr);
         const remainders = excludeNets(base, excl, v);
         if (base.cidr !== remainders.toString()) {
           bases[v] = bases[v].concat(remainders);
@@ -336,27 +336,27 @@ export function exclude(basenets, exclnets) {
   return bases[4].concat(bases[6]).sort(compare);
 }
 
-export function expand(nets) {
+export function expandCidr(nets) {
   nets = uniq(Array.isArray(nets) ? nets : [nets]);
 
   const ips = [];
-  for (const net of merge(nets)) {
-    const {start, end, version} = parse(net);
+  for (const net of mergeCidr(nets)) {
+    const {start, end, version} = parseCidr(net);
     for (let number = start; number <= end; number++) {
       ips.push(stringifyIp({number, version}));
     }
   }
-  return ips.map(normalize);
+  return ips.map(normalizeCidr);
 }
 
-export function overlap(a, b) {
+export function overlapCidr(a, b) {
   const aNets = uniq(Array.isArray(a) ? a : [a]);
   const bNets = uniq(Array.isArray(b) ? b : [b]);
 
   for (const a of aNets) {
-    const aParsed = parse(a);
+    const aParsed = parseCidr(a);
     for (const b of bNets) {
-      const bParsed = parse(b);
+      const bParsed = parseCidr(b);
 
       // version mismatch
       if (aParsed.version !== bParsed.version) {
@@ -372,16 +372,16 @@ export function overlap(a, b) {
   return false;
 }
 
-export function contains(a, b) {
+export function containsCidr(a, b) {
   const aNets = uniq(Array.isArray(a) ? a : [a]);
   const bNets = uniq(Array.isArray(b) ? b : [b]);
 
   const numExpected = bNets.length;
   let numFound = 0;
   for (const a of aNets) {
-    const aParsed = parse(a);
+    const aParsed = parseCidr(a);
     for (const b of bNets) {
-      const bParsed = parse(b);
+      const bParsed = parseCidr(b);
 
       // version mismatch
       if (aParsed.version !== bParsed.version) {
@@ -399,11 +399,11 @@ export function contains(a, b) {
 }
 
 export default {
-  merge,
-  exclude,
-  expand,
-  overlap,
-  contains,
-  normalize,
-  parse,
+  mergeCidr,
+  excludeCidr,
+  expandCidr,
+  overlapCidr,
+  containsCidr,
+  normalizeCidr,
+  parseCidr,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidr-tools",
-  "version": "8.0.0",
+  "version": "9.0.0",
   "author": "silverwind <me@silverwind.io>",
   "description": "Tools to work with IPv4 and IPv6 CIDR",
   "repository": "silverwind/cidr-tools",