cidr-block 1.3.1 → 1.3.2

package/README.md

@@ -2,10 +2,6 @@
 
 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:
@@ -62,8 +58,9 @@ 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
+// esm
 import { ipv4 as ip } from 'cidr-block'
-// or commonjs-style
+// commonjs
 const { ipv4: ip } = require('cidr-block')
 ```
 

package/build/index.d.ts

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

package/build/index.esm.js

@@ -16,11 +16,11 @@ const MAX$1 = 2 ** 32 - 1;const MAX_OCTET_SIZE = 255;
  * checking.
  *
  * @remarks
- * Direct instantiation should be avoided; use {@link ipv4.address} instead.
+ * Avoid direct instantiation; use {@link ipv4.address} instead.
  */
 class Ipv4Address {
     constructor(address) {
-        this._address = typeof address === 'number' ? address : stringToNum(address);
+        this._address = typeof address === 'number' ? address : stringToNum$1(address);
     }
     /**
      * The address as a number
@@ -29,6 +29,8 @@ class Ipv4Address {
         return this._address;
     }
     /**
+     * Returns the string representation of the address
+     *
      * @example
      * ```typescript
      * import { ipv4 as ip } from 'cidr-block'
@@ -41,10 +43,10 @@ class Ipv4Address {
      * @returns the IPv4 address as a string
      */
     toString() {
-        return numToString(this._address);
+        return numToString$1(this._address);
     }
     /**
-     * Compares if two IP address are the same.
+     * Compares if two IPv4 addresses are the same.
      *
      * @example
      * ```typescript
@@ -64,23 +66,26 @@ class Ipv4Address {
             return this._address === otherIpAddress._address;
         }
         else {
-            return this._address === address(otherIpAddress)._address;
+            return this._address === address$1(otherIpAddress)._address;
         }
     }
     /**
+     * Calculates the next logical IPv4 address.
+     *
      * @example
      * ```typescript
      * import { ipv4 as ip } from 'cidr-block'
      *
      * const myIp = ip.address('52.89.32.255')
-     * myIp.nextIp()                                       // ==> '52.89.33.0
+     * myIp.nextIp()                                       // ==> '52.89.33.0'
      * ```
      *
      * @public
      * @returns the next consecutive IPv4 address
      */
     nextIp() {
-        return address(this._address + 1);
+        // TODO: Handle last ip address
+        return address$1(this._address + 1);
     }
     /**
      * @example
@@ -88,25 +93,22 @@ class Ipv4Address {
      * import { ipv4 as ip } from 'cidr-block'
      *
      * const myIp = ip.address('52.89.32.19')
-     * myIp.previousIp()                                   // ==> '52.89.32.18
+     * myIp.previousIp()                                   // ==> '52.89.32.18'
      * ```
      *
      * @public
      * @returns the preceding IPv4 address
      */
     previousIp() {
-        return address(this._address - 1);
+        return address$1(this._address - 1);
     }
 }
 /**
  * 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.
+ * object directly.
  *
  * @example
  *
@@ -118,17 +120,18 @@ class Ipv4Address {
  *
  * @see {@link Ipv4Address}
  *
+ * @public
  * @param ip string representation of the IPv4 address
  * @returns an instance of Ipv4Address
  */
