cidr-tools 6.2.1 → 6.4.0

package/README.md

@@ -11,7 +11,7 @@ $ npm i cidr-tools
 ## Example
 
 ```js
-import {merge, exclude, expand, overlap, contains, normalize} from 'cidr-tools';
+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']
@@ -19,6 +19,7 @@ expand(['2001:db8::/126']) //=> ['2001:db8::', '2001:db8::1', '2001:db8::2', '20
 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}
 ```
 
 ## API
@@ -70,4 +71,19 @@ 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)
+
+- `network` *String*: A CIDR or IP address.
+
+Returns a `parsed` Object. Specifically, this can be used to test whether the passed CIDR or IP is IPv4 or IPv6.
+
+`parsed`: `Object`
+  - `cidr` String: The CIDR of the network.
+  - `version` Number: Either `4` or `6`.
+  - `prefix` String: The network prefix, e.g. `/64`.
+  - `start` BigInt: Start of the network.
+  - `end` BigInt: Start of the network.
+  - `single` Boolean: `true` when is a single IP.
+
+
 © [silverwind](https://github.com/silverwind), distributed under BSD licence.

package/index.d.ts

@@ -1,3 +1,5 @@
+import exp from "constants";
+
 type IPv4Address = string;
 type IPv4CIDR = string;
 type IPv6Address = string;
@@ -6,17 +8,35 @@ type IPv6CIDR = string;
 type Network = IPv4Address | IPv4CIDR | IPv6Address | IPv6CIDR;
 type Networks = Network | Network[];
 
-interface CIDRTools {
-  merge(networks: Networks): Network[];
-  exclude(baseNetworks: Networks, excludeNetworks: Networks): Network[];
-  expand(networks: Networks): Network[];
-  overlap(networksA: Networks, networksB: Networks): boolean;
-  normalize(cidr: Networks): Networks;
-  contains(networksA: Networks, networksB: Networks): boolean;
-}
+type Parsed = {
+  cidr: string;
+  version: number;
+  prefix: string;
+  start: bigint;
+  end: bigint;
+  single: boolean;
+};
+
+type NormalizeOpts = {
+  compress?: boolean;
+  hexify?: boolean;
+};
 
-declare const cidrTools : CIDRTools;
+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;
 
-declare module "cidr-tools" {
-  export = cidrTools;
-}
+declare const _default: {
+  merge: typeof merge;
+  exclude: typeof exclude;
+  expand: typeof expand;
+  overlap: typeof overlap;
+  normalize: typeof normalize;
+  contains: typeof contains;
+  parse: typeof parse;
+};
+export default _default;

package/index.js

@@ -10,7 +10,7 @@ const bits = {
 
 const uniq = arr => Array.from(new Set(arr));
 
-function isIP(ip) {
+export function isIP(ip) {
   if (ipRegex.v4({exact: true}).test(ip)) return 4;
   if (ipRegex.v6({exact: true}).test(ip)) return 6;
   return 0;
@@ -41,9 +41,11 @@ export function normalize(cidr, {compress = true, hexify = false} = {}) {
   }
 }
 
-function parse(str) {
+export function parse(str) {
   const cidrVersion = isCidr(str);
   const parsed = Object.create(null);
+  parsed.single = false;
+
   if (cidrVersion) {
     parsed.cidr = str;
     parsed.version = cidrVersion;
@@ -395,3 +397,13 @@ export function contains(a, b) {
 
   return numFound === numExpected;
 }
+
+export default {
+  merge,
+  exclude,
+  expand,
+  overlap,
+  contains,
+  normalize,
+  parse,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidr-tools",
-  "version": "6.2.1",
+  "version": "6.4.0",
   "author": "silverwind <me@silverwind.io>",
   "description": "Tools to work with IPv4 and IPv6 CIDR",
   "repository": "silverwind/cidr-tools",
@@ -14,8 +14,8 @@
     "node": ">=16"
   },
   "files": [
-    "index.js",
-    "index.d.ts"
+    "./index.js",
+    "./index.d.ts"
   ],
   "dependencies": {
     "cidr-regex": "4.0.3",
@@ -26,6 +26,7 @@
   "devDependencies": {
     "eslint": "8.42.0",
     "eslint-config-silverwind": "73.0.2",
+    "tsd": "0.28.1",
     "updates": "14.1.1",
     "versions": "11.0.1",
     "vitest": "0.32.0"