pmcf 2.20.0 → 2.21.0

package/README.md

@@ -18,7 +18,31 @@
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-## Table of Contents
+### Table of Contents
+
+*   [NetworkAddress](#networkaddress)
+    *   [Properties](#properties)
+*   [networkAddresses](#networkaddresses)
+    *   [Parameters](#parameters)
+
+## NetworkAddress
+
+Type: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `networkInterface` **NetworkInterface**&#x20;
+*   `address` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [Uint16Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array))**&#x20;
+*   `subnet` **Subnet**&#x20;
+*   `domainNames` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**&#x20;
+
+## networkAddresses
+
+### Parameters
+
+*   `filter` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `n=>true`)
+
+Returns **Iterable<[NetworkAddress](#networkaddress)>**&#x20;
 
 # install
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmcf",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "publishConfig": {
     "access": "public"
   },
@@ -38,7 +38,7 @@
     "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "ip-utilties": "^1.1.0",
+    "ip-utilties": "^1.2.0",
     "npm-pkgbuild": "^18.0.1",
     "pacc": "^3.4.0",
     "pkg-dir": "^8.0.0"

package/src/network-interface.mjs

@@ -3,7 +3,8 @@ import {
   isIPv6,
   formatCIDR,
   hasWellKnownSubnet,
-  normalizeIP
+  normalizeIP,
+  familyIP
 } from "ip-utilties";
 import { Base } from "./base.mjs";
 import { Subnet } from "./subnet.mjs";
@@ -18,6 +19,7 @@ import { addType } from "./types.mjs";
  * @typedef {object} NetworkAddress
  * @property {NetworkInterface} networkInterface
  * @property {string|Uint8Array|Uint16Array} address
+ * @property {string} family
  * @property {Subnet} subnet
  * @property {Set<string>} domainNames
  */
@@ -72,35 +74,34 @@ class SkeletonNetworkInterface extends Base {
   }
 
   /**
-   * 
+   *
    * @param {object} filter
-   * @return {Iterable<NetworkAddress>} 
+   * @return {Iterable<NetworkAddress>}
    */
-  *networkAddresses(filter=(n)=>true) {
+  *networkAddresses(filter = n => true) {
     for (const [address, subnet] of this.ipAddresses) {
       const networkAddress = {
         networkInterface: this,
         domainNames: this.domainNames,
         address,
+        family: familyIP(address),
         subnet
       };
 
-      if(filter(networkAddress)) {
+      if (filter(networkAddress)) {
         yield networkAddress;
       }
     }
   }
 
-  get rawAddress() {
-    return this.rawAddresses[0];
-  }
-
-  get rawIPv4Address() {
-    return this.rawAddresses.filter(a => isIPv4(a))[0];
+  networkAddress(filter) {
+    for (const a of this.networkAddresses(filter)) {
+      return a;
+    }
   }
 
-  get rawIPv6Address() {
-    return this.rawAddresses.filter(a => isIPv6(a))[0];
+  get rawAddress() {
+    return this.rawAddresses[0];
   }
 
   get cidrAddress() {
@@ -111,18 +112,6 @@ class SkeletonNetworkInterface extends Base {
     return [...this.ipAddresses].map(([address]) => address);
   }
 
-  get rawIPv4Addresses() {
-    return [...this.ipAddresses]
-      .filter(([address]) => isIPv4(address))
-      .map(([address]) => address);
-  }
-
-  get rawIPv6Addresses() {
-    return [...this.ipAddresses]
-      .filter(([address]) => isIPv6(address))
-      .map(([address]) => address);
-  }
-
   get cidrAddresses() {
     return [...this.ipAddresses].map(([address, subnet]) =>
       formatCIDR(address, subnet.prefixLength)

package/src/services/dhcp.mjs

@@ -209,7 +209,7 @@ export class DHCPService extends Service {
       .map(([k, networkInterface]) => {
         return {
           "hw-address": k,
-          "ip-address": networkInterface.rawIPv4Address,
+          "ip-address": networkInterface.networkAddress(n => n.family === "IPv4").address,
           hostname: networkInterface.hostName
         };
       })

package/types/network-interface.d.mts

@@ -688,6 +688,7 @@ export class LoopbackNetworkInterface extends SkeletonNetworkInterface {
 export type NetworkAddress = {
     networkInterface: NetworkInterface;
     address: string | Uint8Array | Uint16Array;
+    family: string;
     subnet: Subnet;
     domainNames: Set<string>;
 };
@@ -695,6 +696,7 @@ export type NetworkAddress = {
  * @typedef {object} NetworkAddress
  * @property {NetworkInterface} networkInterface
  * @property {string|Uint8Array|Uint16Array} address
+ * @property {string} family
  * @property {Subnet} subnet
  * @property {Set<string>} domainNames
  */
@@ -715,13 +717,10 @@ declare class SkeletonNetworkInterface extends Base {
      * @return {Iterable<NetworkAddress>}
      */
     networkAddresses(filter?: object): Iterable<NetworkAddress>;
+    networkAddress(filter: any): NetworkAddress;
     get rawAddress(): any;
-    get rawIPv4Address(): any;
-    get rawIPv6Address(): any;
     get cidrAddress(): any;
     get rawAddresses(): any[];
-    get rawIPv4Addresses(): any[];
-    get rawIPv6Addresses(): any[];
     get cidrAddresses(): any[];
 }
 import { Subnet } from "./subnet.mjs";