ip-utilties 3.0.3 → 3.1.0

package/README.md

@@ -9,18 +9,17 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![Known Vulnerabilities](https://snyk.io/test/github/arlac77/ip-utilties/badge.svg)](https://snyk.io/test/github/arlac77/ip-utilties)
 
-ip v4/v6 utility functions
+ip-v4/v6 utility functions
 
 ## Three different representations
 
 ```javascript
 const ip4AsString = "10.0.0.1";
 const ip4AsArray = new Uint8Array([10,0,0,1]);
-const ip4or6AsBigInt = 10n << 14n | 1n;
+const ip4or6AsBigInt = 10n << 24n | 1n;
 
 
-
-encodeIPv4("10.0.0.1") // -> 10n << 14n | 1n;
+encodeIPv4("10.0.0.1") // -> 10n << 24n | 1n;
 ```
 
 # API

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "ip-utilties",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "packageManager": "npm@11.10.0",
+  "packageManager": "npm@11.16.0",
   "exports": {
     ".": {
       "default": "./src/ip.mjs"
@@ -40,15 +40,20 @@
     "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "devDependencies": {
-    "ava": "^7.0.0",
-    "browser-ava": "^2.3.57",
+    "ava": "^8.0.1",
+    "browser-ava": "^2.3.61",
     "c8": "^11.0.0",
     "documentation": "^14.0.3",
-    "semantic-release": "^25.0.3",
-    "typescript": "^6.0.2"
+    "semantic-release": "^25.0.5",
+    "typescript": "^6.0.3"
+  },
+  "overrides": {
+    "c8": {
+      "yargs": "^18.0.0"
+    }
   },
   "engines": {
-    "node": ">=24.14.0"
+    "node": ">=26.2.0"
   },
   "repository": {
     "type": "git",

package/src/ip.mjs

@@ -1,9 +1,17 @@
+/**
+ * Address familiy IPv4
+ */
+export const FAMILY_IPV4 = "IPv4";
+
+/**
+ * Address familiy IPv6
+ */
+export const FAMILY_IPV6 = "IPv6";
+
 const ipv4 = {
-  name: "IPv4",
+  name: FAMILY_IPV4,
   factory: Uint8Array,
-  normalize(address) {
-    return address;
-  },
+  normalize: address => address,
   separator: ".",
   bitLength: 32,
   segments: 4,
@@ -13,7 +21,7 @@ const ipv4 = {
 };
 
 const ipv6 = {
-  name: "IPv6",
+  name: FAMILY_IPV6,
   factory: Uint16Array,
   normalize(address) {
     const parts = address.split(":");
@@ -34,7 +42,7 @@ const ipv6 = {
 
 /**
  * Encode ipv4 or ipv6 address into number array.
- * @param {string|number[]} address 
+ * @param {string|number[]} address
  * @returns number[]
  */
 export function encodeIP(address) {
@@ -44,7 +52,7 @@ export function encodeIP(address) {
 
 /**
  * Encode ipv6 address into number array.
- * @param {string|number[]|bigint} address 
+ * @param {string|number[]|bigint} address
  * @returns number[]
  */
 export function encodeIPv6(address) {
@@ -53,7 +61,7 @@ export function encodeIPv6(address) {
 
 /**
  * Encode ipv6 address into number array.
- * @param {string|number[]|bigint} address 
+ * @param {string|number[]|bigint} address
  * @returns number[]
  */
 export function encodeIPv4(address) {
@@ -231,7 +239,10 @@ export function rangeIP(address, prefix, lowerAdd = 0, upperReduce = 0) {
 
 export function matchPrefixIP(prefix, length, address) {
   const family = _family(address);
-  return family !== undefined && _prefix(family, address, length) === _prefix(family, prefix, length);
+  return (
+    family !== undefined &&
+    _prefix(family, address, length) === _prefix(family, prefix, length)
+  );
 }
 
 export function normalizeCIDR(address) {
@@ -334,11 +345,11 @@ export function hasWellKnownSubnet(address) {
 /*
  * https://www.iana.org/assignments/ipv6-multicast-addresses/ipv6-multicast-addresses.xhtml
  */
-export const IPV6_NODE_LOCAL_ALL_NODES        = _encode(ipv6, "ff01::1");
-export const IPV6_NODE_LOCAL_ALL_ROUTERS      = _encode(ipv6, "ff01::2");
-export const IPV6_LINK_LOCAL_ALL_NODES        = _encode(ipv6, "ff02::1");
-export const IPV6_LINK_LOCAL_ALL_ROUTERS      = _encode(ipv6, "ff02::2");
-export const IPV6_SITE_LOCAL_ALL_ROUTERS      = _encode(ipv6, "ff05::2");
+export const IPV6_NODE_LOCAL_ALL_NODES = _encode(ipv6, "ff01::1");
+export const IPV6_NODE_LOCAL_ALL_ROUTERS = _encode(ipv6, "ff01::2");
+export const IPV6_LINK_LOCAL_ALL_NODES = _encode(ipv6, "ff02::1");
+export const IPV6_LINK_LOCAL_ALL_ROUTERS = _encode(ipv6, "ff02::2");
+export const IPV6_SITE_LOCAL_ALL_ROUTERS = _encode(ipv6, "ff05::2");
 export const IPV6_SITE_LOCAL_ALL_DHCP_SERVERS = _encode(ipv6, "ff05::1:3");
 
 export const IPV4_LOCALHOST = _encode(ipv4, "127.0.0.1");

package/types/ip.d.mts

@@ -44,6 +44,14 @@ export function isLocalhost(address: any): boolean;
 export function isLinkLocal(address: any): boolean;
 export function isUniqueLocal(address: any): boolean;
 export function hasWellKnownSubnet(address: any): boolean;
+/**
+ * Address familiy IPv4
+ */
+export const FAMILY_IPV4: "IPv4";
+/**
+ * Address familiy IPv6
+ */
+export const FAMILY_IPV6: "IPv6";
 export const IPV6_NODE_LOCAL_ALL_NODES: any;
 export const IPV6_NODE_LOCAL_ALL_ROUTERS: any;
 export const IPV6_LINK_LOCAL_ALL_NODES: any;