pmcf 2.21.1 → 2.22.0

package/README.md

@@ -33,6 +33,7 @@ Type: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 
 *   `networkInterface` **NetworkInterface** 
 *   `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))** 
+*   `family` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `subnet` **Subnet** 
 *   `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;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmcf",
-  "version": "2.21.1",
+  "version": "2.22.0",
   "publishConfig": {
     "access": "public"
   },

package/src/cluster.mjs

@@ -87,7 +87,7 @@ export class Cluster extends Host {
         "   notification_email {",
         "    " + this.administratorEmail,
         "  }",
-        `  smtp_server ${this.smtp.rawAddress}`,
+        `  smtp_server ${this.smtp.address}`,
         `  notification_email_from keepalived@${host.domainName}`,
         "  enable_script_security",
         "  script_user root",
@@ -132,7 +132,7 @@ export class Cluster extends Host {
         cfg.push("");
 
         for (const service of cluster.findServices({ type: "http" })) {
-          cfg.push(`virtual_server ${cluster.rawAddress} ${service.port} {`);
+          cfg.push(`virtual_server ${cluster.address} ${service.port} {`);
           cfg.push(`  delay_loop ${cluster.checkInterval}`);
           cfg.push("  lb_algo wlc");
           cfg.push("  persistence_timeout 600");
@@ -142,7 +142,7 @@ export class Cluster extends Host {
             const memberService = member.findService({ type: service.type });
 
             cfg.push(
-              `  real_server ${member.rawAddress} ${memberService.port} {`
+              `  real_server ${member.address} ${memberService.port} {`
             );
             cfg.push(`    weight ${memberService.weight}`);
 

package/src/host.mjs

@@ -1,9 +1,8 @@
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
 import { FileContentProvider } from "npm-pkgbuild";
-import { formatCIDR } from "ip-utilties";
 import { Base } from "./base.mjs";
-import { networkAddressProperties } from "./network-support.mjs";
+import { networkAddressProperties, addresses } from "./network-support.mjs";
 import { domainFromDominName, domainName } from "./utils.mjs";
 import { objectFilter } from "./filter.mjs";
 import { addType, types } from "./types.mjs";
@@ -427,12 +426,12 @@ export class Host extends Base {
     }
   }
 
-  get rawAddress() {
-    return this.rawAddresses[0];
+  get address() {
+    return this.addresses[0];
   }
 
-  get rawAddresses() {
-    return [...this.networkAddresses()].map(na => na.address);
+  get addresses() {
+    return addresses(this.networkAddresses());
   }
 
   async publicKey(type = "ed25519") {

package/src/network-interface.mjs

@@ -1,11 +1,4 @@
-import {
-  isIPv4,
-  isIPv6,
-  formatCIDR,
-  hasWellKnownSubnet,
-  normalizeIP,
-  familyIP
-} from "ip-utilties";
+import { hasWellKnownSubnet, normalizeIP, familyIP } from "ip-utilties";
 import { Base } from "./base.mjs";
 import { Subnet } from "./subnet.mjs";
 import {
@@ -100,11 +93,11 @@ class SkeletonNetworkInterface extends Base {
     }
   }
 
-  get rawAddress() {
-    return this.rawAddresses[0];
+  get address() {
+    return this.addresses[0];
   }
 
-  get rawAddresses() {
+  get addresses() {
     return [...this.ipAddresses].map(([address]) => address);
   }
 }

package/src/network-support.mjs

@@ -37,10 +37,14 @@ export const networkAddressProperties = {
   hostName: { type: "string", collection: false, writeable: true },
   cidrAddresses: { type: "string", collection: true, writeable: false },
   cidrAddress: { type: "string", collection: false, writeable: false },
-  rawAddresses: { type: "string", collection: true, writeable: false },
-  rawAddress: { type: "string", collection: false, writeable: false }
+  addresses: { type: "string", collection: true, writeable: false },
+  address: { type: "string", collection: false, writeable: false }
 };
 
+export function addresses(networkAddresses) {
+  return [...networkAddresses].map(na => na.address);
+}
+
 export function cidrAddresses(networkAddresses) {
   return [...networkAddresses].map(na =>
     formatCIDR(na.address, na.subnet.prefixLength)

package/src/service.mjs

@@ -1,7 +1,6 @@
-import { isLocalhost } from "ip-utilties";
+import { isLocalhost, familyIP } from "ip-utilties";
 import { Base } from "./base.mjs";
 import { addType } from "./types.mjs";
-import { objectFilter } from "./filter.mjs";
 import { asArray } from "./utils.mjs";
 import { networkAddressProperties } from "./network-support.mjs";
 import {
@@ -158,30 +157,26 @@ export class Service extends Base {
   }
 
   get ipAddressOrDomainName() {
-    return this.rawAddress ?? this.domainName;
+    return this.address ?? this.domainName;
   }
 
-  get rawAddresses() {
-    return this._ipAddresses ?? this.owner.rawAddresses;
+  get addresses() {
+    return this._ipAddresses ?? this.owner.addresses;
   }
 
-  get rawAddress() {
-    return this._ipAddresses?.[0] ?? this.server.rawAddress;
+  get address() {
+    return this._ipAddresses?.[0] ?? this.server.address;
   }
 
   set ipAddresses(value) {
     this._ipAddresses = value;
   }
 
-  get addresses() {
-    return this.rawAddresses.map(a => `${a}:${this.port}`);
-  }
-
   get networks() {
     return this.server.networks;
   }
 
-  get endpoints() {
+  endpoints(filter) {
     const local =
       this._port === undefined
         ? { type: this.type }
@@ -193,22 +188,20 @@ export class Service extends Base {
       }
     ];
 
-    return [...this.server.networkAddresses()]
+    const result = [...this.server.networkAddresses()]
       .map(sa =>
         data.map(
           d =>
             new Endpoint(this, sa.networkInterface, {
               ...d,
-              rawAddress: sa.address,
+              address: sa.address,
               ...local
             })
         )
       )
       .flat();
-  }
 
-  *findEndpoints(filter) {
-    yield* objectFilter(EndpointTypeDefinition, this.endpoints, filter);
+    return filter ? result.filter(filter) : result;
   }
 
   set alias(value) {
@@ -224,15 +217,15 @@ export class Service extends Base {
   }
 
   get port() {
-    return this.endpoints[0].port;
+    return this.endpoints()[0].port;
   }
 
   get protocol() {
-    return this.endpoints[0].protocol;
+    return this.endpoints()[0].protocol;
   }
 
   get tls() {
-    return this.endpoints[0].tls;
+    return this.endpoints()[0].tls;
   }
 
   set weight(value) {
@@ -262,8 +255,8 @@ export class Service extends Base {
     }
 
     if (hasSVRRecords) {
-      for (const ep of this.endpoints.filter(
-        e => e.protocol && e.networkInterface.scope !== "host" // TODO how to identify related interfaces
+      for (const ep of this.endpoints(
+        e => e.protocol && e.networkInterface.kind !== "loopback"
       )) {
         records.push(
           DNSRecord(
@@ -325,21 +318,29 @@ export class Endpoint {
   }
 
   toString() {
-    return `${this.rawAddress}[${this.port}]`;
+    return `${this.address}[${this.port}]`;
+  }
+
+  get socketAddress() {
+    return `${this.address}:${this.port}`;
   }
 
   get hostName() {
     return this.networkInterface.hostName;
   }
 
-  #rawAddress;
+  #address;
+
+  get address() {
+    return this.#address ?? this.networkInterface.address;
+  }
 
-  get rawAddress() {
-    return this.#rawAddress ?? this.networkInterface.rawAddress;
+  set address(value) {
+    this.#address = value;
   }
 
-  set rawAddress(value) {
-    this.#rawAddress = value;
+  get family() {
+    return familyIP(this.address);
   }
 }
 
@@ -348,7 +349,7 @@ export const sortByPriority = (a, b) => a.priority - b.priority;
 export function serviceAddresses(
   sources,
   filter,
-  addressType = "rawAddresses",
+  addressType = "addresses",
   addressFilter = a => !isLocalhost(a)
 ) {
   return asArray(sources)
@@ -360,11 +361,11 @@ export function serviceAddresses(
     .filter(addressFilter);
 }
 
-export function serviceEndpoints(sources, filter) {
+export function serviceEndpoints(sources, filter, endpointFilter) {
   return asArray(sources)
     .map(ft => Array.from(ft.findServices(filter)))
     .flat()
     .sort(sortByPriority)
-    .map(service => service.endpoints)
+    .map(service => service.endpoints(endpointFilter))
     .flat();
 }

package/src/services/dhcp.mjs

@@ -20,7 +20,7 @@ const DHCPServiceTypeDefinition = {
 };
 
 const controlAgentEndpoint = {
- // extends: ["http"],
+  // extends: ["http"],
   type: "kea-control-agent",
   port: 8000,
   protocol: "tcp",
@@ -52,18 +52,18 @@ export class DHCPService extends Service {
     return DHCPServiceTypeDefinition.name;
   }
 
-  get endpoints() {
+  endpoints(filter) {
     const l0 = this.server.findNetworkInterface({ scope: "host" });
 
     if (l0) {
       return [
-        ...super.endpoints,
+        ...super.endpoints(filter),
         new Endpoint(this, l0, controlAgentEndpoint),
         new Endpoint(this, l0, ddnsEndpoint)
       ];
     }
 
-    return super.endpoints;
+    return super.endpoints(filter);
   }
 
   async *preparePackages(dir) {
@@ -147,9 +147,9 @@ export class DHCPService extends Service {
         return {
           name: domain,
           "dns-servers": dnsServerEndpoints
-            .filter(endpoint => isIPv4(endpoint.rawAddress))
+            .filter(endpoint => isIPv4(endpoint.address))
             .map(endpoint => {
-              return { "ip-address": endpoint.rawAddress };
+              return { "ip-address": endpoint.address };
             })
         };
       });
@@ -209,23 +209,23 @@ export class DHCPService extends Service {
       .map(([k, networkInterface]) => {
         return {
           "hw-address": k,
-          "ip-address": networkInterface.networkAddress(n => n.family === "IPv4").address,
+          "ip-address": networkInterface.networkAddress(
+            n => n.family === "IPv4"
+          ).address,
           hostname: networkInterface.hostName
         };
       })
       .sort((a, b) => a.hostname.localeCompare(b.hostname));
 
     const listenInterfaces = filter =>
-      this.endpoints
-        .filter(
-          endpoint =>
-            endpoint.type === "dhcp" &&
-            filter(endpoint.rawAddress) &&
-            endpoint.networkInterface.kind !== "loopback"
-        )
-        .map(
-          endpoint => `${endpoint.networkInterface.name}/${endpoint.rawAddress}`
-        );
+      this.endpoints(
+        endpoint =>
+          endpoint.type === "dhcp" &&
+          filter(endpoint.address) &&
+          endpoint.networkInterface.kind !== "loopback"
+      ).map(
+        endpoint => `${endpoint.networkInterface.name}/${endpoint.address}`
+      );
 
     const dhcp4 = {
       Dhcp4: {
@@ -244,8 +244,8 @@ export class DHCPService extends Service {
           {
             name: "domain-name-servers",
             data: dnsServerEndpoints
-              .filter(endpoint => isIPv4(endpoint.rawAddress))
-              .map(endpoint => endpoint.rawAddress)
+              .filter(endpoint => isIPv4(endpoint.address))
+              .map(endpoint => endpoint.address)
               .join(",")
           },
           {
@@ -263,7 +263,7 @@ export class DHCPService extends Service {
               "option-data": [
                 {
                   name: "routers",
-                  data: network.gateway.rawAddress
+                  data: network.gateway.address
                 }
               ],
               reservations
@@ -288,8 +288,8 @@ export class DHCPService extends Service {
           {
             name: "dns-servers",
             data: dnsServerEndpoints
-              .filter(endpoint => isIPv6(endpoint.rawAddress))
-              .map(endpoint => endpoint.rawAddress)
+              .filter(endpoint => isIPv6(endpoint.address))
+              .map(endpoint => endpoint.address)
               .join(",")
           }
         ],

package/src/services/dns.mjs

@@ -295,12 +295,12 @@ async function generateZoneDefs(dns, location, packageData) {
 
       zone.records.add(DNSRecord("location", "TXT", host.location.name));
 
-      for (const address of host.rawAddresses) {
-        if (!isLocalhost(address)) {
-          zone.records.add(
-            DNSRecord("@", isIPv6(address) ? "AAAA" : "A", address)
-          );
-        }
+      for (const na of host.networkAddresses(
+        na => na.networkInterface.kind != "loopback"
+      )) {
+        zone.records.add(
+          DNSRecord("@", na.family === "IPv6" ? "AAAA" : "A", na.address)
+        );
       }
     }
   }
@@ -311,11 +311,11 @@ async function generateZoneDefs(dns, location, packageData) {
     addHook(
       packageData.properties.hooks,
       "post_upgrade",
-    //  `rm -f ${foreignZones.map(zone => `/var/lib/named/${zone.file}.jnl`)}\n` +
-    //    "systemctl try-reload-or-restart named\n" +
-        `/usr/bin/named-hostname-info ${foreignZones
-          .map(zone => zone.id)
-          .join(" ")}|/usr/bin/named-hostname-update`
+      //  `rm -f ${foreignZones.map(zone => `/var/lib/named/${zone.file}.jnl`)}\n` +
+      //    "systemctl try-reload-or-restart named\n" +
+      `/usr/bin/named-hostname-info ${foreignZones
+        .map(zone => zone.id)
+        .join(" ")}|/usr/bin/named-hostname-update`
     );
   }
 
@@ -366,7 +366,10 @@ async function generateZoneDefs(dns, location, packageData) {
       networkInterface,
       domainNames
     } of location.networkAddresses()) {
-      if (!dns.exclude.has(networkInterface.network) && !dns.excludeInterfaceKinds.has(networkInterface.kind)) {
+      if (
+        !dns.exclude.has(networkInterface.network) &&
+        !dns.excludeInterfaceKinds.has(networkInterface.kind)
+      ) {
         const host = networkInterface.host;
         if (
           !addresses.has(address) &&

package/src/services/ntp.mjs

@@ -91,7 +91,7 @@ export class NTPService extends ExtraSourceService {
       }).map(
         endpoint =>
           `${endpoint.service.isPool ? "pool" : "server"} ${
-            endpoint.rawAddress
+            endpoint.address
           } iburst`
       ),
       `mailonchange ${this.administratorEmail} 0.5`,

package/types/cluster.d.mts

@@ -294,12 +294,12 @@ export class Cluster extends Host {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;

package/types/extra-source-service.d.mts

@@ -127,12 +127,12 @@ export class ExtraSourceService extends Service {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;

package/types/host.d.mts

@@ -159,12 +159,12 @@ export class Host extends Base {
                 collection: boolean;
                 writeable: boolean;
             };
-            rawAddresses: {
+            addresses: {
                 type: string;
                 collection: boolean;
                 writeable: boolean;
             };
-            rawAddress: {
+            address: {
                 type: string;
                 collection: boolean;
                 writeable: boolean;
@@ -233,8 +233,8 @@ export class Host extends Base {
     set networkInterfaces(networkInterface: Map<any, any>);
     get networkInterfaces(): Map<any, any>;
     networkAddresses(filter: any): Generator<any, void, any>;
-    get rawAddress(): any;
-    get rawAddresses(): any[];
+    get address(): any;
+    get addresses(): any[];
     publicKey(type?: string): Promise<string>;
     preparePackages(dir: any): AsyncGenerator<{
         dir: any;

package/types/network-interface.d.mts

@@ -93,12 +93,12 @@ export namespace NetworkInterfaceTypeDefinition {
             collection: boolean;
             writeable: boolean;
         };
-        rawAddresses: {
+        addresses: {
             type: string;
             collection: boolean;
             writeable: boolean;
         };
-        rawAddress: {
+        address: {
             type: string;
             collection: boolean;
             writeable: boolean;
@@ -252,12 +252,12 @@ export class NetworkInterface extends SkeletonNetworkInterface {
                 collection: boolean;
                 writeable: boolean;
             };
-            rawAddresses: {
+            addresses: {
                 type: string;
                 collection: boolean;
                 writeable: boolean;
             };
-            rawAddress: {
+            address: {
                 type: string;
                 collection: boolean;
                 writeable: boolean;
@@ -450,12 +450,12 @@ export class LoopbackNetworkInterface extends SkeletonNetworkInterface {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
@@ -609,12 +609,12 @@ export class LoopbackNetworkInterface extends SkeletonNetworkInterface {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
@@ -718,8 +718,8 @@ declare class SkeletonNetworkInterface extends Base {
      */
     networkAddresses(filter?: object): Iterable<NetworkAddress>;
     networkAddress(filter: any): NetworkAddress;
-    get rawAddress(): any;
-    get rawAddresses(): any[];
+    get address(): any;
+    get addresses(): any[];
 }
 import { Subnet } from "./subnet.mjs";
 import { Base } from "./base.mjs";

package/types/network-support.d.mts

@@ -1,3 +1,4 @@
+export function addresses(networkAddresses: any): any[];
 export function cidrAddresses(networkAddresses: any): any[];
 export namespace networkProperties {
     export namespace scope {
@@ -109,7 +110,7 @@ export namespace networkAddressProperties {
         let writeable_11: boolean;
         export { writeable_11 as writeable };
     }
-    namespace rawAddresses {
+    namespace addresses {
         let type_12: string;
         export { type_12 as type };
         let collection_12: boolean;
@@ -117,7 +118,7 @@ export namespace networkAddressProperties {
         let writeable_12: boolean;
         export { writeable_12 as writeable };
     }
-    namespace rawAddress {
+    namespace address {
         let type_13: string;
         export { type_13 as type };
         let collection_13: boolean;

package/types/service.d.mts

@@ -1,5 +1,5 @@
 export function serviceAddresses(sources: any, filter: any, addressType?: string, addressFilter?: (a: any) => boolean): any[];
-export function serviceEndpoints(sources: any, filter: any): any[];
+export function serviceEndpoints(sources: any, filter: any, endpointFilter: any): any[];
 export namespace endpointProperties {
     export namespace port {
         let type: string;
@@ -159,12 +159,12 @@ export namespace ServiceTypeDefinition {
             collection: boolean;
             writeable: boolean;
         };
-        rawAddresses: {
+        addresses: {
             type: string;
             collection: boolean;
             writeable: boolean;
         };
-        rawAddress: {
+        address: {
             type: string;
             collection: boolean;
             writeable: boolean;
@@ -284,12 +284,12 @@ export class Service extends Base {
                 collection: boolean;
                 writeable: boolean;
             };
-            rawAddresses: {
+            addresses: {
                 type: string;
                 collection: boolean;
                 writeable: boolean;
             };
-            rawAddress: {
+            address: {
                 type: string;
                 collection: boolean;
                 writeable: boolean;
@@ -308,13 +308,11 @@ export class Service extends Base {
     get server(): any;
     get domainName(): any;
     get ipAddressOrDomainName(): any;
-    get rawAddresses(): any;
-    get rawAddress(): any;
-    set ipAddresses(value: any);
     get addresses(): any;
+    get address(): any;
+    set ipAddresses(value: any);
     get networks(): any;
-    get endpoints(): any[];
-    findEndpoints(filter: any): Generator<any, void, any>;
+    endpoints(filter: any): any[];
     set alias(value: any);
     get alias(): any;
     set port(value: any);
@@ -336,9 +334,11 @@ export class Endpoint {
     service: any;
     networkInterface: any;
     toString(): string;
+    get socketAddress(): string;
     get hostName(): any;
-    set rawAddress(value: any);
-    get rawAddress(): any;
+    set address(value: any);
+    get address(): any;
+    get family(): any;
     #private;
 }
 export function sortByPriority(a: any, b: any): number;

package/types/services/dhcp.d.mts

@@ -113,12 +113,12 @@ export class DHCPService extends Service {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
@@ -238,12 +238,12 @@ export class DHCPService extends Service {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;

package/types/services/dns.d.mts

@@ -113,12 +113,12 @@ export class DNSService extends ExtraSourceService {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
@@ -241,12 +241,12 @@ export class DNSService extends ExtraSourceService {
                         collection: boolean;
                         writeable: boolean;
                     };
-                    rawAddresses: {
+                    addresses: {
                         type: string;
                         collection: boolean;
                         writeable: boolean;
                     };
-                    rawAddress: {
+                    address: {
                         type: string;
                         collection: boolean;
                         writeable: boolean;

package/types/services/ntp.d.mts

@@ -113,12 +113,12 @@ export class NTPService extends ExtraSourceService {
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddresses: {
+                addresses: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
                 };
-                rawAddress: {
+                address: {
                     type: string;
                     collection: boolean;
                     writeable: boolean;
@@ -241,12 +241,12 @@ export class NTPService extends ExtraSourceService {
                         collection: boolean;
                         writeable: boolean;
                     };
-                    rawAddresses: {
+                    addresses: {
                         type: string;
                         collection: boolean;
                         writeable: boolean;
                     };
-                    rawAddress: {
+                    address: {
                         type: string;
                         collection: boolean;
                         writeable: boolean;