cidr-block 1.0.1 → 1.1.0

package/README.md

@@ -1,2 +1,71 @@
 # cidr-block
-npm package for calculating CIDR range blocks
+
+ipv4 and ipv6 address and cidr range utilities
+
+## WARNING
+
+This package is still in _very_ early stages and should **NOT** be used in production code!
+
+## Installation
+
+To install npm package, run the following in your project:
+
+```bash
+npm install cidr-block
+```
+
+or if you're using yarn instead of npm
+
+```bash
+yarn add cidr-block
+```
+
+The package is written completely in TypeScript and exports all of it's types automatically,
+meaning you don't need to install any additional `@types` typings.
+
+## Getting Started
+
+Start by defining a cidr range
+
+```typescript
+import { ipv4 as ip } from 'cidr-block'
+
+const myCidr = ip.cidr('10.0.0.0/24')
+```
+
+To get the next logical cidr block
+
+```typescript
+console.log(myCidr.nextBlock().toString()) // 10.0.1.0/24
+```
+
+All `cidr-block` functions and methods are immutable, meaning a new instance will always be
+returned instead of trying to modify the current value.
+
+Once you have a cidr, you have access to all of it's related utilities:
+
+```typescript
+myCidr.netmask // 255.255.255.0
+myCidr.firstUsableIp // 10.0.0.0 (remember that methods act immutable, so this is still at 10.0.0.0)
+myCidr.lastUsableIp // 10.0.0.254
+myCidr.includes(ip.address('10.0.0.128')) // true
+```
+
+## Documentation and API Reference
+
+The full documentation and API reference can be found at https://cidr-block.com
+
+## FAQ
+
+Q: Why are the imports in all the example code like that?
+
+A: The imports in all example code are formatted as the following:
+
+```typescript
+import { ipv4 as ip } from 'cidr-block'
+// or commonjs-style
+const { ipv4: ip } = require('cidr-block')
+```
+
+While you don't have to follow this convention, the API is design like this on purpose to help speed
+up a refactoring of ipv4 to ipv6, as you would only need to change the number on the import.

package/build/{src/cidr → cidr}/errors.d.ts

@@ -1,6 +1,6 @@
 export declare class InvalidIpAddressError extends Error {
     constructor(badIp: string);
 }
