cidr-tools 13.0.3 → 13.0.4

package/README.md

@@ -1,9 +1,14 @@
 # cidr-tools
 [![](https://img.shields.io/npm/v/cidr-tools.svg?style=flat)](https://www.npmjs.org/package/cidr-tools) [![](https://img.shields.io/npm/dm/cidr-tools.svg)](https://www.npmjs.org/package/cidr-tools) [![](https://img.shields.io/bundlephobia/minzip/cidr-tools.svg)](https://bundlephobia.com/package/cidr-tools) [![](https://packagephobia.com/badge?p=cidr-tools)](https://packagephobia.com/result?p=cidr-tools) [![](https://depx.co/api/badge/cidr-tools)](https://depx.co/pkg/cidr-tools)
+
 > Tools to work with IPv4 and IPv6 CIDR
 
 ## Usage
 
+```sh
+pnpm add cidr-tools
+```
+
 ```js
 import {mergeCidr, excludeCidr, expandCidr, overlapCidr, containsCidr, normalizeCidr, parseCidr} from "cidr-tools";
 
@@ -26,12 +31,12 @@ normalizeCidr("::ffff/64");
 //=> "::/64"
 
 parseCidr("::/64");
-//=> {cidr: "::/64", version: 6, prefix: "64", start: 0n, end: 18446744073709551615n}
+//=> {cidr: "::/64", ip: "::", version: 6, prefix: "64", prefixPresent: true, start: 0n, end: 18446744073709551615n}
 ```
 
 ## API
 
-All functions take CIDR addresses or single IP addresses. On single addresses, a prefix of `/32` or `/128` is assumed. Function that return networks will return a merged and sorted set of networks with IPv4 sorted before IPv6.
+All functions take CIDR addresses or single IP addresses. On single addresses, a prefix of `/32` or `/128` is assumed. `mergeCidr`, `excludeCidr` and `expandCidr` return a merged and sorted set with IPv4 sorted before IPv6.
 
 Networks are validated with [cidr-regex](https://github.com/silverwind/cidr-regex) and anything that is not a CIDR or IP address throws, including out-of-family prefixes like `1.2.3.4/33` and ambiguous zero-padded octets like `010.0.0.1`.
 
@@ -72,21 +77,21 @@ if (end - start >= 1000000n) {
 
 ### overlapCidr(networksA, networksB, [opts])
 
-- `networksA` *String* or *Array*: One or more CIDR or IP address.
-- `networksB` *String* or *Array*: One or more CIDR or IP address.
+- `networksA` *String* or *Array*: One or more CIDR or IP addresses.
+- `networksB` *String* or *Array*: One or more CIDR or IP addresses.
 
 Returns a boolean that indicates if `networksA` overlap (intersect) with `networksB`.
 
 ### containsCidr(networksA, networksB, [opts])
 
-- `networksA` *String* or *Array*: One or more CIDR or IP address.
-- `networksB` *String* or *Array*: One or more CIDR or IP address.
+- `networksA` *String* or *Array*: One or more CIDR or IP addresses.
+- `networksB` *String* or *Array*: One or more CIDR or IP addresses.
 
 Returns a boolean that indicates whether `networksA` fully contain all `networksB`.
 
 ### normalizeCidr(networks, [opts])
 
-- `networks` *String* or *Array*: One or more CIDR or IP address.
+- `networks` *String* or *Array*: One or more CIDR or IP addresses.
 
 Returns a string or array (depending on input) with a normalized representation. Will not include a prefix on single IPs. Will set network address to the start of the network.
 
@@ -115,4 +120,4 @@ Returns a `parsed` Object which is used internally by this module. It can be use
 - [is-cidr](https://github.com/silverwind/is-cidr) - Check if a string is an IP address in CIDR notation
 - [cidr-regex](https://github.com/silverwind/cidr-regex) - Regular expression for matching IP addresses in CIDR notation and bare IP addresses
 
-© [silverwind](https://github.com/silverwind), distributed under BSD licence.
+© [silverwind](https://github.com/silverwind), distributed under BSD licence

package/dist/index.js

@@ -106,10 +106,13 @@ function parseIPv4Range(str) {
 	rangeV4End = (v4num | mask) >>> 0;
 	return true;
 }
+function formatPrefix(prefixNum) {
+	return prefixStrings[prefixNum] ?? `/${prefixNum}`;
+}
 function doNormalize(cidr, opts) {
 	if (parseIPv4Range(cidr)) {
 		const ip = formatIPv4Fast(rangeV4Start);
-		return rangeSlashIndex !== -1 ? ip + prefixStrings[rangeV4Prefix] : ip;
+		return rangeSlashIndex !== -1 ? ip + formatPrefix(rangeV4Prefix) : ip;
 	}
 	const slashIndex = rangeSlashIndex;
 	const prefixPresent = slashIndex !== -1;
@@ -117,15 +120,13 @@ function doNormalize(cidr, opts) {
 	const { number, version, ipv4mapped, scopeid } = parseIp(prefixPresent ? cidr.substring(0, slashIndex) : cidr, unchecked);
 	if (prefixNum === -1) prefixNum = bits[version];
 	if (version === 4) {
-		const hostBits = 32 - prefixNum;
-		const mask = hostMasks4[Math.max(hostBits, 0)];
+		const mask = hostMasks4[Math.max(32 - prefixNum, 0)];
 		const ip = formatIPv4Fast((Number(number) & ~mask) >>> 0);
-		return hostBits > 0 || prefixPresent ? ip + prefixStrings[prefixNum] : ip;
+		return prefixPresent ? ip + formatPrefix(prefixNum) : ip;
 	}
 	const compress = opts?.compress ?? true;
 	const hexify = opts?.hexify ?? false;
-	const hostBits = 128 - prefixNum;
-	if (hostBits <= 0 && !prefixPresent) return stringifyIp({
+	if (!prefixPresent) return stringifyIp({
 		number,
 		version,
 		ipv4mapped,
@@ -134,6 +135,7 @@ function doNormalize(cidr, opts) {
 		compress,
 		hexify
 	});
+	const hostBits = 128 - prefixNum;
 	const start = hostBits > 0 ? number & hostNotMasks[hostBits] : number;
 	const startMapped = ipv4mapped && start >> 32n === 65535n;
 	return stringifyIp({
@@ -144,7 +146,7 @@ function doNormalize(cidr, opts) {
 	}, {
 		compress,
 		hexify
-	}) + prefixStrings[prefixNum];
+	}) + formatPrefix(prefixNum);
 }
 /** Returns a string or array (depending on input) with a normalized representation. Will not include a prefix on single IPs. Will set network address to the start of the network. */
 function normalizeCidr(cidr, opts) {
@@ -162,7 +164,7 @@ function parseCidr(str, opts) {
 		const ip = formatIPv4Fast(v4num);
 		const mask = hostMasks4[Math.max(32 - prefixNum, 0)];
 		return {
-			cidr: ip + prefixStrings[prefixNum],
+			cidr: ip + formatPrefix(prefixNum),
 			ip,
 			version: 4,
 			prefix: prefixNumStrings[prefixNum] ?? String(prefixNum),
@@ -171,12 +173,10 @@ function parseCidr(str, opts) {
 			end: BigInt((v4num | mask) >>> 0)
 		};
 	}
-	const ipPart = prefixPresent ? str.substring(0, slashIndex) : str;
 	let prefixNum = prefixPresent ? parsePrefixNum(str, slashIndex) : -1;
-	const { number, version, ipv4mapped, scopeid } = parseIp(ipPart, unchecked);
+	const { number, version, ipv4mapped, scopeid } = parseIp(prefixPresent ? str.substring(0, slashIndex) : str, unchecked);
 	const numBits = bits[version];
 	if (prefixNum === -1) prefixNum = numBits;
-	const prefix = prefixNumStrings[prefixNum] ?? String(prefixNum);
 	const ip = stringifyIp({
 		number,
 		version,
@@ -191,10 +191,10 @@ function parseCidr(str, opts) {
 		end = number | hostMasks[hostBits];
 	}
 	return {
-		cidr: ip + prefixStrings[prefixNum],
+		cidr: ip + formatPrefix(prefixNum),
 		ip,
 		version,
-		prefix,
+		prefix: prefixNumStrings[prefixNum] ?? String(prefixNum),
 		prefixPresent,
 		start,
 		end
@@ -202,9 +202,8 @@ function parseCidr(str, opts) {
 }
 function parseCidrLeanSlow(str) {
 	const slashIndex = rangeSlashIndex;
-	const ipPart = slashIndex !== -1 ? str.substring(0, slashIndex) : str;
 	let prefixNum = slashIndex !== -1 ? parsePrefixNum(str, slashIndex) : -1;
-	const { number, version } = parseIp(ipPart, unchecked);
+	const { number, version } = parseIp(slashIndex !== -1 ? str.substring(0, slashIndex) : str, unchecked);
 	const numBits = bits[version];
 	if (prefixNum === -1) prefixNum = numBits;
 	const hostBits = numBits - prefixNum;
@@ -237,7 +236,6 @@ function parseCidrLean(str) {
 	return parseCidrLeanSlow(str);
 }
 function bigintBitLength(n) {
-	if (n === 0n) return 0;
 	let len = 0;
 	if (n >= 18446744073709551616n) {
 		n >>= 64n;
@@ -250,7 +248,6 @@ function bigintBitLength(n) {
 	return len + 32 - Math.clz32(Number(n));
 }
 function biggestPowerOfTwo4(num) {
-	if (num === 0) return 0;
 	if (num >= 4294967296) return 4294967296;
 	return 1 << 31 - Math.clz32(num) >>> 0;
 }
@@ -325,7 +322,6 @@ function mergeIntervalsRaw6(nets) {
 }
 function subtractSorted4(bases, excls) {
 	if (excls.length === 0) return bases;
-	if (bases.length === 0) return [];
 	const result = [];
 	let j = 0;
 	for (const base of bases) {
@@ -350,7 +346,6 @@ function subtractSorted4(bases, excls) {
 }
 function subtractSorted6(bases, excls) {
 	if (excls.length === 0) return bases;
-	if (bases.length === 0) return [];
 	const result = [];
 	let j = 0;
 	for (const base of bases) {
@@ -420,7 +415,7 @@ function* expandChecked(nets) {
 		if (net.version === 4) v4.push(net);
 		else v6.push(net);
 	}
-	if (v4.length > 0) for (const part of mergeIntervalsRaw4(v4)) {
+	for (const part of mergeIntervalsRaw4(v4)) {
 		let prevHigh = -1;
 		let prefix = "";
 		for (let num = part.start; num <= part.end; num++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidr-tools",
-  "version": "13.0.3",
+  "version": "13.0.4",
   "author": "silverwind <me@silverwind.io>",
   "description": "Tools to work with IPv4 and IPv6 CIDR",
   "keywords": [
@@ -38,7 +38,6 @@
     "@vitest/coverage-v8": "5.0.2",
     "eslint": "10.11.0",
     "eslint-config-silverwind": "151.0.1",
-    "jest-extended": "7.0.0",
     "tsdown": "0.23.0",
     "tsdown-config-silverwind": "4.1.2",
     "typescript": "6.0.3",