pmcf 3.14.2 → 3.15.0

package/README.md

@@ -14,32 +14,58 @@
 
 ## Poor mans configuration management
 
+Generates system packages from config blueprint.
+
+supported linux derivates:
+
+- arch linux
+- debian
+- rpm based systems
+
+generates config packages for:
+
+- systemd
+  - networkd
+  - timesyncd
+  - resolverd
+- kea
+- bind
+- mosquitto
+- influxdb
+- iwd
+- chrony
+  
 # API
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ### Table of Contents
 
-*   [Base](#base)
-    *   [Parameters](#parameters)
-    *   [extends](#extends)
-    *   [findService](#findservice)
-        *   [Parameters](#parameters-1)
-*   [port](#port)
-*   [socketAddress](#socketaddress)
-*   [port](#port-1)
-*   [SkeletonNetworkInterface](#skeletonnetworkinterface)
-    *   [networkAddresses](#networkaddresses)
-        *   [Parameters](#parameters-2)
-*   [NetworkAddress](#networkaddress)
-    *   [Parameters](#parameters-3)
-    *   [subnet](#subnet)
-    *   [networkInterface](#networkinterface)
-    *   [address](#address)
-*   [addresses](#addresses)
-    *   [Parameters](#parameters-4)
-*   [serviceEndpoints](#serviceendpoints)
-    *   [Parameters](#parameters-5)
+- [pmcf](#pmcf)
+  - [Poor mans configuration management](#poor-mans-configuration-management)
+- [API](#api)
+    - [Table of Contents](#table-of-contents)
+  - [Base](#base)
+    - [Parameters](#parameters)
+    - [extends](#extends)
+    - [findService](#findservice)
+      - [Parameters](#parameters-1)
+  - [port](#port)
+  - [socketAddress](#socketaddress)
+  - [port](#port-1)
+  - [SkeletonNetworkInterface](#skeletonnetworkinterface)
+    - [networkAddresses](#networkaddresses)
+      - [Parameters](#parameters-2)
+  - [NetworkAddress](#networkaddress)
+    - [Parameters](#parameters-3)
+    - [subnet](#subnet)
+    - [networkInterface](#networkinterface)
+    - [address](#address)
+  - [addresses](#addresses)
+    - [Parameters](#parameters-4)
+  - [serviceEndpoints](#serviceendpoints)
+    - [Parameters](#parameters-5)
+- [install](#install)
 
 ## Base
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "pmcf",
-  "version": "3.14.2",
+  "version": "3.15.0",
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "npm@11.6.0+sha512.77f3fb0dbbd881835d7bd1217deabdf7ed77fc4ec4f363df64fc3cb986404abf6c437661041080f5c5d225103508e7c9ea30cb2742b7e942675d05a10af2d7b9",
+  "packageManager": "npm@11.6.3+sha512.4085a763162e0e3acd19a4e9d23ad3aa0978e501ccf947dd7233c12a689ae0bb0190763c4ef12366990056b34eec438903ffed38fde4fbd722a17c2a7407ee92",
   "exports": {
     ".": {
       "default": "./src/module.mjs"
@@ -12,10 +12,12 @@
   },
   "description": "Poor mans configuration management",
   "keywords": [
+    "arch linux",
     "bind",
     "chrony",
     "config",
     "config management",
+    "debian",
     "dhcp",
     "dns",
     "influxdb",
@@ -24,7 +26,7 @@
     "keepalived",
     "mosquitto",
     "openldap",
-    "openldap",
+    "rpm",
     "systemd"
   ],
   "contributors": [
@@ -51,9 +53,9 @@
     "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "ip-utilties": "^1.4.12",
-    "npm-pkgbuild": "^19.0.2",
-    "pacc": "^4.41.1",
+    "ip-utilties": "^1.4.13",
+    "npm-pkgbuild": "^19.0.3",
+    "pacc": "^4.41.2",
     "package-directory": "^8.1.0"
   },
   "devDependencies": {

package/src/endpoint.mjs

@@ -23,6 +23,9 @@ class BaseEndpoint {
   }
 }
 
+/**
+ * Endpoint with an ip port
+ */
 class PortEndpoint extends BaseEndpoint {
   _port;
   constructor(service, data) {
@@ -108,6 +111,9 @@ export class DomainNameEndpoint extends PortEndpoint {
   }
 }
 
+/**
+ * Endpoint based on http
+ */
 export class HTTPEndpoint extends BaseEndpoint {
   constructor(service, address, data) {
     super(service, data);

package/src/network-address.mjs

@@ -1,6 +1,7 @@
 import { familyIP, formatCIDR, decodeIP } from "ip-utilties";
 import { Subnet } from "./subnet.mjs";
 import { Owner } from "pmcf";
+import { NetworkInterface } from "./network-interfaces/network-interface.mjs";
 
 /**
  *
@@ -10,6 +11,12 @@ export class NetworkAddress {
   /** @type {NetworkInterface} */ networkInterface;
   /** @type {string|Uint8Array|Uint16Array} */ address;
 
+  /**
+   * 
+   * @param {NetworkInterface} networkInterface 
+   * @param {string|Uint8Array|Uint16Array} address 
+   * @param {Subnet} subnet 
+   */
   constructor(networkInterface, address, subnet) {
     this.networkInterface = networkInterface;
     this.address = address;
@@ -34,9 +41,9 @@ export class NetworkAddress {
 }
 
 /**
- * 
- * @param {Iterable<Owner|string>} sources 
- * @param {Object} options 
+ *
+ * @param {Iterable<Owner|string>} sources
+ * @param {Object} options
  * @param {boolean} options.aggregate
  * @param {Object} options.filter
  * @returns {Iterable<string>} addresses
@@ -46,7 +53,7 @@ export function addresses(sources, options) {
     ...new Set(
       [...sources]
         .map(s => {
-          if(typeof s === "string") {
+          if (typeof s === "string") {
             return s;
           }
           if (options?.aggregate && s instanceof Owner && s.subnets) {
@@ -58,11 +65,18 @@ export function addresses(sources, options) {
             : s;
         })
         .flat()
-        .map(object => typeof object === "string" ? object : decodeIP(object.address))
+        .map(object =>
+          typeof object === "string" ? object : decodeIP(object.address)
+        )
     )
   ];
 }
 
+/**
+ * 
+ * @param {Array<NetworkAddress>} networkAddresses 
+ * @returns {Array<string>}
+ */
 export function cidrAddresses(networkAddresses) {
   return [...networkAddresses].map(na => na.cidrAddress);
 }

package/src/network-interfaces/network-interface.mjs

@@ -134,7 +134,9 @@ export class NetworkInterface extends SkeletonNetworkInterface {
 
   get domainNames() {
     return this.hostName
-      ? new Set([[this.hostName, this.host.domain].join(".")])
+      ? this.host.directDomainNames.union(
+          new Set([[this.hostName, this.host.domain].join(".")])
+        )
       : this.host.directDomainNames;
   }
 

package/src/service-types.mjs

@@ -138,6 +138,20 @@ export const ServiceTypes = {
         //  adVF: "0x82"
       }
     }
+  },
+  pcp: {
+    // rfc6887
+    endpoints: [
+      { family: "IPv4", protocol: "udp", port: 5351, tls: false },
+      { family: "IPv6", protocol: "udp", port: 5351, tls: false }
+    ]
+  },
+  "pcp-multicast": {
+    // rfc6887
+    endpoints: [
+      { family: "IPv4", protocol: "udp", port: 5350, tls: false },
+      { family: "IPv6", protocol: "udp", port: 5350, tls: false }
+    ]
   }
 };
 

package/src/services/bind.mjs

@@ -468,21 +468,23 @@ export class BindService extends ExtraSourceService {
               }
 
               for (const domainName of domainNames) {
-                zone.records.add(
-                  DNSRecord(
-                    dnsFullName(domainName),
-                    dnsRecordTypeForAddressFamily(family),
-                    address
-                  )
-                );
-
-                reverseZone.records.add(
-                  DNSRecord(
-                    dnsFullName(reverseArpa(address)),
-                    "PTR",
-                    dnsFullName(domainName)
-                  )
-                );
+                if (domainName[0] != "*") {
+                  zone.records.add(
+                    DNSRecord(
+                      dnsFullName(domainName),
+                      dnsRecordTypeForAddressFamily(family),
+                      address
+                    )
+                  );
+
+                  reverseZone.records.add(
+                    DNSRecord(
+                      dnsFullName(reverseArpa(address)),
+                      "PTR",
+                      dnsFullName(domainName)
+                    )
+                  );
+                }
               }
             }
 

package/src/utils.mjs

@@ -45,6 +45,12 @@ export async function writeLines(dir, name, lines) {
   return writeFile(join(dir, name), data, "utf8");
 }
 
+/**
+ * 
+ * @param {string} sectionName 
+ * @param {Object} values 
+ * @returns {Array<string>}
+ */
 export function sectionLines(sectionName, values) {
   const lines = [`[${sectionName}]`];
 
@@ -59,10 +65,18 @@ export function bridgeToJSON(bridge) {
   return [...bridge].map(n => n.fullName || `(${n})`).sort();
 }
 
+/**
+ * @param {any} value 
+ * @returns {Array<any>}
+ */
 export function asArray(value) {
   return Array.isArray(value) ? value : value === undefined ? [] : [value];
 }
 
+/**
+ * @param {any} value 
+ * @returns {Iterable<any>}
+ */
 export function asIterator(value) {
   switch (typeof value) {
     case "undefined":

package/types/endpoint.d.mts

@@ -15,6 +15,9 @@ export class DomainNameEndpoint extends PortEndpoint {
     get address(): any;
     get isPool(): boolean;
 }
+/**
+ * Endpoint based on http
+ */
 export class HTTPEndpoint extends BaseEndpoint {
     constructor(service: any, address: any, data: any);
     url: URL;
@@ -36,6 +39,9 @@ export class UnixEndpoint extends BaseEndpoint {
     get host(): any;
     get address(): any;
 }
+/**
+ * Endpoint with an ip port
+ */
 declare class PortEndpoint extends BaseEndpoint {
     _port: any;
     protocol: any;

package/types/network-address.d.mts

@@ -10,20 +10,32 @@ export function addresses(sources: Iterable<Owner | string>, options: {
     aggregate: boolean;
     filter: any;
 }): Iterable<string>;
-export function cidrAddresses(networkAddresses: any): any[];
+/**
+ *
+ * @param {Array<NetworkAddress>} networkAddresses
+ * @returns {Array<string>}
+ */
+export function cidrAddresses(networkAddresses: Array<NetworkAddress>): Array<string>;
 export function sortByFamilyAndAddress(a: any, b: any): any;
 /**
  *
  */
 export class NetworkAddress {
-    constructor(networkInterface: any, address: any, subnet: any);
+    /**
+     *
+     * @param {NetworkInterface} networkInterface
+     * @param {string|Uint8Array|Uint16Array} address
+     * @param {Subnet} subnet
+     */
+    constructor(networkInterface: NetworkInterface, address: string | Uint8Array | Uint16Array, subnet: Subnet);
     /** @type {Subnet} */ subnet: Subnet;
     /** @type {NetworkInterface} */ networkInterface: NetworkInterface;
     /** @type {string|Uint8Array|Uint16Array} */ address: string | Uint8Array | Uint16Array;
-    get domainNames(): any;
+    get domainNames(): Set<any>;
     get family(): any;
     get cidrAddress(): any;
     toString(): string;
 }
 import { Owner } from "pmcf";
 import { Subnet } from "./subnet.mjs";
+import { NetworkInterface } from "./network-interfaces/network-interface.mjs";

package/types/service-types.d.mts

@@ -183,4 +183,20 @@ export const ServiceTypes: {
             };
         };
     };
+    pcp: {
+        endpoints: {
+            family: string;
+            protocol: string;
+            port: number;
+            tls: boolean;
+        }[];
+    };
+    "pcp-multicast": {
+        endpoints: {
+            family: string;
+            protocol: string;
+            port: number;
+            tls: boolean;
+        }[];
+    };
 };

package/types/utils.d.mts

@@ -1,7 +1,21 @@
 export function domainName(name: any, defaultDomain: any): any;
 export function domainFromDominName(domainName: any, defaultDomain: any): any;
 export function writeLines(dir: any, name: any, lines: any): Promise<void>;
-export function sectionLines(sectionName: any, values: any): string[];
+/**
+ *
+ * @param {string} sectionName
+ * @param {Object} values
+ * @returns {Array<string>}
+ */
+export function sectionLines(sectionName: string, values: any): Array<string>;
 export function bridgeToJSON(bridge: any): any[];
-export function asArray(value: any): any[];
-export function asIterator(value: any): any;
+/**
+ * @param {any} value
+ * @returns {Array<any>}
+ */
+export function asArray(value: any): Array<any>;
+/**
+ * @param {any} value
+ * @returns {Iterable<any>}
+ */
+export function asIterator(value: any): Iterable<any>;