pmcf 4.19.1 → 4.20.0

package/README.md

@@ -1,6 +1,5 @@
 [![npm](https://img.shields.io/npm/v/pmcf.svg)](https://www.npmjs.com/package/pmcf)
 [![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
-[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)
 [![bundlejs](https://deno.bundlejs.com/?q=pmcf\&badge=detailed)](https://bundlejs.com/?q=pmcf)
 [![downloads](http://img.shields.io/npm/dm/pmcf.svg?style=flat-square)](https://npmjs.org/package/pmcf)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/pmcf.svg?style=flat-square)](https://github.com/arlac77/pmcf/issues)
@@ -27,12 +26,14 @@ generates config packages for:
     *   networkd
     *   timesyncd
     *   resolverd
+    *   journald
 *   kea
 *   bind
 *   mosquitto
 *   influxdb
 *   iwd
 *   chrony
+*   openldap
 
 # API
 
@@ -40,69 +41,77 @@ generates config packages for:
 
 ### Table of Contents
 
-*   [Base](#base)
-    *   [Parameters](#parameters)
-    *   [walkDirections](#walkdirections)
-        *   [Parameters](#parameters-1)
-    *   [extendedAttribute](#extendedattribute)
-        *   [Parameters](#parameters-2)
-    *   [propertyIterator](#propertyiterator)
-        *   [Parameters](#parameters-3)
-    *   [getProperties](#getproperties)
-        *   [Parameters](#parameters-4)
-    *   [priority](#priority)
-    *   [expression](#expression)
-        *   [Parameters](#parameters-5)
-    *   [findService](#findservice)
-        *   [Parameters](#parameters-6)
-    *   [templateContent](#templatecontent)
-        *   [Parameters](#parameters-7)
-    *   [property](#property)
-        *   [Parameters](#parameters-8)
-    *   [expand](#expand)
-        *   [Parameters](#parameters-9)
-*   [PortEndpoint](#portendpoint)
-    *   [Parameters](#parameters-10)
-    *   [port](#port)
-    *   [socketAddress](#socketaddress)
-*   [HTTPEndpoint](#httpendpoint)
-    *   [Parameters](#parameters-11)
-    *   [port](#port-1)
-*   [SkeletonNetworkInterface](#skeletonnetworkinterface)
-    *   [networkAddresses](#networkaddresses)
-        *   [Parameters](#parameters-12)
-*   [SystemdJournalRemoteService](#systemdjournalremoteservice)
-    *   [Properties](#properties)
-    *   [systemdConfigs](#systemdconfigs)
-        *   [Parameters](#parameters-13)
-*   [SystemdJournalUploadService](#systemdjournaluploadservice)
-    *   [Properties](#properties-1)
-    *   [systemdConfigs](#systemdconfigs-1)
-        *   [Parameters](#parameters-14)
-*   [NetworkAddress](#networkaddress)
-    *   [Parameters](#parameters-15)
-    *   [subnet](#subnet)
-    *   [networkInterface](#networkinterface)
-    *   [address](#address)
-*   [addresses](#addresses)
-    *   [Parameters](#parameters-16)
-*   [cidrAddresses](#cidraddresses)
-    *   [Parameters](#parameters-17)
-*   [isTemplate](#istemplate)
-*   [named](#named)
-    *   [Parameters](#parameters-18)
-*   [serviceEndpoints](#serviceendpoints)
-    *   [Parameters](#parameters-19)
-*   [domainName](#domainname)
-    *   [Parameters](#parameters-20)
-*   [domainFromDominName](#domainfromdominname)
-    *   [Parameters](#parameters-21)
-*   [sectionLines](#sectionlines)
-    *   [Parameters](#parameters-22)
-*   [asArray](#asarray)
-    *   [Parameters](#parameters-23)
-*   [asIterator](#asiterator)
-    *   [Parameters](#parameters-24)
+- [pmcf](#pmcf)
+  - [Poor mans configuration management](#poor-mans-configuration-management)
+- [API](#api)
+    - [Table of Contents](#table-of-contents)
+  - [Base](#base)
+    - [Parameters](#parameters)
+    - [walkDirections](#walkdirections)
+      - [Parameters](#parameters-1)
+    - [extendedAttribute](#extendedattribute)
+      - [Parameters](#parameters-2)
+    - [propertyIterator](#propertyiterator)
+      - [Parameters](#parameters-3)
+    - [getProperties](#getproperties)
+      - [Parameters](#parameters-4)
+    - [priority](#priority)
+    - [expression](#expression)
+      - [Parameters](#parameters-5)
+    - [templateContent](#templatecontent)
+      - [Parameters](#parameters-6)
+    - [isTemplate](#istemplate)
+    - [property](#property)
+      - [Parameters](#parameters-7)
+    - [expand](#expand)
+      - [Parameters](#parameters-8)
+  - [PortEndpoint](#portendpoint)
+    - [Parameters](#parameters-9)
+    - [port](#port)
+    - [socketAddress](#socketaddress)
+  - [HTTPEndpoint](#httpendpoint)
+    - [Parameters](#parameters-10)
+    - [port](#port-1)
+  - [id](#id)
+  - [SkeletonNetworkInterface](#skeletonnetworkinterface)
+    - [networkAddresses](#networkaddresses)
+      - [Parameters](#parameters-11)
+  - [InitializationContext](#initializationcontext)
+    - [Parameters](#parameters-12)
+  - [SystemdJournalRemoteService](#systemdjournalremoteservice)
+    - [Properties](#properties)
+    - [systemdConfigs](#systemdconfigs)
+      - [Parameters](#parameters-13)
+  - [SystemdJournalUploadService](#systemdjournaluploadservice)
+    - [Properties](#properties-1)
+    - [systemdConfigs](#systemdconfigs-1)
+      - [Parameters](#parameters-14)
+  - [NetworkAddress](#networkaddress)
+    - [Parameters](#parameters-15)
+    - [subnet](#subnet)
+    - [networkInterface](#networkinterface)
+    - [address](#address)
+  - [addresses](#addresses)
+    - [Parameters](#parameters-16)
+  - [cidrAddresses](#cidraddresses)
+    - [Parameters](#parameters-17)
+  - [secretName](#secretname)
+  - [isTemplate](#istemplate-1)
+  - [named](#named)
+    - [Parameters](#parameters-18)
+  - [serviceEndpoints](#serviceendpoints)
+    - [Parameters](#parameters-19)
+  - [domainName](#domainname)
+    - [Parameters](#parameters-20)
+  - [domainFromDominName](#domainfromdominname)
+    - [Parameters](#parameters-21)
+  - [sectionLines](#sectionlines)
+    - [Parameters](#parameters-22)
+  - [asArray](#asarray)
+    - [Parameters](#parameters-23)
+  - [asIterator](#asiterator)
+    - [Parameters](#parameters-24)
+- [install](#install)
 
 ## Base
 
@@ -165,14 +174,6 @@ Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 Returns **any** 
 
-### findService
-
-#### Parameters
-
-*   `filter` **any** 
-
-Returns **any** service with the highest priority
-
 ### templateContent
 
 #### Parameters
@@ -182,6 +183,10 @@ Returns **any** service with the highest priority
 
 Returns **AsyncIterable\<ContentProvider>**&#x20;
 
+### isTemplate
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+
 ### property
 
 #### Parameters
@@ -233,6 +238,10 @@ Endpoint based on http
 
 Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
 
+## id
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
 ## SkeletonNetworkInterface
 
 **Extends ServiceOwner**
@@ -245,6 +254,14 @@ Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 Returns **Iterable<[NetworkAddress](#networkaddress)>**&#x20;
 
+## InitializationContext
+
+Keeps track of all in flight object creations and loose ends during config initialization.
+
+### Parameters
+
+*   `directory`   (optional, default `"/"`)
+
 ## SystemdJournalRemoteService
 
 **Extends Service**
@@ -320,6 +337,10 @@ Returns **Iterable<[string](https://developer.mozilla.org/docs/Web/JavaScript/Re
 
 Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**&#x20;
 
+## secretName
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
 ## isTemplate
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;

package/bin/pmcf-diagram

@@ -46,7 +46,7 @@ for await (const network of location.networks) {
   }
 }
 
-for await (const cluster of location.clusters()) {
+for await (const cluster of location.clusters) {
   console.log(`  subgraph cluster_${cluster.name} {`);
 
   for (const ni of cluster.members) {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "pmcf",
-  "version": "4.19.1",
+  "version": "4.20.0",
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "npm@11.10.0+sha512.8bc844e37892200305b98562f13c6c10849d10b3387c8cdaeb4d1a2e32746a79063cba9dd284cf28c26a01c3bf4169b7d3b31b4a5586cc970d6749463108073c",
+  "packageManager": "npm@11.13.0",
   "exports": {
     ".": {
       "default": "./src/module.mjs"
@@ -42,33 +42,34 @@
     "pmcf-package": "./bin/pmcf-package"
   },
   "scripts": {
-    "prepare": "node --run prepare:typescript",
-    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "node --run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src**/*.mjs",
-    "lint": "node --run lint:docs && node --run lint:typescript",
-    "lint:docs": "documentation lint ./src**/*.mjs",
-    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint": "node --run lint:docs",
+    "lint:docs": "documentation lint ./src**/*.mjs"
   },
   "dependencies": {
-    "content-entry-transform": "^1.6.4",
-    "ip-utilties": "^3.0.0",
-    "npm-pkgbuild": "^20.6.3",
-    "pacc": "^9.0.0",
+    "content-entry-transform": "^1.6.9",
+    "ip-utilties": "^3.0.4",
+    "npm-pkgbuild": "^20.6.4",
+    "pacc": "^9.2.9",
     "package-directory": "^8.2.0"
   },
   "devDependencies": {
-    "@types/node": "^25.2.3",
-    "ava": "^6.4.1",
-    "c8": "^10.1.3",
+    "@types/node": "^25.9.1",
+    "ava": "^8.0.1",
+    "c8": "^11.0.0",
     "documentation": "^14.0.3",
-    "semantic-release": "^25.0.3",
-    "typescript": "^5.9.3"
+    "semantic-release": "^25.0.3"
+  },
+  "overrides": {
+    "c8": {
+      "yargs": "^18.0.0"
+    }
   },
   "engines": {
-    "node": ">=24.13.1"
+    "node": ">=26.2.0"
   },
   "repository": {
     "type": "git",
@@ -81,8 +82,7 @@
   "template": {
     "inheritFrom": [
       "arlac77/template-arlac77-github",
-      "arlac77/template-node-app",
-      "arlac77/template-typescript"
+      "arlac77/template-node-app"
     ]
   }
 }

package/src/base.mjs

@@ -8,8 +8,6 @@ import {
 import { FileContentProvider } from "npm-pkgbuild";
 import {
   getAttribute,
-  toInternal,
-  typeFactory,
   addType,
   parse,
   globals,
@@ -26,7 +24,7 @@ import {
   description_attribute_writable,
   boolean_attribute_writable
 } from "pacc";
-import { asArray, union } from "./utils.mjs";
+import { union } from "./utils.mjs";
 
 /**
  *
@@ -36,6 +34,7 @@ import { asArray, union } from "./utils.mjs";
 export class Base {
   static name = "base";
   static key = "name";
+  static priority = 0;
   static attributes = {
     owner: { ...default_attribute, type: "base" },
     type: string_attribute,
@@ -48,15 +47,7 @@ export class Base {
     tags: string_set_attribute_writable
   };
 
-  owner;
-  description;
-  name;
-  extends = [];
-  _tags = new Set();
-  _packaging = new Set();
-  _directory;
-  _finalize;
-  _properties;
+  static typeDefinition = this;
 
   static {
     addType(this);
@@ -66,14 +57,20 @@ export class Base {
     return this.typeDefinition.name;
   }
 
-  static get typeDefinition() {
-    return this;
-  }
-
   static get typeFileName() {
     return this.typeName + ".json";
   }
 
+  owner;
+  description;
+  name;
+  extends = [];
+  _tags = new Set();
+  _packaging = new Set();
+  _directory;
+  _finalize;
+  _properties = {};
+
   /**
    *
    * @param {Base} owner
@@ -86,8 +83,6 @@ export class Base {
       case "string":
         this.name = data;
         break;
-      case "object":
-        this.read(data, this.constructor);
     }
   }
 
@@ -110,207 +105,7 @@ export class Base {
     return this;
   }
 
-  read(data, type = this.constructor.typeDefinition) {
-    if (type.extends) {
-      this.read(data, type.extends);
-    }
-
-    const assign = (name, attribute, value) => {
-      value = toInternal(value, attribute);
-      value ??= attribute.default;
-
-      if (value !== undefined) {
-        if (attribute.values) {
-          if (attribute.values.indexOf(value) < 0) {
-            this.error(name, "unknown value", value, attribute.values);
-          }
-        }
-
-        if (attribute.collection) {
-          const current = this[name];
-
-          switch (typeof current) {
-            case "undefined":
-              if (attribute.constructor === value.constructor) {
-                this[name] = value;
-              } else {
-                this[name] = asArray(value);
-              }
-              break;
-            case "object":
-              if (Array.isArray(current)) {
-                if (Array.isArray(value)) {
-                  current.push(...value);
-                } else {
-                  current.push(value);
-                }
-              } else {
-                if (current instanceof Set) {
-                  if (value instanceof Set) {
-                    this[name] = current.union(value);
-                  } else {
-                    this[name].add(value);
-                  }
-                } else if (current instanceof Map) {
-                  const keyName = attribute.type.key;
-                  if (keyName) {
-                    current.set(value[keyName], value);
-                  } else {
-                    // TODO
-                    this[name] = value;
-                  }
-                } else {
-                  const keyName = attribute.type.key;
-                  this[name][value[keyName]] = value;
-                }
-              }
-              break;
-            case "function":
-              if (value instanceof Base) {
-                this.addObject(value);
-              } else {
-                this.error("Unknown collection type", name, current);
-              }
-              break;
-          }
-        } else {
-          this[name] = value;
-        }
-      }
-    };
-
-    const instantiateAndAssign = (name, attribute, value) => {
-      if (attribute.type.primitive) {
-        assign(name, attribute, value);
-        return;
-      }
-
-      switch (typeof value) {
-        case "undefined":
-          return;
-        case "function":
-          this.error("Invalid value", name, value);
-          break;
-
-        case "boolean":
-        case "bigint":
-        case "number":
-        case "string":
-          {
-            let object;
-
-            for (const type of attribute.type.members || [attribute.type]) {
-              object = this.typeNamed(type.name, value);
-              if (object) {
-                break;
-              }
-            }
-
-            if (object) {
-              assign(name, attribute, object);
-            } else {
-              if (attribute.type.constructWithIdentifierOnly) {
-                object = new attribute.type.clazz(
-                  this.ownerFor(attribute, value),
-                  value
-                );
-                object.read(value);
-                this.addObject(object);
-              } else {
-                this.finalize(() => {
-                  value = this.expand(value);
-
-                  for (const type of attribute.type.members || [
-                    attribute.type
-                  ]) {
-                    const object =
-                      this.typeNamed(type.name, value) ||
-                      this.owner.typeNamed(type.name, value) ||
-                      this.root.typeNamed(type.name, value); // TODO
-
-                    if (object) {
-                      assign(name, attribute, object);
-                      return;
-                    }
-                  }
-
-                  this.error(
-                    `No such object "${value}" (${attribute.type.name}) for attribute ${name}`,
-                    this.root.named(value)?.toString()
-                  );
-                });
-              }
-            }
-          }
-          break;
-        case "object":
-          if (attribute.type.clazz && value instanceof attribute.type.clazz) {
-            assign(name, attribute, value);
-          } else {
-            assign(
-              name,
-              attribute,
-              typeFactory(
-                attribute.type,
-                this.ownerFor(attribute, value),
-                value
-              )
-            );
-          }
-          break;
-      }
-    };
-
-    if (data?.properties) {
-      this._properties = data.properties;
-    }
-
-    for (const [path, attribute] of attributeIterator(type.attributes)) {
-      if (attribute.writable) {
-        const name = path.join(".");
-        const value = this.expand(data[name]);
-
-        if (attribute.collection) {
-          if (typeof value === "object") {
-            if (Array.isArray(value)) {
-              for (const v of value) {
-                instantiateAndAssign(name, attribute, v);
-              }
-            } else {
-              if (value instanceof Base) {
-                assign(name, attribute, value);
-              } else {
-                for (const [objectName, objectData] of Object.entries(value)) {
-                  if (typeof objectData === "object") {
-                    //console.log("KEY", objectName, type.name, type.key);
-                    objectData[attribute.type.key] = objectName;
-                  }
-                  instantiateAndAssign(name, attribute, objectData);
-                }
-              }
-            }
-            continue;
-          }
-        }
-        instantiateAndAssign(name, attribute, value);
-      }
-    }
-
-    if (data?.extends) {
-      this.finalize(() => {
-        for (const object of this.extends) {
-          object.execFinalize();
-          this._applyExtends(object);
-        }
-      });
-    }
-
-    /*if(this.type) {
-      console.log(this.toString(),this.name,this.fullName);
-    }*/
-  }
-
-  _applyExtends() {}
+  materializeExtends() {}
 
   named(name) {}
 
@@ -498,7 +293,7 @@ export class Base {
   }
 
   get smtp() {
-    return this.findService('in("smtp",types)');
+    return this.expression("services[types[smtp]][0]");
   }
 
   /**
@@ -515,24 +310,13 @@ export class Base {
     });
   }
 
-  /**
-   *
-   * @param {any} filter
-   * @returns service with the highest priority
-   */
-  findService(filter) {
-    let best;
-    for (const service of this.findServices(filter)) {
-      if (!best || service.priority > best.priority) {
-        best = service;
-      }
-    }
-
-    return best;
+  get services() {
+    return this.owner?.services || [];
   }
 
-  *findServices(filter) {
-    yield* this.owner?.findServices(filter);
+  // TODO get rid of
+  get aggregatedServices() {
+    return this.services;
   }
 
   set directory(directory) {
@@ -630,13 +414,16 @@ export class Base {
   }
 
   get tags() {
-    return this._tags;
+    return this.extends.reduce((a, c) => a.union(c.tags), this._tags);
   }
 
   set tags(value) {
     this._tags = union(value, this._tags);
   }
 
+  /**
+   * @return {boolean}
+   */
   get isTemplate() {
     return this.name?.indexOf("*") >= 0 || this.owner?.isTemplate || false;
   }

package/src/cli.mjs

@@ -1,6 +1,6 @@
 import { parseArgs } from "node:util";
 import { argv, cwd, env } from "node:process";
-import { Root } from "./module.mjs";
+import { InitializationContext } from "./module.mjs";
 
 export async function prepare(options = {}) {
   const { values, positionals } = parseArgs({
@@ -25,9 +25,9 @@ export async function prepare(options = {}) {
     allowPositionals: true
   });
 
-  const root = new Root(values.root);
+  const ic = new InitializationContext(values.root);
 
-  await root.loadAll();
+  await ic.loadAll();
 
-  return { root, options: values, args: positionals };
+  return { ic, root: ic.root, options: values, args: positionals };
 }