-function address(ip) {
+function address$1(ip) {
+    // TODO: Implement memoization
     return new Ipv4Address(ip);
 }
 /**
  * Converts the string representation of an IPv4 address to a number.
  *
  * @example
- *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
@@ -143,7 +146,7 @@ function address(ip) {
  * @param address IPv4 address represented as a string
  * @returns numerical number representation of the address
  */
-function stringToNum(address) {
+function stringToNum$1(address) {
     try {
         if (address.length < 7) {
             throw new Error();
@@ -163,10 +166,9 @@ function stringToNum(address) {
     }
 }
 /**
- * Converts the numerical number representation of an IPv4 address to its string representation.
+ * Converts the numerical representation of an IPv4 address to its string representation.
  *
  * @example
- *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
@@ -182,7 +184,7 @@ function stringToNum(address) {
  * @param ip IPv4 address as a number
  * @returns string representation of the address
  */
-function numToString(ip) {
+function numToString$1(ip) {
     try {
         if (ip < 0 || ip > MAX$1) {
             throw new Error();
@@ -200,8 +202,8 @@ function numToString(ip) {
     // 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);
+            const [address, subnetMask] = cidrRange.split('/');
+            this._ipAddress = address$1(address);
             this._maskSize = Number(subnetMask);
         }
         catch {
@@ -224,20 +226,20 @@ function numToString(ip) {
      * The actual IPv4 netmask address
      */
     get netmask() {
-        return address((2 ** this.maskSize - 1) << this.addressLength);
+        return address$1((2 ** this.maskSize - 1) << this.addressLength);
     }
     /**
      * The first IPv4 address that is usable within the given cidr range
      */
     get firstUsableIp() {
-        return address(this._ipAddress.address);
+        return address$1(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 + 2 ** this.addressLength - 1);
+        return address$1(this._ipAddress.address + 2 ** this.addressLength - 1);
     }
     get addressLength() {
         return Math.abs(32 - this._maskSize);
@@ -253,20 +255,20 @@ function numToString(ip) {
      */
     nextBlock(ofSize) {
         const nextIp = this._ipAddress.address + 2 ** this.addressLength;
-        return cidr(`${numToString(nextIp)}/${ofSize ?? this._maskSize}`);
+        return cidr(`${numToString$1(nextIp)}/${ofSize ?? this._maskSize}`);
     }
     /**
      * @returns the previous cidr block
      */
     previousBlock() {
         const nextIp = this._ipAddress.address - 2 ** this.addressLength;
-        return cidr(`${numToString(nextIp)}/${this._maskSize}`);
+        return cidr(`${numToString$1(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);
+    includes(address) {
+        const ip = address instanceof Ipv4Address ? address : address$1(address);
         return (
         // FIXME: How to handle edge case of next block erroring out?
         ip.address >= this._ipAddress.address && ip.address <= this.nextBlock()._ipAddress.address);
@@ -297,7 +299,202 @@ function numToString(ip) {
  */
 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});/**
+}const RFC_1918_CIDRS = [cidr('10.0.0.0/8'), cidr('172.16.0.0/12'), cidr('192.168.0.0/16')];
+/**
+ * Predicate function that will return true if the given
+ * address is in the private RFC 1918 ipv4 address space.
+ *
+ * See more {@link https://datatracker.ietf.org/doc/html/rfc1918}
+ */
+function isPrivateRFC1918(address) {
+    for (const rfcCidr of RFC_1918_CIDRS) {
+        if (rfcCidr.includes(address)) {
+            return true;
+        }
+    }
+    return false;
+}var rfc1918=/*#__PURE__*/Object.freeze({__proto__:null,isPrivateRFC1918:isPrivateRFC1918});var index$1=/*#__PURE__*/Object.freeze({__proto__:null,rfc1918:rfc1918,Ipv4Address:Ipv4Address,address:address$1,stringToNum:stringToNum$1,numToString:numToString$1,Ipv4Cidr:Ipv4Cidr,cidr:cidr,MAX:MAX$1});const MAX_HEXTET_SIZE = 65535n;
+/**
+ * Representation of an IPv6 address. Provides various utilities methods like equality
+ * checking.
+ *
+ * @remarks
+ * Avoid direct instantiation; use {@link ipv6.address} instead.
+ */
+class Ipv6Address {
+    constructor(address) {
+        this._address = typeof address === 'bigint' ? address : stringToNum(address);
+    }
+    /**
+     * The address as a bigint
+     *
+     * @remarks
+     * Because the representation of an IPv6 address is too large to fit into a typical
+     * JavaScript integer, a
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt}
+     * is used instead.
+     */
+    get address() {
+        return this._address;
+    }
+    // TODO: Add example code
+    /**
+     * Returns the string representation of the address
+     */
+    toString() {
+        return numToString(this._address);
+    }
+    /**
+     * Compares if two IPv6 addresses are the same.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * function isLoopback(address: Ipv6Representable) {
+     *   return ip.address(address).equals('::1')
+     * }
+     *
+     * @public
+     * @param otherIpAddress the other Ipv6 address to compare
+     * @returns if the other IP address is the same
+     * ```
+     */
+    equals(otherIpAddress) {
+        if (otherIpAddress instanceof Ipv6Address) {
+            return this._address === otherIpAddress._address;
+        }
+        else {
+            return this._address === address(otherIpAddress)._address;
+        }
+    }
+    /**
+     * Calculates the next logical IPv6 address.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('2001:0db8::ac10')
+     * myIp.nextIp()                                       // ==> '2001:0db8::ac11'
+     * ```
+     */
+    nextIp() {
+        // TODO: Handle last ip address
+        return address(this._address + 1n);
+    }
+    /**
+     * Calculates the previous logical IPv6 address.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('2001:0db8::ac10')
+     * myIp.previousIp()                                   // ==> '2001:0db8::ac09'
+     * ```
+     */
+    previousIp() {
+        return address(this._address - 1n);
+    }
+}
+/**
+ * Convenience function for creating an IPv6 address instance.
+ *
+ * @remarks
+ * In general, you should use this function instead of instantiating an Ipv6Address
+ * object directly.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { ipv6 as ip } from 'cidr-block'
+ *
+ * const localhost = ip.address('::1')
+ * ```
+ *
+ * @see {@link Ipv6Address}
+ *
+ * @param ip string representation of the IPv6 address
+ * @returns an instance of Ipv6Address
+ */
+function address(ip) {
+    // TODO: Implement memoization
+    return new Ipv6Address(ip);
+}
+// TODO: Add code example
+/**
+ * Converts the string representation of an IPv6 address to a bigint.
+ *
+ * @see {@link Ipv6Address}
+ *
+ * @public
+ * @param ip string representation of the IPv6 address
+ * @returns an instance of Ipv6Address
+ */
+function stringToNum(address) {
+    if (address === '::') {
+        return 0n;
+    }
+    let ipv6 = 0n;
+    const rawHextets = [];
+    const [leftAddress, rightAddress] = address.split('::');
+    for (const hextet of leftAddress.split(':')) {
+        rawHextets.push(hextet || '0');
+    }
+    if (rightAddress !== undefined) {
+        const rightHextets = rightAddress.split(':');
+        const emptyFillCount = 8 - (rawHextets.length + rightHextets.length);
+        for (let i = 0; i < emptyFillCount; i++) {
+            rawHextets.push('0');
+        }
+        for (const hextet of rightHextets) {
+            rawHextets.push(hextet || '0');
+        }
+    }
+    const decimals = rawHextets.map(hextet => parseInt(hextet, 16));
+    let shiftSize = 0n;
+    let binHex = 0n;
+    for (const pos in decimals) {
+        const num = decimals[pos];
+        if (num === 0) {
+            continue;
+        }
+        shiftSize = BigInt(Math.abs(parseInt(pos) - 7) * 16);
+        binHex = BigInt(num) << shiftSize;
+        ipv6 |= binHex;
+    }
+    return ipv6;
+}
+/**
+ * Converts the numerical representation of an IPv6 address to its string representation.
+ *
+ * @see This method is the inverse of {@link ipv6.stringToNum}
+ * @throws {@link InvalidIpAddressError}
+ *
+ * @public
+ * @param ip IPv6 address as a number
+ * @returns string representation of the address
+ */
+function numToString(num) {
+    if (num === 0n) {
+        return '::';
+    }
+    const hextets = [];
+    for (let n = 0; n < 8; n++) {
+        const bitOffset = BigInt(Math.abs(n - 7) * 16);
+        hextets.push(((num >> bitOffset) & MAX_HEXTET_SIZE).toString(16));
+    }
+    const dropStartIdx = hextets.indexOf('0');
+    if (dropStartIdx >= 0) {
+        let dropCount = 1;
+        for (let i = dropStartIdx + 1; hextets[i] === '0'; i++) {
+            dropCount++;
+        }
+        hextets.splice(dropStartIdx, dropCount, dropStartIdx === 0 || dropStartIdx + dropCount === 8 ? ':' : '');
+    }
+    return hextets.join(':');
+}/**
  * The numerical maximum size an IPv6 address can be
  */
-const MAX = 2n ** 128n;var index=/*#__PURE__*/Object.freeze({__proto__:null,MAX:MAX});export{errors,index$1 as ipv4,index as ipv6};//# sourceMappingURL=index.esm.js.map
+const MAX = 2n ** 128n;var index=/*#__PURE__*/Object.freeze({__proto__:null,Ipv6Address:Ipv6Address,address:address,stringToNum:stringToNum,numToString:numToString,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/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,GAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CCCtC,MAAM,cAAc,GAAG,GAAG,CAAA;AAE1B;;;;;;;MAOa,WAAW;IAGtB,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,CAAC,CAAC,CAAA;KAClC;;;;;;;;;;;;;IAcM,UAAU;QACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAA;KAClC;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,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,cAAc,CAAC,EAAE;YAC7D,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,MAAM,CAAA;QAC/D,UAAU,GAAG,CAAC,UAAU,IAAI,EAAE,MAAM,CAAC,CAAA;QACrC,WAAW,GAAG,CAAC,WAAW,IAAI,EAAE,MAAM,CAAC,CAAA;QACvC,UAAU,GAAG,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,CAAA;QACpC,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,KAAK,EAAE,IAAI,cAAc,CAAA;QAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,cAAc,CAAA;QAChD,MAAM,UAAU,GAAG,CAAC,EAAE,KAAK,CAAC,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,OClMa,QAAQ;;IAKnB,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;KAC/B;;;;IAKD,IAAW,OAAO;QAChB,OAAOC,OAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,CAAA;KACjE;;;;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,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAA;KACxE;IAED,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAA;KACrC;;;;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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,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;;;AAGO,MAAM,GAAG,GAAG,EAAE,IAAI,IAAI"}
+{"version":3,"file":"index.esm.js","sources":["../src/src/errors.ts","../src/src/ipv4/constants.ts","../src/src/ipv4/ipv4-address.ts","../src/src/ipv4/ipv4-cidr.ts","../src/src/ipv4/rfc1918.ts","../src/src/ipv6/ipv6-address.ts","../src/src/ipv6/constants.ts"],"sourcesContent":[null,null,null,null,null,null,null],"names":["MAX","stringToNum","numToString","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,GAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CCCtC,MAAM,cAAc,GAAG,GAAG,CAAA;AAE1B;;;;;;;MAOa,WAAW;IAGtB,YAAmB,OAAoB;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,OAAO,KAAK,QAAQ,GAAG,OAAO,GAAGC,aAAW,CAAC,OAAO,CAAC,CAAA;KAC7E;;;;IAKD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;;;;;;;;;;;;;;IAgBM,QAAQ;QACb,OAAOC,aAAW,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,KAAKC,SAAO,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAA;SAC1D;KACF;;;;;;;;;;;;;;;IAgBM,MAAM;;QAEX,OAAOA,SAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAA;KAClC;;;;;;;;;;;;;IAcM,UAAU;QACf,OAAOA,SAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAA;KAClC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;SAqBgBA,SAAO,CAAC,EAAe;;IAErC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;SAkBgBF,aAAW,CAAC,OAAe;IACzC,IAAI;QACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,cAAc,CAAC,EAAE;YAC7D,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,MAAM,CAAA;QAC/D,UAAU,GAAG,CAAC,UAAU,IAAI,EAAE,MAAM,CAAC,CAAA;QACrC,WAAW,GAAG,CAAC,WAAW,IAAI,EAAE,MAAM,CAAC,CAAA;QACvC,UAAU,GAAG,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,CAAA;QACpC,OAAO,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;KAC3D;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAA;KACzC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;SAmBgBC,aAAW,CAAC,EAAU;IACpC,IAAI;QACF,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAGF,KAAG,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,MAAM,UAAU,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,cAAc,CAAA;QAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,cAAc,CAAA;QAChD,MAAM,UAAU,GAAG,CAAC,EAAE,KAAK,CAAC,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,OCpMa,QAAQ;;IAKnB,YAAY,SAAiB;QAC3B,IAAI;YACF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAClD,IAAI,CAAC,UAAU,GAAGI,SAAS,CAAC,OAAO,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;KAC/B;;;;IAKD,IAAW,OAAO;QAChB,OAAOA,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,CAAA;KACjE;;;;IAKD,IAAW,aAAa;QACtB,OAAOA,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;KAC1C;;;;IAKD,IAAW,YAAY;;QAErB,OAAOA,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAA;KACxE;IAED,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAA;KACrC;;;;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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,OAAO,IAAI,CAAC,GAAGF,aAAW,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,OAAO,IAAI,CAAC,GAAGA,aAAW,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KACxD;;;;IAKM,QAAQ,CAAC,OAA0B;QACxC,MAAM,EAAE,GAAG,OAAO,YAAY,WAAW,GAAG,OAAO,GAAGE,SAAS,CAAC,OAAO,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,CCpHA,MAAM,cAAc,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAA;AAE1F;;;;;;SAMgB,gBAAgB,CAAC,OAAoB;IACnD,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE;QACpC,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC7B,OAAO,IAAI,CAAA;SACZ;KACF;IACD,OAAO,KAAK,CAAA;AACd,ySCjBA,MAAM,eAAe,GAAG,MAAO,CAAA;AAE/B;;;;;;;MAOa,WAAW;IAGtB,YAAmB,OAAoB;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,OAAO,KAAK,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAA;KAC7E;;;;;;;;;;IAWD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;;;;IAMM,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;;;;;;;;;;;;IAaM,MAAM;;QAEX,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;;;;;;;;;;;;IAaM,UAAU;QACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;CACF;AAED;;;;;;;;;;;;;;;;;;;;SAoBgB,OAAO,CAAC,EAAe;;IAErC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;AACA;;;;;;;;;SASgB,WAAW,CAAC,OAAe;IACzC,IAAI,OAAO,KAAK,IAAI,EAAE;QACpB,OAAO,EAAE,CAAA;KACV;IAED,IAAI,IAAI,GAAG,EAAE,CAAA;IACb,MAAM,UAAU,GAAa,EAAE,CAAA;IAC/B,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEvD,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QAC3C,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,CAAA;KAC/B;IAED,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC5C,MAAM,cAAc,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,CAAA;QAEpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE;YACvC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACrB;QAED,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE;YACjC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,CAAA;SAC/B;KACF;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAE/D,IAAI,SAAS,GAAG,EAAE,CAAA;IAClB,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;QAC1B,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QACzB,IAAI,GAAG,KAAK,CAAC,EAAE;YACb,SAAQ;SACT;QACD,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;QACpD,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,SAAS,CAAA;QACjC,IAAI,IAAI,MAAM,CAAA;KACf;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;SAUgB,WAAW,CAAC,GAAW;IACrC,IAAI,GAAG,KAAK,EAAE,EAAE;QACd,OAAO,IAAI,CAAA;KACZ;IACD,MAAM,OAAO,GAAa,EAAE,CAAA;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;QAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,IAAI,eAAe,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;KAClE;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IACzC,IAAI,YAAY,IAAI,CAAC,EAAE;QACrB,IAAI,SAAS,GAAG,CAAC,CAAA;QACjB,KAAK,IAAI,CAAC,GAAG,YAAY,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE;YACtD,SAAS,EAAE,CAAA;SACZ;QACD,OAAO,CAAC,MAAM,CACZ,YAAY,EACZ,SAAS,EACT,YAAY,KAAK,CAAC,IAAI,YAAY,GAAG,SAAS,KAAK,CAAC,GAAG,GAAG,GAAG,EAAE,CAChE,CAAA;KACF;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC1B,CC5MA;;;AAGO,MAAM,GAAG,GAAG,EAAE,IAAI,IAAI"}

package/build/index.js

@@ -16,11 +16,11 @@ const MAX$1 = 2 ** 32 - 1;const MAX_OCTET_SIZE = 255;
  * checking.
  *
  * @remarks
- * Direct instantiation should be avoided; use {@link ipv4.address} instead.
+ * Avoid direct instantiation; use {@link ipv4.address} instead.
  */
 class Ipv4Address {
     constructor(address) {
-        this._address = typeof address === 'number' ? address : stringToNum(address);
+        this._address = typeof address === 'number' ? address : stringToNum$1(address);
     }
     /**
      * The address as a number
@@ -29,6 +29,8 @@ class Ipv4Address {
         return this._address;
     }
     /**
+     * Returns the string representation of the address
+     *
      * @example
      * ```typescript
      * import { ipv4 as ip } from 'cidr-block'
@@ -41,10 +43,10 @@ class Ipv4Address {
      * @returns the IPv4 address as a string
      */
     toString() {
-        return numToString(this._address);
+        return numToString$1(this._address);
     }
     /**
-     * Compares if two IP address are the same.
+     * Compares if two IPv4 addresses are the same.
      *
      * @example
      * ```typescript
@@ -64,23 +66,26 @@ class Ipv4Address {
             return this._address === otherIpAddress._address;
         }
         else {
-            return this._address === address(otherIpAddress)._address;
+            return this._address === address$1(otherIpAddress)._address;
         }
     }
     /**
+     * Calculates the next logical IPv4 address.
+     *
      * @example
      * ```typescript
      * import { ipv4 as ip } from 'cidr-block'
      *
      * const myIp = ip.address('52.89.32.255')
-     * myIp.nextIp()                                       // ==> '52.89.33.0
+     * myIp.nextIp()                                       // ==> '52.89.33.0'
      * ```
      *
      * @public
      * @returns the next consecutive IPv4 address
      */
     nextIp() {
-        return address(this._address + 1);
+        // TODO: Handle last ip address
+        return address$1(this._address + 1);
     }
     /**
      * @example
@@ -88,25 +93,22 @@ class Ipv4Address {
      * import { ipv4 as ip } from 'cidr-block'
      *
      * const myIp = ip.address('52.89.32.19')
-     * myIp.previousIp()                                   // ==> '52.89.32.18
+     * myIp.previousIp()                                   // ==> '52.89.32.18'
      * ```
      *
      * @public
      * @returns the preceding IPv4 address
      */
     previousIp() {
-        return address(this._address - 1);
+        return address$1(this._address - 1);
     }
 }
 /**
  * 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.
+ * object directly.
  *
  * @example
  *
@@ -118,17 +120,18 @@ class Ipv4Address {
  *
  * @see {@link Ipv4Address}
  *
+ * @public
  * @param ip string representation of the IPv4 address
  * @returns an instance of Ipv4Address
  */
-function address(ip) {
+function address$1(ip) {
+    // TODO: Implement memoization
     return new Ipv4Address(ip);
 }
 /**
  * Converts the string representation of an IPv4 address to a number.
  *
  * @example
- *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
@@ -143,7 +146,7 @@ function address(ip) {
  * @param address IPv4 address represented as a string
  * @returns numerical number representation of the address
  */
-function stringToNum(address) {
+function stringToNum$1(address) {
     try {
         if (address.length < 7) {
             throw new Error();
@@ -163,10 +166,9 @@ function stringToNum(address) {
     }
 }
 /**
- * Converts the numerical number representation of an IPv4 address to its string representation.
+ * Converts the numerical representation of an IPv4 address to its string representation.
  *
  * @example
- *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
@@ -182,7 +184,7 @@ function stringToNum(address) {
  * @param ip IPv4 address as a number
  * @returns string representation of the address
  */
-function numToString(ip) {
+function numToString$1(ip) {
     try {
         if (ip < 0 || ip > MAX$1) {
             throw new Error();
@@ -200,8 +202,8 @@ function numToString(ip) {
     // 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);
+            const [address, subnetMask] = cidrRange.split('/');
+            this._ipAddress = address$1(address);
             this._maskSize = Number(subnetMask);
         }
         catch {
@@ -224,20 +226,20 @@ function numToString(ip) {
      * The actual IPv4 netmask address
      */
     get netmask() {
-        return address((2 ** this.maskSize - 1) << this.addressLength);
+        return address$1((2 ** this.maskSize - 1) << this.addressLength);
     }
     /**
      * The first IPv4 address that is usable within the given cidr range
      */
     get firstUsableIp() {
-        return address(this._ipAddress.address);
+        return address$1(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 + 2 ** this.addressLength - 1);
+        return address$1(this._ipAddress.address + 2 ** this.addressLength - 1);
     }
     get addressLength() {
         return Math.abs(32 - this._maskSize);
@@ -253,20 +255,20 @@ function numToString(ip) {
      */
     nextBlock(ofSize) {
         const nextIp = this._ipAddress.address + 2 ** this.addressLength;
-        return cidr(`${numToString(nextIp)}/${ofSize ?? this._maskSize}`);
+        return cidr(`${numToString$1(nextIp)}/${ofSize ?? this._maskSize}`);
     }
     /**
      * @returns the previous cidr block
      */
     previousBlock() {
         const nextIp = this._ipAddress.address - 2 ** this.addressLength;
-        return cidr(`${numToString(nextIp)}/${this._maskSize}`);
+        return cidr(`${numToString$1(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);
+    includes(address) {
+        const ip = address instanceof Ipv4Address ? address : address$1(address);
         return (
         // FIXME: How to handle edge case of next block erroring out?
         ip.address >= this._ipAddress.address && ip.address <= this.nextBlock()._ipAddress.address);
@@ -297,7 +299,202 @@ function numToString(ip) {
  */
 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});/**
+}const RFC_1918_CIDRS = [cidr('10.0.0.0/8'), cidr('172.16.0.0/12'), cidr('192.168.0.0/16')];
+/**
+ * Predicate function that will return true if the given
+ * address is in the private RFC 1918 ipv4 address space.
+ *
+ * See more {@link https://datatracker.ietf.org/doc/html/rfc1918}
+ */
+function isPrivateRFC1918(address) {
+    for (const rfcCidr of RFC_1918_CIDRS) {
+        if (rfcCidr.includes(address)) {
+            return true;
+        }
+    }
+    return false;
+}var rfc1918=/*#__PURE__*/Object.freeze({__proto__:null,isPrivateRFC1918:isPrivateRFC1918});var index$1=/*#__PURE__*/Object.freeze({__proto__:null,rfc1918:rfc1918,Ipv4Address:Ipv4Address,address:address$1,stringToNum:stringToNum$1,numToString:numToString$1,Ipv4Cidr:Ipv4Cidr,cidr:cidr,MAX:MAX$1});const MAX_HEXTET_SIZE = 65535n;
+/**
+ * Representation of an IPv6 address. Provides various utilities methods like equality
+ * checking.
+ *
+ * @remarks
+ * Avoid direct instantiation; use {@link ipv6.address} instead.
+ */
+class Ipv6Address {
+    constructor(address) {
+        this._address = typeof address === 'bigint' ? address : stringToNum(address);
+    }
+    /**
+     * The address as a bigint
+     *
+     * @remarks
+     * Because the representation of an IPv6 address is too large to fit into a typical
+     * JavaScript integer, a
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt}
+     * is used instead.
+     */
+    get address() {
+        return this._address;
+    }
+    // TODO: Add example code
+    /**
+     * Returns the string representation of the address
+     */
+    toString() {
+        return numToString(this._address);
+    }
+    /**
+     * Compares if two IPv6 addresses are the same.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * function isLoopback(address: Ipv6Representable) {
+     *   return ip.address(address).equals('::1')
+     * }
+     *
+     * @public
+     * @param otherIpAddress the other Ipv6 address to compare
+     * @returns if the other IP address is the same
+     * ```
+     */
+    equals(otherIpAddress) {
+        if (otherIpAddress instanceof Ipv6Address) {
+            return this._address === otherIpAddress._address;
+        }
+        else {
+            return this._address === address(otherIpAddress)._address;
+        }
+    }
+    /**
+     * Calculates the next logical IPv6 address.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('2001:0db8::ac10')
+     * myIp.nextIp()                                       // ==> '2001:0db8::ac11'
+     * ```
+     */
+    nextIp() {
+        // TODO: Handle last ip address
+        return address(this._address + 1n);
+    }
+    /**
+     * Calculates the previous logical IPv6 address.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('2001:0db8::ac10')
+     * myIp.previousIp()                                   // ==> '2001:0db8::ac09'
+     * ```
+     */
+    previousIp() {
+        return address(this._address - 1n);
+    }
+}
+/**
+ * Convenience function for creating an IPv6 address instance.
+ *
+ * @remarks
+ * In general, you should use this function instead of instantiating an Ipv6Address
+ * object directly.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { ipv6 as ip } from 'cidr-block'
+ *
+ * const localhost = ip.address('::1')
+ * ```
+ *
+ * @see {@link Ipv6Address}
+ *
+ * @param ip string representation of the IPv6 address
+ * @returns an instance of Ipv6Address
+ */
+function address(ip) {
+    // TODO: Implement memoization
+    return new Ipv6Address(ip);
+}
+// TODO: Add code example
+/**
+ * Converts the string representation of an IPv6 address to a bigint.
+ *
+ * @see {@link Ipv6Address}
+ *
+ * @public
+ * @param ip string representation of the IPv6 address
+ * @returns an instance of Ipv6Address
+ */
+function stringToNum(address) {
+    if (address === '::') {
+        return 0n;
+    }
+    let ipv6 = 0n;
+    const rawHextets = [];
+    const [leftAddress, rightAddress] = address.split('::');
+    for (const hextet of leftAddress.split(':')) {
+        rawHextets.push(hextet || '0');
+    }
+    if (rightAddress !== undefined) {
+        const rightHextets = rightAddress.split(':');
+        const emptyFillCount = 8 - (rawHextets.length + rightHextets.length);
+        for (let i = 0; i < emptyFillCount; i++) {
+            rawHextets.push('0');
+        }
+        for (const hextet of rightHextets) {
+            rawHextets.push(hextet || '0');
+        }
+    }
+    const decimals = rawHextets.map(hextet => parseInt(hextet, 16));
+    let shiftSize = 0n;
+    let binHex = 0n;
+    for (const pos in decimals) {
+        const num = decimals[pos];
+        if (num === 0) {
+            continue;
+        }
+        shiftSize = BigInt(Math.abs(parseInt(pos) - 7) * 16);
+        binHex = BigInt(num) << shiftSize;
+        ipv6 |= binHex;
+    }
+    return ipv6;
+}
+/**
+ * Converts the numerical representation of an IPv6 address to its string representation.
+ *
+ * @see This method is the inverse of {@link ipv6.stringToNum}
+ * @throws {@link InvalidIpAddressError}
+ *
+ * @public
+ * @param ip IPv6 address as a number
+ * @returns string representation of the address
+ */
+function numToString(num) {
+    if (num === 0n) {
+        return '::';
+    }
+    const hextets = [];
+    for (let n = 0; n < 8; n++) {
+        const bitOffset = BigInt(Math.abs(n - 7) * 16);
+        hextets.push(((num >> bitOffset) & MAX_HEXTET_SIZE).toString(16));
+    }
+    const dropStartIdx = hextets.indexOf('0');
+    if (dropStartIdx >= 0) {
+        let dropCount = 1;
+        for (let i = dropStartIdx + 1; hextets[i] === '0'; i++) {
+            dropCount++;
+        }
+        hextets.splice(dropStartIdx, dropCount, dropStartIdx === 0 || dropStartIdx + dropCount === 8 ? ':' : '');
+    }
+    return hextets.join(':');
+}/**
  * The numerical maximum size an IPv6 address can be
  */
-const MAX = 2n ** 128n;var index=/*#__PURE__*/Object.freeze({__proto__:null,MAX:MAX});exports.errors=errors;exports.ipv4=index$1;exports.ipv6=index;//# sourceMappingURL=index.js.map
+const MAX = 2n ** 128n;var index=/*#__PURE__*/Object.freeze({__proto__:null,Ipv6Address:Ipv6Address,address:address,stringToNum:stringToNum,numToString:numToString,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/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,GAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CCCtC,MAAM,cAAc,GAAG,GAAG,CAAA;AAE1B;;;;;;;MAOa,WAAW;IAGtB,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,CAAC,CAAC,CAAA;KAClC;;;;;;;;;;;;;IAcM,UAAU;QACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAA;KAClC;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,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,cAAc,CAAC,EAAE;YAC7D,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,MAAM,CAAA;QAC/D,UAAU,GAAG,CAAC,UAAU,IAAI,EAAE,MAAM,CAAC,CAAA;QACrC,WAAW,GAAG,CAAC,WAAW,IAAI,EAAE,MAAM,CAAC,CAAA;QACvC,UAAU,GAAG,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,CAAA;QACpC,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,KAAK,EAAE,IAAI,cAAc,CAAA;QAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,cAAc,CAAA;QAChD,MAAM,UAAU,GAAG,CAAC,EAAE,KAAK,CAAC,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,OClMa,QAAQ;;IAKnB,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;KAC/B;;;;IAKD,IAAW,OAAO;QAChB,OAAOC,OAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,CAAA;KACjE;;;;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,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAA;KACxE;IAED,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAA;KACrC;;;;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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,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;;;AAGO,MAAM,GAAG,GAAG,EAAE,IAAI,IAAI"}
+{"version":3,"file":"index.js","sources":["../src/src/errors.ts","../src/src/ipv4/constants.ts","../src/src/ipv4/ipv4-address.ts","../src/src/ipv4/ipv4-cidr.ts","../src/src/ipv4/rfc1918.ts","../src/src/ipv6/ipv6-address.ts","../src/src/ipv6/constants.ts"],"sourcesContent":[null,null,null,null,null,null,null],"names":["MAX","stringToNum","numToString","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,GAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CCCtC,MAAM,cAAc,GAAG,GAAG,CAAA;AAE1B;;;;;;;MAOa,WAAW;IAGtB,YAAmB,OAAoB;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,OAAO,KAAK,QAAQ,GAAG,OAAO,GAAGC,aAAW,CAAC,OAAO,CAAC,CAAA;KAC7E;;;;IAKD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;;;;;;;;;;;;;;IAgBM,QAAQ;QACb,OAAOC,aAAW,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,KAAKC,SAAO,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAA;SAC1D;KACF;;;;;;;;;;;;;;;IAgBM,MAAM;;QAEX,OAAOA,SAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAA;KAClC;;;;;;;;;;;;;IAcM,UAAU;QACf,OAAOA,SAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAA;KAClC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;SAqBgBA,SAAO,CAAC,EAAe;;IAErC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;SAkBgBF,aAAW,CAAC,OAAe;IACzC,IAAI;QACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,cAAc,CAAC,EAAE;YAC7D,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,MAAM,CAAA;QAC/D,UAAU,GAAG,CAAC,UAAU,IAAI,EAAE,MAAM,CAAC,CAAA;QACrC,WAAW,GAAG,CAAC,WAAW,IAAI,EAAE,MAAM,CAAC,CAAA;QACvC,UAAU,GAAG,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,CAAA;QACpC,OAAO,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;KAC3D;IAAC,MAAM;QACN,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAA;KACzC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;SAmBgBC,aAAW,CAAC,EAAU;IACpC,IAAI;QACF,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAGF,KAAG,EAAE;YACtB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,MAAM,UAAU,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,cAAc,CAAA;QAC/C,MAAM,WAAW,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,cAAc,CAAA;QAChD,MAAM,UAAU,GAAG,CAAC,EAAE,KAAK,CAAC,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,OCpMa,QAAQ;;IAKnB,YAAY,SAAiB;QAC3B,IAAI;YACF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAClD,IAAI,CAAC,UAAU,GAAGI,SAAS,CAAC,OAAO,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;KAC/B;;;;IAKD,IAAW,OAAO;QAChB,OAAOA,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,CAAA;KACjE;;;;IAKD,IAAW,aAAa;QACtB,OAAOA,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;KAC1C;;;;IAKD,IAAW,YAAY;;QAErB,OAAOA,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAA;KACxE;IAED,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAA;KACrC;;;;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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,OAAO,IAAI,CAAC,GAAGF,aAAW,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,CAAC,IAAI,IAAI,CAAC,aAAa,CAAA;QAChE,OAAO,IAAI,CAAC,GAAGA,aAAW,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;KACxD;;;;IAKM,QAAQ,CAAC,OAA0B;QACxC,MAAM,EAAE,GAAG,OAAO,YAAY,WAAW,GAAG,OAAO,GAAGE,SAAS,CAAC,OAAO,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,CCpHA,MAAM,cAAc,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAA;AAE1F;;;;;;SAMgB,gBAAgB,CAAC,OAAoB;IACnD,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE;QACpC,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC7B,OAAO,IAAI,CAAA;SACZ;KACF;IACD,OAAO,KAAK,CAAA;AACd,ySCjBA,MAAM,eAAe,GAAG,MAAO,CAAA;AAE/B;;;;;;;MAOa,WAAW;IAGtB,YAAmB,OAAoB;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,OAAO,KAAK,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAA;KAC7E;;;;;;;;;;IAWD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAA;KACrB;;;;;IAMM,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;;;;;;;;;;;;IAaM,MAAM;;QAEX,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;;;;;;;;;;;;IAaM,UAAU;QACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAA;KACnC;CACF;AAED;;;;;;;;;;;;;;;;;;;;SAoBgB,OAAO,CAAC,EAAe;;IAErC,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED;AACA;;;;;;;;;SASgB,WAAW,CAAC,OAAe;IACzC,IAAI,OAAO,KAAK,IAAI,EAAE;QACpB,OAAO,EAAE,CAAA;KACV;IAED,IAAI,IAAI,GAAG,EAAE,CAAA;IACb,MAAM,UAAU,GAAa,EAAE,CAAA;IAC/B,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEvD,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QAC3C,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,CAAA;KAC/B;IAED,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC5C,MAAM,cAAc,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,CAAA;QAEpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE;YACvC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACrB;QAED,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE;YACjC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,CAAA;SAC/B;KACF;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;IAE/D,IAAI,SAAS,GAAG,EAAE,CAAA;IAClB,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;QAC1B,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QACzB,IAAI,GAAG,KAAK,CAAC,EAAE;YACb,SAAQ;SACT;QACD,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;QACpD,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,SAAS,CAAA;QACjC,IAAI,IAAI,MAAM,CAAA;KACf;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;SAUgB,WAAW,CAAC,GAAW;IACrC,IAAI,GAAG,KAAK,EAAE,EAAE;QACd,OAAO,IAAI,CAAA;KACZ;IACD,MAAM,OAAO,GAAa,EAAE,CAAA;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;QAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,IAAI,eAAe,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;KAClE;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IACzC,IAAI,YAAY,IAAI,CAAC,EAAE;QACrB,IAAI,SAAS,GAAG,CAAC,CAAA;QACjB,KAAK,IAAI,CAAC,GAAG,YAAY,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE;YACtD,SAAS,EAAE,CAAA;SACZ;QACD,OAAO,CAAC,MAAM,CACZ,YAAY,EACZ,SAAS,EACT,YAAY,KAAK,CAAC,IAAI,YAAY,GAAG,SAAS,KAAK,CAAC,GAAG,GAAG,GAAG,EAAE,CAChE,CAAA;KACF;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC1B,CC5MA;;;AAGO,MAAM,GAAG,GAAG,EAAE,IAAI,IAAI"}

package/build/{cidr/ipv4 → ipv4}/index.d.ts

@@ -2,3 +2,4 @@ export * from './ipv4-address';
 export * from './ipv4-cidr';
 export * from './constants';
 export * from './types';
+export * as rfc1918 from './rfc1918';

package/build/{cidr/ipv4 → ipv4}/ipv4-address.d.ts

@@ -4,7 +4,7 @@ import { Ipv4Literal, Ipv4Representable } from './types';
  * checking.
  *
  * @remarks
- * Direct instantiation should be avoided; use {@link ipv4.address} instead.
+ * Avoid direct instantiation; use {@link ipv4.address} instead.
  */
 export declare class Ipv4Address {
     private _address;
@@ -14,6 +14,8 @@ export declare class Ipv4Address {
      */
     get address(): number;
     /**
+     * Returns the string representation of the address
+     *
      * @example
      * ```typescript
      * import { ipv4 as ip } from 'cidr-block'
@@ -27,7 +29,7 @@ export declare class Ipv4Address {
      */
     toString(): string;
     /**
-     * Compares if two IP address are the same.
+     * Compares if two IPv4 addresses are the same.
      *
      * @example
      * ```typescript
@@ -44,12 +46,14 @@ export declare class Ipv4Address {
      */
     equals(otherIpAddress: Ipv4Representable): boolean;
     /**
+     * Calculates the next logical IPv4 address.
+     *
      * @example
      * ```typescript
      * import { ipv4 as ip } from 'cidr-block'
      *
      * const myIp = ip.address('52.89.32.255')
-     * myIp.nextIp()                                       // ==> '52.89.33.0
+     * myIp.nextIp()                                       // ==> '52.89.33.0'
      * ```
      *
      * @public
@@ -62,7 +66,7 @@ export declare class Ipv4Address {
      * import { ipv4 as ip } from 'cidr-block'
      *
      * const myIp = ip.address('52.89.32.19')
-     * myIp.previousIp()                                   // ==> '52.89.32.18
+     * myIp.previousIp()                                   // ==> '52.89.32.18'
      * ```
      *
      * @public
@@ -74,11 +78,8 @@ export declare class 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.
+ * object directly.
  *
  * @example
  *
@@ -90,6 +91,7 @@ export declare class Ipv4Address {
  *
  * @see {@link Ipv4Address}
  *
+ * @public
  * @param ip string representation of the IPv4 address
  * @returns an instance of Ipv4Address
  */
@@ -98,7 +100,6 @@ export declare function address(ip: Ipv4Literal): Ipv4Address;
  * Converts the string representation of an IPv4 address to a number.
  *
  * @example
- *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *
@@ -115,10 +116,9 @@ export declare function address(ip: Ipv4Literal): Ipv4Address;
  */
 export declare function stringToNum(address: string): number;
 /**
- * Converts the numerical number representation of an IPv4 address to its string representation.
+ * Converts the numerical representation of an IPv4 address to its string representation.
  *
  * @example
- *
  * ```typescript
  * import * as cidr from 'cidr-block'
  *

package/build/ipv4/rfc1918.d.ts

@@ -0,0 +1,8 @@
+import { Ipv4Address } from './ipv4-address';
+/**
+ * Predicate function that will return true if the given
+ * address is in the private RFC 1918 ipv4 address space.
+ *
+ * See more {@link https://datatracker.ietf.org/doc/html/rfc1918}
+ */
+export declare function isPrivateRFC1918(address: Ipv4Address): boolean;

package/build/ipv6/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ipv6-address';
+export * from './constants';
+export * from './types';

package/build/ipv6/ipv6-address.d.ts

@@ -0,0 +1,109 @@
+import { Ipv6Literal, Ipv6Representable } from './types';
+/**
+ * Representation of an IPv6 address. Provides various utilities methods like equality
+ * checking.
+ *
+ * @remarks
+ * Avoid direct instantiation; use {@link ipv6.address} instead.
+ */
+export declare class Ipv6Address {
+    private _address;
+    constructor(address: Ipv6Literal);
+    /**
+     * The address as a bigint
+     *
+     * @remarks
+     * Because the representation of an IPv6 address is too large to fit into a typical
+     * JavaScript integer, a
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt}
+     * is used instead.
+     */
+    get address(): bigint;
+    /**
+     * Returns the string representation of the address
+     */
+    toString(): string;
+    /**
+     * Compares if two IPv6 addresses are the same.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * function isLoopback(address: Ipv6Representable) {
+     *   return ip.address(address).equals('::1')
+     * }
+     *
+     * @public
+     * @param otherIpAddress the other Ipv6 address to compare
+     * @returns if the other IP address is the same
+     * ```
+     */
+    equals(otherIpAddress: Ipv6Representable): boolean;
+    /**
+     * Calculates the next logical IPv6 address.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('2001:0db8::ac10')
+     * myIp.nextIp()                                       // ==> '2001:0db8::ac11'
+     * ```
+     */
+    nextIp(): Ipv6Address;
+    /**
+     * Calculates the previous logical IPv6 address.
+     *
+     * @example
+     * ```typescript
+     * import { ipv6 as ip } from 'cidr-block'
+     *
+     * const myIp = ip.address('2001:0db8::ac10')
+     * myIp.previousIp()                                   // ==> '2001:0db8::ac09'
+     * ```
+     */
+    previousIp(): Ipv6Address;
+}
+/**
+ * Convenience function for creating an IPv6 address instance.
+ *
+ * @remarks
+ * In general, you should use this function instead of instantiating an Ipv6Address
+ * object directly.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { ipv6 as ip } from 'cidr-block'
+ *
+ * const localhost = ip.address('::1')
+ * ```
+ *
+ * @see {@link Ipv6Address}
+ *
+ * @param ip string representation of the IPv6 address
+ * @returns an instance of Ipv6Address
+ */
+export declare function address(ip: Ipv6Literal): Ipv6Address;
+/**
+ * Converts the string representation of an IPv6 address to a bigint.
+ *
+ * @see {@link Ipv6Address}
+ *
+ * @public
+ * @param ip string representation of the IPv6 address
+ * @returns an instance of Ipv6Address
+ */
+export declare function stringToNum(address: string): bigint;
+/**
+ * Converts the numerical representation of an IPv6 address to its string representation.
+ *
+ * @see This method is the inverse of {@link ipv6.stringToNum}
+ * @throws {@link InvalidIpAddressError}
+ *
+ * @public
+ * @param ip IPv6 address as a number
+ * @returns string representation of the address
+ */
+export declare function numToString(num: bigint): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cidr-block",
   "description": "ipv4 and ipv6 address and cidr range utilities",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "license": "MIT",
   "author": "Brandon Burrus <brandon@burrus.io>",
   "homepage": "https://cidr-block.com",

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

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

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

@@ -1,13 +0,0 @@
-import { Ipv6Literal, Ipv6Representable } from './types';
-export declare class Ipv6Address {
-    private _address;
-    constructor(address: Ipv6Literal);
-    get address(): bigint;
-    toString(): string;
-    equals(otherIpAddress: Ipv6Representable): boolean;
-    nextIp(): Ipv6Address;
-    previousIp(): Ipv6Address;
-}
-export declare function address(ip: Ipv6Literal): Ipv6Address;
-export declare function stringToNum(address: string): bigint;
-export declare function numToString(num: bigint): string;