-export declare class InvalidCidrError extends Error {
+export declare class InvalidCidrBlockError extends Error {
     constructor(badCidr: string);
 }

package/build/cidr/ipv4/constants.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The numerical maximum size an IPv4 address can be
+ */
+export declare const MAX: bigint;

package/build/cidr/ipv4/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ipv4-address';
+export * from './ipv4-cidr';
+export * from './constants';
+export * from './types';

package/build/cidr/ipv4/ipv4-address.d.ts

@@ -0,0 +1,137 @@
+import { Ipv4Literal, Ipv4Representable } from './types';
+/**
+ * Representation of an IPv4 address. Provides various utility methods like equality
+ * checking.
+ *
+ * @remarks
+ * Direct instantiation should be avoided; use {@link ipv4.address|ipv4.address()} instead.
+ */
+export declare class Ipv4Address {
+    private _address;
+    constructor(address: Ipv4Literal);
+    /**
+     * The address as a big integer
+     */
+    get address(): bigint;
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * ip.address(255n)                                    // ==> '0.0.0.255'
+     * ip.address(0b11111111_00000000_11111111_00000000n)  // ==> '255.0.255.0'
+     * ````
+     *
+     * @public
+     * @returns the IPv4 address as a string
+     */
+    toString(): string;
+    /**
+     * Compares if two IP address are the same.
+     *
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * function isLoopback(address: Ipv4Representable) {
+     *  return ip.address(address).equals('127.0.0.1')
+     * }
+     * ```
+     *
+     * @public
+     * @param otherIpAddress the other IPv4 address to compare
+     * @returns if the other IP address is the same
+     */
+    equals(otherIpAddress: Ipv4Representable): boolean;
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('52.89.32.255')
+     * myIp.nextIp()                                       // ==> '52.89.33.0
+     * ```
+     *
+     * @public
+     * @returns the next consecutive IPv4 address
+     */
+    nextIp(): Ipv4Address;
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('52.89.32.19')
+     * myIp.previousIp()                                   // ==> '52.89.32.18
+     * ```
+     *
+     * @public
+     * @returns the preceding IPv4 address
+     */
+    previousIp(): Ipv4Address;
+}
+/**
+ * Convenience function for creating an IPv4 address instance.
+ *
+ * @remarks
+ *
+ * In general, you should use this function instead of instantiating an Ipv4Address
+ * object directly. While there is nothing wrong with direct instantiation, convenience
+ * methods like these are meant to help reduce the footprint of your code and increase
+ * readability.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { ipv4 as ip } from 'cidr-block'
+ *
+ * const localhost = ip.address('127.0.0.1')
+ * ```
+ *
+ * @see {@link Ipv4Address}
+ *
+ * @param ip string representation of the IPv4 address
+ * @returns an instance of Ipv4Address
+ */
+export declare function address(ip: Ipv4Literal): Ipv4Address;
+/**
+ * Converts the string representation of an IPv4 address to a BigInt.
+ *
+ * @example
+ *
+ * ```typescript
+ * import * as cidr from 'cidr-block'
+ *
+ * cidr.ipv4.stringToNum('255.255.255.255') === 4_294_967_295n     // ==> true
+ * cidr.ipv4.stringToNum('0.0.0.255') === 255n                     // ==> true
+ * ```
+ *
+ * @see This method is the inverse of {@link ipv4.numToString}
+ * @throws {@link InvalidIpAddressError}
+ *
+ * @public
+ * @param address IPv4 address represented as a string
+ * @returns numerical BigInt representation of the address
+ */
+export declare function stringToNum(address: string): bigint;
+/**
+ * Converts the numerical BigInt representation of an IPv4 address to its string representation.
+ *
+ * @example
+ *
+ * ```typescript
+ * import * as cidr from 'cidr-block'
+ *
+ * cidr.ipv4.numToString(0n) === '0.0.0.0'                            // ==> true
+ * cidr.ipv4.numToString(65_280n) === '0.0.255.0'                     // ==> true
+ * cidr.ipv4.numToString(4_294_967_295n) === '255.255.255.255'        // ==> true
+ * ```
+ *
+ * @see This method is the inverse of {@link ipv4.stringToNum}
+ * @throws {@link InvalidIpAddressError}
+ *
+ * @public
+ * @param ip IPv4 address as a BigInt
+ * @returns string representation of the address
+ */
+export declare function numToString(ip: bigint): string;

package/build/cidr/ipv4/ipv4-cidr.d.ts

@@ -0,0 +1,68 @@
+import { Ipv4Representable } from './types';
+import { Ipv4Address } from './ipv4-address';
+export declare class Ipv4Cidr {
+    private _ipAddress;
+    private _maskSize;
+    constructor(cidrRange: string);
+    /**
+     * The size of the cidr netmask (the number after the slash in cidr notation)
+     */
+    get maskSize(): number;
+    /**
+     * Number of IP addresses within the cidr range
+     */
+    get allocatableIpCount(): bigint;
+    /**
+     * The actual IPv4 netmask address
+     */
+    get netmask(): Ipv4Address;
+    /**
+     * The first IPv4 address that is usable within the given cidr range
+     */
+    get firstUsableIp(): Ipv4Address;
+    /**
+     * The last IPv4 address that is usable within the given cidr range
+     */
+    get lastUsableIp(): Ipv4Address;
+    private get addressLength();
+    /**
+     * @returns string representation of the cidr range
+     */
+    toString(): string;
+    /**
+     * @returns the next consecutive cidr block
+     */
+    nextBlock(ofSize?: number): Ipv4Cidr;
+    /**
+     * @returns the previous cidr block
+     */
+    previousBlock(): Ipv4Cidr;
+    /**
+     * @returns if the given IPv4 address is within the cidr range
+     */
+    includes(address: Ipv4Representable): boolean;
+}
+/**
+ * Convenience function for creating an IPv4 cidr range instance.
+ *
+ * @remarks
+ *
+ * In general, you should use this function instead of instantiating an Ipv4Cidr
+ * object directly. While there is nothing wrong with direct instantiation, convenience
+ * methods like these are meant to help reduce the footprint of your code and increase
+ * readability.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { ipv4 as ip } from 'cidr-block'
+ *
+ * const vpcCidrRange = ip.cidr('10.0.0.0/16')
+ * ```
+ *
+ * @see {@link Ipv4Cidr}
+ *
+ * @param cidrRange string representation of the cidr range
+ * @returns an instance of Ipv4Cidr
+ */
+export declare function cidr(cidrRange: string): Ipv4Cidr;

package/build/cidr/ipv4/types.d.ts

@@ -0,0 +1,9 @@
+import { Ipv4Address } from './ipv4-address';
+/**
+ * Type that indicates a literal string or bigint value that represents an IPv4 address
+ */
+export declare type Ipv4Literal = string | bigint;
+/**
+ * Type that indicates either a literal value or an address instance that is an IPv4
+ */
+export declare type Ipv4Representable = Ipv4Address | Ipv4Literal;

package/build/cidr/ipv6/constants.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The numerical maximum size an IPv6 address can be
+ */
+export declare const MAX: bigint;

package/build/cidr/ipv6/index.d.ts

@@ -0,0 +1 @@
+export * from './constants';

package/build/index.d.ts

@@ -0,0 +1,3 @@
+export * as ipv4 from './cidr/ipv4/index';
+export * as ipv6 from './cidr/ipv6/index';
+export * as errors from './cidr/errors';

package/build/index.esm.js

@@ -1,20 +1,16 @@
-/**
- * The numerical maximum size an IPv4 address can be
- */
-const IPv4_MAX = 2n ** 32n;
-/**
- * The numerical maximum size an IPv6 address can be
- */
-const IPv6_MAX = 2n ** 64n;class InvalidIpAddressError extends Error {
+class InvalidIpAddressError extends Error {
     constructor(badIp) {
-        super(`${badIp} is not a valid IP address.`);
+        super(`${badIp} is not a valid IPv4 address.`);
     }
 }
-class InvalidCidrError extends Error {
+class InvalidCidrBlockError extends Error {
     constructor(badCidr) {
-        super(`${badCidr} is not a valid cidr block or range.`);
+        super(`${badCidr} is not a valid IPv4 cidr block.`);
     }
-}const MAX_OCTET_SIZE = 255n;
+}var errors=/*#__PURE__*/Object.freeze({__proto__:null,InvalidIpAddressError:InvalidIpAddressError,InvalidCidrBlockError:InvalidCidrBlockError});/**
+ * The numerical maximum size an IPv4 address can be
+ */
+const MAX$1 = 2n ** 32n - 1n;const MAX_OCTET_SIZE = 255n;
 /**
  * Representation of an IPv4 address. Provides various utility methods like equality
  * checking.
@@ -23,26 +19,84 @@ class InvalidCidrError extends Error {
  * Direct instantiation should be avoided; use {@link ipv4.address|ipv4.address()} instead.
  */
 class Ipv4Address {
-    address;
+    _address;
     constructor(address) {
-        this.address = fromString(address);
+        this._address = typeof address === 'bigint' ? address : stringToNum(address);
+    }
+    /**
+     * The address as a big integer
+     */
+    get address() {
+        return this._address;
     }
     /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * ip.address(255n)                                    // ==> '0.0.0.255'
+     * ip.address(0b11111111_00000000_11111111_00000000n)  // ==> '255.0.255.0'
+     * ````
+     *
      * @public
      * @returns the IPv4 address as a string
      */
     toString() {
-        return toString(this.address);
+        return numToString(this._address);
     }
     /**
      * Compares if two IP address are the same.
      *
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * function isLoopback(address: Ipv4Representable) {
+     *  return ip.address(address).equals('127.0.0.1')
+     * }
+     * ```
+     *
      * @public
      * @param otherIpAddress the other IPv4 address to compare
      * @returns if the other IP address is the same
      */
     equals(otherIpAddress) {
-        return this.address === otherIpAddress.address;
+        if (otherIpAddress instanceof Ipv4Address) {
+            return this._address === otherIpAddress._address;
+        }
+        else {
+            return this._address === address(otherIpAddress)._address;
+        }
+    }
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('52.89.32.255')
+     * myIp.nextIp()                                       // ==> '52.89.33.0
+     * ```
+     *
+     * @public
+     * @returns the next consecutive IPv4 address
+     */
+    nextIp() {
+        return address(this._address + 1n);
+    }
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('52.89.32.19')
+     * myIp.previousIp()                                   // ==> '52.89.32.18
+     * ```
+     *
+     * @public
+     * @returns the preceding IPv4 address
+     */
+    previousIp() {
+        return address(this._address - 1n);
     }
 }
 /**
@@ -58,9 +112,9 @@ class Ipv4Address {
  * @example
  *
  * ```typescript
- * import * as cidr from 'cidr-block'
+ * import { ipv4 as ip } from 'cidr-block'
  *
- * const localhost = cidr.ipv4.address('172.0.0.0')
+ * const localhost = ip.address('127.0.0.1')
  * ```
  *
  * @see {@link Ipv4Address}
@@ -74,29 +128,23 @@ function address(ip) {
 /**
  * Converts the string representation of an IPv4 address to a BigInt.
  *
- * @remarks
- *
- * Conversion must be between string and bigint instead of integer as
- * on 32-bit systems, Node.js may allocate the number as a 32-bit integer.
- * To avoid this behavior, a BigInt is always used instead.
- *
  * @example
  *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
- * cidr.ipv4.fromString('255.255.255.255') === 4_294_967_295n     // ==> true
- * cidr.ipv4.fromString('0.0.0.255') === 255n                     // ==> true
+ * cidr.ipv4.stringToNum('255.255.255.255') === 4_294_967_295n     // ==> true
+ * cidr.ipv4.stringToNum('0.0.0.255') === 255n                     // ==> true
  * ```
  *
- * @see This method is the inverse of {@link ipv4.toString|ipv4.toString()}
+ * @see This method is the inverse of {@link ipv4.numToString}
  * @throws {@link InvalidIpAddressError}
  *
  * @public
  * @param address IPv4 address represented as a string
  * @returns numerical BigInt representation of the address
  */
-function fromString(address) {
+function stringToNum(address) {
     try {
         let [firstOctet, secondOctet, thirdOctet, fourthOctet] = address
             .split('.')
@@ -115,36 +163,142 @@ function fromString(address) {
 /**
  * Converts the numerical BigInt representation of an IPv4 address to its string representation.
  *
- * @remarks
- *
- * Conversion must be between string and bigint instead of integer as
- * on 32-bit systems, Node.js may allocate the number as a 32-bit integer.
- * To avoid this behavior, a BigInt is always used instead.
- *
  * @example
  *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
- * cidr.ipv4.toString(0n) === '0.0.0.0'                            // ==> true
- * cidr.ipv4.toString(65_280n) === '0.0.255.0'                     // ==> true
- * cidr.ipv4.toString(4_294_967_295n) === '255.255.255.255'        // ==> true
+ * cidr.ipv4.numToString(0n) === '0.0.0.0'                            // ==> true
+ * cidr.ipv4.numToString(65_280n) === '0.0.255.0'                     // ==> true
+ * cidr.ipv4.numToString(4_294_967_295n) === '255.255.255.255'        // ==> true
  * ```
  *
- * @see This method is the inverse of {@link ipv4.fromString|ipv4.fromString()}
+ * @see This method is the inverse of {@link ipv4.stringToNum}
  * @throws {@link InvalidIpAddressError}
  *
  * @public
  * @param ip IPv4 address as a BigInt
  * @returns string representation of the address
  */
-function toString(ip) {
-    if (ip < 0 || ip > IPv4_MAX) {
+function numToString(ip) {
+    try {
+        if (ip < 0 || ip > MAX$1) {
+            throw new Error();
+        }
+        const firstOctet = (ip >> 24n) & MAX_OCTET_SIZE;
+        const secondOctet = (ip >> 16n) & MAX_OCTET_SIZE;
+        const thirdOctet = (ip >> 8n) & MAX_OCTET_SIZE;
+        const fourthOctet = ip & MAX_OCTET_SIZE;
+        return `${firstOctet}.${secondOctet}.${thirdOctet}.${fourthOctet}`;
+    }
+    catch {
         throw new InvalidIpAddressError(ip.toString());
     }
-    const firstOctet = (ip >> 24n) & MAX_OCTET_SIZE;
-    const secondOctet = (ip >> 16n) & MAX_OCTET_SIZE;
-    const thirdOctet = (ip >> 8n) & MAX_OCTET_SIZE;
-    const fourthOctet = ip & MAX_OCTET_SIZE;
-    return `${firstOctet}.${secondOctet}.${thirdOctet}.${fourthOctet}`;
-}var index=/*#__PURE__*/Object.freeze({__proto__:null,Ipv4Address:Ipv4Address,address:address,fromString:fromString,toString:toString});export{IPv4_MAX,IPv6_MAX,InvalidCidrError,InvalidIpAddressError,index as ipv4};//# sourceMappingURL=index.esm.js.map
+}class Ipv4Cidr {
+    _ipAddress;
+    _maskSize;
+    // TODO: Allow wider-range of values that can be used to create a cidr
+    constructor(cidrRange) {
+        try {
+            const [address$1, subnetMask] = cidrRange.split('/');
+            this._ipAddress = address(address$1);
+            this._maskSize = Number(subnetMask);
+        }
+        catch {
+            throw new InvalidCidrBlockError(cidrRange);
+        }
+    }
+    /**
+     * The size of the cidr netmask (the number after the slash in cidr notation)
+     */
+    get maskSize() {
+        return this._maskSize;
+    }
+    /**
+     * Number of IP addresses within the cidr range
+     */
+    get allocatableIpCount() {
+        return 2n ** this.addressLength;
+    }
+    /**
+     * The actual IPv4 netmask address
+     */
+    get netmask() {
+        return address((2n ** BigInt(this.maskSize) - 1n) << this.addressLength);
+    }
+    /**
+     * The first IPv4 address that is usable within the given cidr range
+     */
+    get firstUsableIp() {
+        return address(this._ipAddress.address);
+    }
+    /**
+     * The last IPv4 address that is usable within the given cidr range
+     */
+    get lastUsableIp() {
+        // FIXME: Handle edge case of when cidr range goes outside valid ip range
+        return address(this._ipAddress.address + 2n ** this.addressLength - 1n);
+    }
+    get addressLength() {
+        return BigInt(Math.abs(32 - this._maskSize));
+    }
+    /**
+     * @returns string representation of the cidr range
+     */
+    toString() {
+        return `${this._ipAddress.toString()}/${this._maskSize}`;
+    }
+    /**
+     * @returns the next consecutive cidr block
+     */
+    nextBlock(ofSize) {
+        const nextIp = this._ipAddress.address + 2n ** this.addressLength;
+        return cidr(`${numToString(nextIp)}/${ofSize ?? this._maskSize}`);
+    }
+    /**
+     * @returns the previous cidr block
+     */
+    previousBlock() {
+        const nextIp = this._ipAddress.address - 2n ** this.addressLength;
+        return cidr(`${numToString(nextIp)}/${this._maskSize}`);
+    }
+    /**
+     * @returns if the given IPv4 address is within the cidr range
+     */
+    includes(address$1) {
+        const ip = address$1 instanceof Ipv4Address ? address$1 : address(address$1);
+        return (
+        // FIXME: How to handle edge case of next block erroring out?
+        ip.address >= this._ipAddress.address && ip.address <= this.nextBlock()._ipAddress.address);
+    }
+}
+/**
+ * Convenience function for creating an IPv4 cidr range instance.
+ *
+ * @remarks
+ *
+ * In general, you should use this function instead of instantiating an Ipv4Cidr
+ * object directly. While there is nothing wrong with direct instantiation, convenience
+ * methods like these are meant to help reduce the footprint of your code and increase
+ * readability.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { ipv4 as ip } from 'cidr-block'
+ *
+ * const vpcCidrRange = ip.cidr('10.0.0.0/16')
+ * ```
+ *
+ * @see {@link Ipv4Cidr}
+ *
+ * @param cidrRange string representation of the cidr range
+ * @returns an instance of Ipv4Cidr
+ */
+function cidr(cidrRange) {
+    return new Ipv4Cidr(cidrRange);
+}var index$1=/*#__PURE__*/Object.freeze({__proto__:null,Ipv4Address:Ipv4Address,address:address,stringToNum:stringToNum,numToString:numToString,Ipv4Cidr:Ipv4Cidr,cidr:cidr,MAX:MAX$1});/**
+ * The numerical maximum size an IPv6 address can be
+ */
+// eslint-disable-next-line @typescript-eslint/no-inferrable-types
+const MAX = 0xffffffffffffffffn;var index=/*#__PURE__*/Object.freeze({__proto__:null,MAX:MAX});export{errors,index$1 as ipv4,index as ipv6};//# sourceMappingURL=index.esm.js.map

package/build/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../src/cidr/constants.ts","../src/cidr/errors.ts","../src/cidr/ipv4/ipv4-address.ts"],"sourcesContent":[null,null,null],"names":[],"mappings":"AAAA;;;MAGa,QAAQ,GAAG,EAAE,IAAI,IAAG;AAEjC;;;MAGa,QAAQ,GAAG,EAAE,IAAI,UCRjB,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,KAAa;QACvB,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,CAAA;KAC7C;CACF;MAEY,gBAAiB,SAAQ,KAAK;IACzC,YAAY,OAAe;QACzB,KAAK,CAAC,GAAG,OAAO,sCAAsC,CAAC,CAAA;KACxD;CCNH,MAAM,cAAc,GAAG,IAAI,CAAA;AAE3B;;;;;;;MAOa,WAAW;IACd,OAAO,CAAQ;IAEvB,YAAmB,OAAe;QAChC,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;KACnC;;;;;IAMM,QAAQ;QACb,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;KAC9B;;;;;;;;IASM,MAAM,CAAC,cAA2B;QACvC,OAAO,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC,OAAO,CAAA;KAC/C;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,OAAO,CAAC,EAAU;IAChC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;SAyBgB,UAAU,CAAC,OAAe;IACxC,IAAI;QACF,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,OAAO;aAC7D,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,cAAc,CAAC,CAAA;QACzD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,GAAG,CAAA;QAClD,WAAW,GAAG,CAAC,WAAY,GAAG,cAAc,KAAK,GAAG,CAAA;QACpD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,EAAE,CAAA;QACjD,WAAW,GAAG,WAAY,GAAG,cAAc,CAAA;QAC3C,OAAO,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;KAC3D;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAA;KACzC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;SA0BgB,QAAQ,CAAC,EAAU;IACjC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,QAAQ,EAAE;QAC3B,MAAM,IAAI,qBAAqB,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;KAC/C;IACD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;IAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;IAChD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,cAAc,CAAA;IAC9C,MAAM,WAAW,GAAG,EAAE,GAAG,cAAc,CAAA;IACvC,OAAO,GAAG,UAAU,IAAI,WAAW,IAAI,UAAU,IAAI,WAAW,EAAE,CAAA;AACpE"}
+{"version":3,"file":"index.esm.js","sources":["../src/src/cidr/errors.ts","../src/src/cidr/ipv4/constants.ts","../src/src/cidr/ipv4/ipv4-address.ts","../src/src/cidr/ipv4/ipv4-cidr.ts","../src/src/cidr/ipv6/constants.ts"],"sourcesContent":[null,null,null,null,null],"names":["MAX","address","ipAddress"],"mappings":"MAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,KAAa;QACvB,KAAK,CAAC,GAAG,KAAK,+BAA+B,CAAC,CAAA;KAC/C;CACF;MAEY,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,OAAe;QACzB,KAAK,CAAC,GAAG,OAAO,kCAAkC,CAAC,CAAA;KACpD;iJCTH;;;AAGO,MAAMA,KAAG,GAAG,EAAE,IAAI,GAAG,GAAG,EAAE,CCCjC,MAAM,cAAc,GAAG,IAAI,CAAA;AAE3B;;;;;;;MAOa,WAAW;IACd,QAAQ,CAAQ;IAExB,YAAmB,OAAoB;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,OAAO,KAAK,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAA;KAC7E;;;;IAKD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;;;;;;;;;;;;IAcM,QAAQ;QACb,OAAO,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;KAClC;;;;;;;;;;;;;;;;;IAkBM,MAAM,CAAC,cAAiC;QAC7C,IAAI,cAAc,YAAY,WAAW,EAAE;YACzC,OAAO,IAAI,CAAC,QAAQ,KAAK,cAAc,CAAC,QAAQ,CAAA;SACjD;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAA;SAC1D;KACF;;;;;;;;;;;;;IAcM,MAAM;QACX,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;;;;;;;;;;;;;IAcM,UAAU;QACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,OAAO,CAAC,EAAe;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;;SAmBgB,WAAW,CAAC,OAAe;IACzC,IAAI;QACF,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,OAAO;aAC7D,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,cAAc,CAAC,CAAA;QACzD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,GAAG,CAAA;QAClD,WAAW,GAAG,CAAC,WAAY,GAAG,cAAc,KAAK,GAAG,CAAA;QACpD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,EAAE,CAAA;QACjD,WAAW,GAAG,WAAY,GAAG,cAAc,CAAA;QAC3C,OAAO,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;KAC3D;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAA;KACzC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;SAoBgB,WAAW,CAAC,EAAU;IACpC,IAAI;QACF,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAGA,KAAG,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;QAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;QAChD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,cAAc,CAAA;QAC9C,MAAM,WAAW,GAAG,EAAE,GAAG,cAAc,CAAA;QACvC,OAAO,GAAG,UAAU,IAAI,WAAW,IAAI,UAAU,IAAI,WAAW,EAAE,CAAA;KACnE;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;KAC/C;AACH,OC/La,QAAQ;IACX,UAAU,CAAa;IACvB,SAAS,CAAQ;;IAGzB,YAAY,SAAiB;QAC3B,IAAI;YACF,MAAM,CAACC,SAAO,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAClD,IAAI,CAAC,UAAU,GAAGC,OAAS,CAACD,SAAO,CAAC,CAAA;YACpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;SACpC;QAAC,MAAM;YACN,MAAM,IAAI,qBAAqB,CAAC,SAAS,CAAC,CAAA;SAC3C;KACF;;;;IAKD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAA;KACtB;;;;IAKD,IAAW,kBAAkB;QAC3B,OAAO,EAAE,IAAI,IAAI,CAAC,aAAa,CAAA;KAChC;;;;IAKD,IAAW,OAAO;QAChB,OAAOC,OAAS,CAAC,CAAC,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,IAAI,CAAC,aAAa,CAAC,CAAA;KAC3E;;;;IAKD,IAAW,aAAa;QACtB,OAAOA,OAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;KAC1C;;;;IAKD,IAAW,YAAY;;QAErB,OAAOA,OAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC,CAAA;KAC1E;IAED,IAAY,aAAa;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;KAC7C;;;;IAKM,QAAQ;QACb,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAA;KACzD;;;;IAKM,SAAS,CAAC,MAAe;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,aAAa,CAAA;QACjE,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KAClE;;;;IAKM,aAAa;QAClB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,aAAa,CAAA;QACjE,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KACxD;;;;IAKM,QAAQ,CAACD,SAA0B;QACxC,MAAM,EAAE,GAAGA,SAAO,YAAY,WAAW,GAAGA,SAAO,GAAGC,OAAS,CAACD,SAAO,CAAC,CAAA;QACxE;;QAEE,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,OAAO,EAC3F;KACF;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,IAAI,CAAC,SAAiB;IACpC,OAAO,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAA;AAChC,wLCvHA;;;AAGA;AACO,MAAM,GAAG,GAAW,mBAAsB"}

package/build/index.js

@@ -1,20 +1,16 @@
-'use strict';Object.defineProperty(exports,'__esModule',{value:true});/**
- * The numerical maximum size an IPv4 address can be
- */
-const IPv4_MAX = 2n ** 32n;
-/**
- * The numerical maximum size an IPv6 address can be
- */
-const IPv6_MAX = 2n ** 64n;class InvalidIpAddressError extends Error {
+'use strict';Object.defineProperty(exports,'__esModule',{value:true});class InvalidIpAddressError extends Error {
     constructor(badIp) {
-        super(`${badIp} is not a valid IP address.`);
+        super(`${badIp} is not a valid IPv4 address.`);
     }
 }
-class InvalidCidrError extends Error {
+class InvalidCidrBlockError extends Error {
     constructor(badCidr) {
-        super(`${badCidr} is not a valid cidr block or range.`);
+        super(`${badCidr} is not a valid IPv4 cidr block.`);
     }
-}const MAX_OCTET_SIZE = 255n;
+}var errors=/*#__PURE__*/Object.freeze({__proto__:null,InvalidIpAddressError:InvalidIpAddressError,InvalidCidrBlockError:InvalidCidrBlockError});/**
+ * The numerical maximum size an IPv4 address can be
+ */
+const MAX$1 = 2n ** 32n - 1n;const MAX_OCTET_SIZE = 255n;
 /**
  * Representation of an IPv4 address. Provides various utility methods like equality
  * checking.
@@ -23,26 +19,84 @@ class InvalidCidrError extends Error {
  * Direct instantiation should be avoided; use {@link ipv4.address|ipv4.address()} instead.
  */
 class Ipv4Address {
-    address;
+    _address;
     constructor(address) {
-        this.address = fromString(address);
+        this._address = typeof address === 'bigint' ? address : stringToNum(address);
     }
     /**
+     * The address as a big integer
+     */
+    get address() {
+        return this._address;
+    }
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * ip.address(255n)                                    // ==> '0.0.0.255'
+     * ip.address(0b11111111_00000000_11111111_00000000n)  // ==> '255.0.255.0'
+     * ````
+     *
      * @public
      * @returns the IPv4 address as a string
      */
     toString() {
-        return toString(this.address);
+        return numToString(this._address);
     }
     /**
      * Compares if two IP address are the same.
      *
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * function isLoopback(address: Ipv4Representable) {
+     *  return ip.address(address).equals('127.0.0.1')
+     * }
+     * ```
+     *
      * @public
      * @param otherIpAddress the other IPv4 address to compare
      * @returns if the other IP address is the same
      */
     equals(otherIpAddress) {
-        return this.address === otherIpAddress.address;
+        if (otherIpAddress instanceof Ipv4Address) {
+            return this._address === otherIpAddress._address;
+        }
+        else {
+            return this._address === address(otherIpAddress)._address;
+        }
+    }
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('52.89.32.255')
+     * myIp.nextIp()                                       // ==> '52.89.33.0
+     * ```
+     *
+     * @public
+     * @returns the next consecutive IPv4 address
+     */
+    nextIp() {
+        return address(this._address + 1n);
+    }
+    /**
+     * @example
+     * ```typescript
+     * import { ipv4 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('52.89.32.19')
+     * myIp.previousIp()                                   // ==> '52.89.32.18
+     * ```
+     *
+     * @public
+     * @returns the preceding IPv4 address
+     */
+    previousIp() {
+        return address(this._address - 1n);
     }
 }
 /**
@@ -58,9 +112,9 @@ class Ipv4Address {
  * @example
  *
  * ```typescript
- * import * as cidr from 'cidr-block'
+ * import { ipv4 as ip } from 'cidr-block'
  *
- * const localhost = cidr.ipv4.address('172.0.0.0')
+ * const localhost = ip.address('127.0.0.1')
  * ```
  *
  * @see {@link Ipv4Address}
@@ -74,29 +128,23 @@ function address(ip) {
 /**
  * Converts the string representation of an IPv4 address to a BigInt.
  *
- * @remarks
- *
- * Conversion must be between string and bigint instead of integer as
- * on 32-bit systems, Node.js may allocate the number as a 32-bit integer.
- * To avoid this behavior, a BigInt is always used instead.
- *
  * @example
  *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
- * cidr.ipv4.fromString('255.255.255.255') === 4_294_967_295n     // ==> true
- * cidr.ipv4.fromString('0.0.0.255') === 255n                     // ==> true
+ * cidr.ipv4.stringToNum('255.255.255.255') === 4_294_967_295n     // ==> true
+ * cidr.ipv4.stringToNum('0.0.0.255') === 255n                     // ==> true
  * ```
  *
- * @see This method is the inverse of {@link ipv4.toString|ipv4.toString()}
+ * @see This method is the inverse of {@link ipv4.numToString}
  * @throws {@link InvalidIpAddressError}
  *
  * @public
  * @param address IPv4 address represented as a string
  * @returns numerical BigInt representation of the address
  */
-function fromString(address) {
+function stringToNum(address) {
     try {
         let [firstOctet, secondOctet, thirdOctet, fourthOctet] = address
             .split('.')
@@ -115,36 +163,142 @@ function fromString(address) {
 /**
  * Converts the numerical BigInt representation of an IPv4 address to its string representation.
  *
- * @remarks
- *
- * Conversion must be between string and bigint instead of integer as
- * on 32-bit systems, Node.js may allocate the number as a 32-bit integer.
- * To avoid this behavior, a BigInt is always used instead.
- *
  * @example
  *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
- * cidr.ipv4.toString(0n) === '0.0.0.0'                            // ==> true
- * cidr.ipv4.toString(65_280n) === '0.0.255.0'                     // ==> true
- * cidr.ipv4.toString(4_294_967_295n) === '255.255.255.255'        // ==> true
+ * cidr.ipv4.numToString(0n) === '0.0.0.0'                            // ==> true
+ * cidr.ipv4.numToString(65_280n) === '0.0.255.0'                     // ==> true
+ * cidr.ipv4.numToString(4_294_967_295n) === '255.255.255.255'        // ==> true
  * ```
  *
- * @see This method is the inverse of {@link ipv4.fromString|ipv4.fromString()}
+ * @see This method is the inverse of {@link ipv4.stringToNum}
  * @throws {@link InvalidIpAddressError}
  *
  * @public
  * @param ip IPv4 address as a BigInt
  * @returns string representation of the address
  */
-function toString(ip) {
-    if (ip < 0 || ip > IPv4_MAX) {
+function numToString(ip) {
+    try {
+        if (ip < 0 || ip > MAX$1) {
+            throw new Error();
+        }
+        const firstOctet = (ip >> 24n) & MAX_OCTET_SIZE;
+        const secondOctet = (ip >> 16n) & MAX_OCTET_SIZE;
+        const thirdOctet = (ip >> 8n) & MAX_OCTET_SIZE;
+        const fourthOctet = ip & MAX_OCTET_SIZE;
+        return `${firstOctet}.${secondOctet}.${thirdOctet}.${fourthOctet}`;
+    }
+    catch {
         throw new InvalidIpAddressError(ip.toString());
     }
-    const firstOctet = (ip >> 24n) & MAX_OCTET_SIZE;
-    const secondOctet = (ip >> 16n) & MAX_OCTET_SIZE;
-    const thirdOctet = (ip >> 8n) & MAX_OCTET_SIZE;
-    const fourthOctet = ip & MAX_OCTET_SIZE;
-    return `${firstOctet}.${secondOctet}.${thirdOctet}.${fourthOctet}`;
-}var index=/*#__PURE__*/Object.freeze({__proto__:null,Ipv4Address:Ipv4Address,address:address,fromString:fromString,toString:toString});exports.IPv4_MAX=IPv4_MAX;exports.IPv6_MAX=IPv6_MAX;exports.InvalidCidrError=InvalidCidrError;exports.InvalidIpAddressError=InvalidIpAddressError;exports.ipv4=index;//# sourceMappingURL=index.js.map
+}class Ipv4Cidr {
+    _ipAddress;
+    _maskSize;
+    // TODO: Allow wider-range of values that can be used to create a cidr
+    constructor(cidrRange) {
+        try {
+            const [address$1, subnetMask] = cidrRange.split('/');
+            this._ipAddress = address(address$1);
+            this._maskSize = Number(subnetMask);
+        }
+        catch {
+            throw new InvalidCidrBlockError(cidrRange);
+        }
+    }
+    /**
+     * The size of the cidr netmask (the number after the slash in cidr notation)
+     */
+    get maskSize() {
+        return this._maskSize;
+    }
+    /**
+     * Number of IP addresses within the cidr range
+     */
+    get allocatableIpCount() {
+        return 2n ** this.addressLength;
+    }
+    /**
+     * The actual IPv4 netmask address
+     */
+    get netmask() {
+        return address((2n ** BigInt(this.maskSize) - 1n) << this.addressLength);
+    }
+    /**
+     * The first IPv4 address that is usable within the given cidr range
+     */
+    get firstUsableIp() {
+        return address(this._ipAddress.address);
+    }
+    /**
+     * The last IPv4 address that is usable within the given cidr range
+     */
+    get lastUsableIp() {
+        // FIXME: Handle edge case of when cidr range goes outside valid ip range
+        return address(this._ipAddress.address + 2n ** this.addressLength - 1n);
+    }
+    get addressLength() {
+        return BigInt(Math.abs(32 - this._maskSize));
+    }
+    /**
+     * @returns string representation of the cidr range
+     */
+    toString() {
+        return `${this._ipAddress.toString()}/${this._maskSize}`;
+    }
+    /**
+     * @returns the next consecutive cidr block
+     */
+    nextBlock(ofSize) {
+        const nextIp = this._ipAddress.address + 2n ** this.addressLength;
+        return cidr(`${numToString(nextIp)}/${ofSize ?? this._maskSize}`);
+    }
+    /**
+     * @returns the previous cidr block
+     */
+    previousBlock() {
+        const nextIp = this._ipAddress.address - 2n ** this.addressLength;
+        return cidr(`${numToString(nextIp)}/${this._maskSize}`);
+    }
+    /**
+     * @returns if the given IPv4 address is within the cidr range
+     */
+    includes(address$1) {
+        const ip = address$1 instanceof Ipv4Address ? address$1 : address(address$1);
+        return (
+        // FIXME: How to handle edge case of next block erroring out?
+        ip.address >= this._ipAddress.address && ip.address <= this.nextBlock()._ipAddress.address);
+    }
+}
+/**
+ * Convenience function for creating an IPv4 cidr range instance.
+ *
+ * @remarks
+ *
+ * In general, you should use this function instead of instantiating an Ipv4Cidr
+ * object directly. While there is nothing wrong with direct instantiation, convenience
+ * methods like these are meant to help reduce the footprint of your code and increase
+ * readability.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { ipv4 as ip } from 'cidr-block'
+ *
+ * const vpcCidrRange = ip.cidr('10.0.0.0/16')
+ * ```
+ *
+ * @see {@link Ipv4Cidr}
+ *
+ * @param cidrRange string representation of the cidr range
+ * @returns an instance of Ipv4Cidr
+ */
+function cidr(cidrRange) {
+    return new Ipv4Cidr(cidrRange);
+}var index$1=/*#__PURE__*/Object.freeze({__proto__:null,Ipv4Address:Ipv4Address,address:address,stringToNum:stringToNum,numToString:numToString,Ipv4Cidr:Ipv4Cidr,cidr:cidr,MAX:MAX$1});/**
+ * The numerical maximum size an IPv6 address can be
+ */
+// eslint-disable-next-line @typescript-eslint/no-inferrable-types
+const MAX = 0xffffffffffffffffn;var index=/*#__PURE__*/Object.freeze({__proto__:null,MAX:MAX});exports.errors=errors;exports.ipv4=index$1;exports.ipv6=index;//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/cidr/constants.ts","../src/cidr/errors.ts","../src/cidr/ipv4/ipv4-address.ts"],"sourcesContent":[null,null,null],"names":[],"mappings":"sEAAA;;;MAGa,QAAQ,GAAG,EAAE,IAAI,IAAG;AAEjC;;;MAGa,QAAQ,GAAG,EAAE,IAAI,UCRjB,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,KAAa;QACvB,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,CAAA;KAC7C;CACF;MAEY,gBAAiB,SAAQ,KAAK;IACzC,YAAY,OAAe;QACzB,KAAK,CAAC,GAAG,OAAO,sCAAsC,CAAC,CAAA;KACxD;CCNH,MAAM,cAAc,GAAG,IAAI,CAAA;AAE3B;;;;;;;MAOa,WAAW;IACd,OAAO,CAAQ;IAEvB,YAAmB,OAAe;QAChC,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;KACnC;;;;;IAMM,QAAQ;QACb,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;KAC9B;;;;;;;;IASM,MAAM,CAAC,cAA2B;QACvC,OAAO,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC,OAAO,CAAA;KAC/C;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,OAAO,CAAC,EAAU;IAChC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;SAyBgB,UAAU,CAAC,OAAe;IACxC,IAAI;QACF,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,OAAO;aAC7D,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,cAAc,CAAC,CAAA;QACzD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,GAAG,CAAA;QAClD,WAAW,GAAG,CAAC,WAAY,GAAG,cAAc,KAAK,GAAG,CAAA;QACpD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,EAAE,CAAA;QACjD,WAAW,GAAG,WAAY,GAAG,cAAc,CAAA;QAC3C,OAAO,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;KAC3D;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAA;KACzC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;SA0BgB,QAAQ,CAAC,EAAU;IACjC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,QAAQ,EAAE;QAC3B,MAAM,IAAI,qBAAqB,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;KAC/C;IACD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;IAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;IAChD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,cAAc,CAAA;IAC9C,MAAM,WAAW,GAAG,EAAE,GAAG,cAAc,CAAA;IACvC,OAAO,GAAG,UAAU,IAAI,WAAW,IAAI,UAAU,IAAI,WAAW,EAAE,CAAA;AACpE"}
+{"version":3,"file":"index.js","sources":["../src/src/cidr/errors.ts","../src/src/cidr/ipv4/constants.ts","../src/src/cidr/ipv4/ipv4-address.ts","../src/src/cidr/ipv4/ipv4-cidr.ts","../src/src/cidr/ipv6/constants.ts"],"sourcesContent":[null,null,null,null,null],"names":["MAX","address","ipAddress"],"mappings":"4EAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,KAAa;QACvB,KAAK,CAAC,GAAG,KAAK,+BAA+B,CAAC,CAAA;KAC/C;CACF;MAEY,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,OAAe;QACzB,KAAK,CAAC,GAAG,OAAO,kCAAkC,CAAC,CAAA;KACpD;iJCTH;;;AAGO,MAAMA,KAAG,GAAG,EAAE,IAAI,GAAG,GAAG,EAAE,CCCjC,MAAM,cAAc,GAAG,IAAI,CAAA;AAE3B;;;;;;;MAOa,WAAW;IACd,QAAQ,CAAQ;IAExB,YAAmB,OAAoB;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,OAAO,KAAK,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAA;KAC7E;;;;IAKD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;;;;;;;;;;;;IAcM,QAAQ;QACb,OAAO,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;KAClC;;;;;;;;;;;;;;;;;IAkBM,MAAM,CAAC,cAAiC;QAC7C,IAAI,cAAc,YAAY,WAAW,EAAE;YACzC,OAAO,IAAI,CAAC,QAAQ,KAAK,cAAc,CAAC,QAAQ,CAAA;SACjD;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAA;SAC1D;KACF;;;;;;;;;;;;;IAcM,MAAM;QACX,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;;;;;;;;;;;;;IAcM,UAAU;QACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,OAAO,CAAC,EAAe;IACrC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;;SAmBgB,WAAW,CAAC,OAAe;IACzC,IAAI;QACF,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,OAAO;aAC7D,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,cAAc,CAAC,CAAA;QACzD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,GAAG,CAAA;QAClD,WAAW,GAAG,CAAC,WAAY,GAAG,cAAc,KAAK,GAAG,CAAA;QACpD,UAAU,GAAG,CAAC,UAAW,GAAG,cAAc,KAAK,EAAE,CAAA;QACjD,WAAW,GAAG,WAAY,GAAG,cAAc,CAAA;QAC3C,OAAO,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;KAC3D;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAA;KACzC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;SAoBgB,WAAW,CAAC,EAAU;IACpC,IAAI;QACF,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAGA,KAAG,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;QAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,cAAc,CAAA;QAChD,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,cAAc,CAAA;QAC9C,MAAM,WAAW,GAAG,EAAE,GAAG,cAAc,CAAA;QACvC,OAAO,GAAG,UAAU,IAAI,WAAW,IAAI,UAAU,IAAI,WAAW,EAAE,CAAA;KACnE;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;KAC/C;AACH,OC/La,QAAQ;IACX,UAAU,CAAa;IACvB,SAAS,CAAQ;;IAGzB,YAAY,SAAiB;QAC3B,IAAI;YACF,MAAM,CAACC,SAAO,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAClD,IAAI,CAAC,UAAU,GAAGC,OAAS,CAACD,SAAO,CAAC,CAAA;YACpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;SACpC;QAAC,MAAM;YACN,MAAM,IAAI,qBAAqB,CAAC,SAAS,CAAC,CAAA;SAC3C;KACF;;;;IAKD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAA;KACtB;;;;IAKD,IAAW,kBAAkB;QAC3B,OAAO,EAAE,IAAI,IAAI,CAAC,aAAa,CAAA;KAChC;;;;IAKD,IAAW,OAAO;QAChB,OAAOC,OAAS,CAAC,CAAC,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,IAAI,CAAC,aAAa,CAAC,CAAA;KAC3E;;;;IAKD,IAAW,aAAa;QACtB,OAAOA,OAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;KAC1C;;;;IAKD,IAAW,YAAY;;QAErB,OAAOA,OAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC,CAAA;KAC1E;IAED,IAAY,aAAa;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;KAC7C;;;;IAKM,QAAQ;QACb,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAA;KACzD;;;;IAKM,SAAS,CAAC,MAAe;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,aAAa,CAAA;QACjE,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KAClE;;;;IAKM,aAAa;QAClB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,aAAa,CAAA;QACjE,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KACxD;;;;IAKM,QAAQ,CAACD,SAA0B;QACxC,MAAM,EAAE,GAAGA,SAAO,YAAY,WAAW,GAAGA,SAAO,GAAGC,OAAS,CAACD,SAAO,CAAC,CAAA;QACxE;;QAEE,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,OAAO,EAC3F;KACF;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,IAAI,CAAC,SAAiB;IACpC,OAAO,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAA;AAChC,wLCvHA;;;AAGA;AACO,MAAM,GAAG,GAAW,mBAAsB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cidr-block",
-  "description": "cidr range utils for allocating blocks of ip ranges using cidr notation",
-  "version": "1.0.1",
+  "description": "ipv4 and ipv6 address and cidr range utilities",
+  "version": "1.1.0",
   "license": "MIT",
   "author": "Brandon Burrus <brandon@burrus.io>",
   "homepage": "https://cidr-block.com",
@@ -14,13 +14,14 @@
   },
   "main": "build/index.js",
   "module": "build/index.esm.js",
-  "types": "build/src/index.d.ts",
+  "types": "build/index.d.ts",
   "files": [
     "build"
   ],
   "scripts": {
     "build": "rollup -c",
     "build:watch": "rollup -cw",
+    "predocs": "rimraf docs",
     "docs": "typedoc src/index.ts",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --fix --ext .ts",
@@ -28,6 +29,9 @@
     "format:fix": "prettier --write **/*.ts",
     "prebuild": "rimraf build",
     "test": "jest",
+    "test:ci": "jest --verbose --coverage",
+    "test:cov": "jest --coverage",
+    "test:verbose": "jest --verbose",
     "test:watch": "jest --watch",
     "test:ui": "majestic"
   },
@@ -67,6 +71,16 @@
     "testEnvironment": "node",
     "transform": {
       "^.+\\.ts$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "<rootDir>/src/**/*"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "branches": 100,
+        "functions": 100,
+        "lines": 100
+      }
     }
   },
   "eslintConfig": {

package/build/src/cidr/constants.d.ts

@@ -1,8 +0,0 @@
-/**
- * The numerical maximum size an IPv4 address can be
- */
-export declare const IPv4_MAX: bigint;
-/**
- * The numerical maximum size an IPv6 address can be
- */
-export declare const IPv6_MAX: bigint;

package/build/src/cidr/ipv4/index.d.ts

@@ -1 +0,0 @@
-export * from './ipv4-address';

package/build/src/cidr/ipv4/ipv4-address.d.ts

@@ -1,101 +0,0 @@
-/**
- * Representation of an IPv4 address. Provides various utility methods like equality
- * checking.
- *
- * @remarks
- * Direct instantiation should be avoided; use {@link ipv4.address|ipv4.address()} instead.
- */
-export declare class Ipv4Address {
-    private address;
-    constructor(address: string);
-    /**
-     * @public
-     * @returns the IPv4 address as a string
-     */
-    toString(): string;
-    /**
-     * Compares if two IP address are the same.
-     *
-     * @public
-     * @param otherIpAddress the other IPv4 address to compare
-     * @returns if the other IP address is the same
-     */
-    equals(otherIpAddress: Ipv4Address): boolean;
-}
-/**
- * Convenience function for creating an IPv4 address instance.
- *
- * @remarks
- *
- * In general, you should use this function instead of instantiating an Ipv4Address
- * object directly. While there is nothing wrong with direct instantiation, convenience
- * methods like these are meant to help reduce the footprint of your code and increase
- * readability.
- *
- * @example
- *
- * ```typescript
- * import * as cidr from 'cidr-block'
- *
- * const localhost = cidr.ipv4.address('172.0.0.0')
- * ```
- *
- * @see {@link Ipv4Address}
- *
- * @param ip string representation of the IPv4 address
- * @returns an instance of Ipv4Address
- */
-export declare function address(ip: string): Ipv4Address;
-/**
- * Converts the string representation of an IPv4 address to a BigInt.
- *
- * @remarks
- *
- * Conversion must be between string and bigint instead of integer as
- * on 32-bit systems, Node.js may allocate the number as a 32-bit integer.
- * To avoid this behavior, a BigInt is always used instead.
- *
- * @example
- *
- * ```typescript
- * import * as cidr from 'cidr-block'
- *
- * cidr.ipv4.fromString('255.255.255.255') === 4_294_967_295n     // ==> true
- * cidr.ipv4.fromString('0.0.0.255') === 255n                     // ==> true
- * ```
- *
- * @see This method is the inverse of {@link ipv4.toString|ipv4.toString()}
- * @throws {@link InvalidIpAddressError}
- *
- * @public
- * @param address IPv4 address represented as a string
- * @returns numerical BigInt representation of the address
- */
-export declare function fromString(address: string): bigint;
-/**
- * Converts the numerical BigInt representation of an IPv4 address to its string representation.
- *
- * @remarks
- *
- * Conversion must be between string and bigint instead of integer as
- * on 32-bit systems, Node.js may allocate the number as a 32-bit integer.
- * To avoid this behavior, a BigInt is always used instead.
- *
- * @example
- *
- * ```typescript
- * import * as cidr from 'cidr-block'
- *
- * cidr.ipv4.toString(0n) === '0.0.0.0'                            // ==> true
- * cidr.ipv4.toString(65_280n) === '0.0.255.0'                     // ==> true
- * cidr.ipv4.toString(4_294_967_295n) === '255.255.255.255'        // ==> true
- * ```
- *
- * @see This method is the inverse of {@link ipv4.fromString|ipv4.fromString()}
- * @throws {@link InvalidIpAddressError}
- *
- * @public
- * @param ip IPv4 address as a BigInt
- * @returns string representation of the address
- */
-export declare function toString(ip: bigint): string;

package/build/src/index.d.ts

@@ -1,3 +0,0 @@
-export * as ipv4 from './cidr/ipv4/index';
-export * from './cidr/constants';
-export * from './cidr/errors';

package/build/tests/cidr/ipv4/ipv4-address.test.d.ts

@@ -1 +0,0 @@
-export {};