pmcf 1.19.0 → 1.21.0

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "pmcf",
-  "version": "1.19.0",
+  "version": "1.21.0",
   "publishConfig": {
     "access": "public"
   },
   "exports": {
     ".": {
-      "default": "./src/model.mjs"
+      "default": "./src/module.mjs"
     }
   },
   "description": "Poor mans configuration management",
@@ -40,7 +40,7 @@
     "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "devDependencies": {
-    "@types/node": "^22.10.9",
+    "@types/node": "^22.10.10",
     "ava": "^6.2.0",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",

package/src/base.mjs

@@ -0,0 +1,169 @@
+import { join } from "node:path";
+import { getAttribute } from "pacc";
+
+export class Base {
+  owner;
+  name;
+  description;
+
+  static get typeName() {
+    return "base";
+  }
+
+  static get typeFileName() {
+    return this.typeName + ".json";
+  }
+
+  static get fileNameGlob() {
+    return "**/" + this.typeFileName;
+  }
+
+  static async prepareData(world, data) {
+    return this;
+  }
+
+  static baseName(name) {
+    if (!name) {
+      return undefined;
+    }
+
+    return name.replace(/\/\w+\.json$/, "");
+  }
+
+  constructor(owner, data) {
+    this.owner = owner;
+
+    if (data) {
+      this.name = data.name;
+      if (data.description) {
+        this.description = data.description;
+      }
+    }
+  }
+
+  withOwner(owner) {
+    if (this.owner !== owner) {
+      return new this.constructor(owner, this);
+    }
+
+    return this;
+  }
+
+  get typeName() {
+    return this.constructor.typeName;
+  }
+
+  get world() {
+    return this.owner.world;
+  }
+
+  get location() {
+    return this.owner.location;
+  }
+
+  get host() {
+    return this.owner.host;
+  }
+
+  async network(name) {
+    return this.owner.network(name);
+  }
+
+  #directory;
+  set directory(directory) {
+    this.#directory = directory;
+  }
+
+  get directory() {
+    return this.#directory || join(this.owner.directory, this.name);
+  }
+
+  get fullName() {
+    return this.owner?.fullName
+      ? join(this.owner.fullName, this.name)
+      : this.name;
+  }
+
+  expand(object) {
+    switch (typeof object) {
+      case "string":
+        return object.replaceAll(/\$\{([^\}]*)\}/g, (match, m1) => {
+          return getAttribute(this, m1) || "${" + m1 + "}";
+        });
+
+      case "object":
+        if (Array.isArray(object)) {
+          return object.map(e => this.expand(e));
+        }
+
+        if (object instanceof Set) {
+          return new Set([...object].map(e => this.expand(e)));
+        }
+
+      /*return Object.fromEntries(
+          Object.entries(object).map(([k, v]) => [k, this.expand(v)])
+        );*/
+    }
+
+    return object;
+  }
+
+  #finalize;
+
+  finalize(action) {
+    if (!this.#finalize) {
+      this.#finalize = [];
+    }
+    this.#finalize.push(action);
+  }
+
+  execFinalize() {
+    if (this.#finalize) {
+      //this.info("finalize");
+      let i = 0;
+      for (const action of this.#finalize) {
+        if (action) {
+          this.#finalize[i] = undefined;
+          action();
+        }
+        i++;
+      }
+    }
+  }
+
+  error(...args) {
+    console.error(`${this.toString()}:`, ...args);
+  }
+
+  info(...args) {
+    console.info(`${this.toString()}:`, ...args);
+  }
+
+  toString() {
+    return `${this.fullName}(${this.typeName})`;
+  }
+
+  get propertyNames() {
+    return ["name", "description", "directory", "owner"];
+  }
+
+  toJSON() {
+    return extractFrom(this, this.propertyNames);
+  }
+}
+
+export function extractFrom(object, propertyNames) {
+  const json = {};
+  for (const p of propertyNames) {
+    const value = object[p];
+
+    if (value !== undefined) {
+      if (value instanceof Base && value.name) {
+        json[p] = { name: value.name };
+      } else {
+        json[p] = value;
+      }
+    }
+  }
+  return json;
+}

package/src/dns.mjs

@@ -0,0 +1,32 @@
+import { Base } from "./base.mjs";
+import { asArray } from "./utils.mjs";
+
+export class DNSService extends Base {
+  allowedUpdates = [];
+  recordTTL = "1W";
+  forwardsTo = [];
+
+  static get typeName() {
+    return "dns";
+  }
+
+  constructor(owner, data) {
+    super(owner, data);
+    Object.assign(this, data);
+  }
+
+  async *services() {
+    const filter = { type: "dns" };
+
+    yield* this.owner.services(filter);
+
+    for (const s of asArray(this.forwardsTo)) {
+      const owner = await this.owner.world.load(s);
+      yield* owner.services(filter);
+    }
+  }
+
+  get propertyNames() {
+    return ["recordTTL", "forwardsTo", "allowedUpdates"];
+  }
+}

package/src/model.mjs

@@ -1,139 +1,8 @@
 import { readFile, glob } from "node:fs/promises";
 import { join } from "node:path";
-import { getAttribute } from "pacc";
 import { asArray, bridgeToJSON } from "./utils.mjs";
-
-export class Base {
-  owner;
-  name;
-  description;
-
-  static get typeName() {
-    return "base";
-  }
-
-  static get typeFileName() {
-    return this.typeName + ".json";
-  }
-
-  static get fileNameGlob() {
-    return "**/" + this.typeFileName;
-  }
-
-  static async prepareData(world, data) {
-    return this;
-  }
-
-  static baseName(name) {
-    if (!name) {
-      return undefined;
-    }
-
-    return name.replace(/\/\w+\.json$/, "");
-  }
-
-  constructor(owner, data) {
-    this.owner = owner;
-
-    if (data) {
-      this.name = data.name;
-      if (data.description) {
-        this.description = data.description;
-      }
-    }
-  }
-
-  withOwner(owner) {
-    if (this.owner !== owner) {
-      return new this.constructor(owner, this);
-    }
-
-    return this;
-  }
-
-  get typeName() {
-    return this.constructor.typeName;
-  }
-
-  get world() {
-    return this.owner.world;
-  }
-
-  get location() {
-    if (this instanceof Location) {
-      return this;
-    }
-    return this.owner.location;
-  }
-
-  get host() {
-    if (this instanceof Host) {
-      return this;
-    }
-    return this.owner.host;
-  }
-
-  async network(name) {
-    return this.owner.network(name);
-  }
-
-  #directory;
-  set directory(directory) {
-    this.#directory = directory;
-  }
-
-  get directory() {
-    return this.#directory || join(this.owner.directory, this.name);
-  }
-
-  get fullName() {
-    return this.owner ? join(this.owner.fullName, this.name) : this.name;
-  }
-
-  expand(object) {
-    switch (typeof object) {
-      case "string":
-        return object.replaceAll(/\$\{([^\}]*)\}/g, (match, m1) => {
-          return getAttribute(this, m1) || "${" + m1 + "}";
-        });
-
-      case "object":
-        if (Array.isArray(object)) {
-          return object.map(e => this.expand(e));
-        }
-
-        if (object instanceof Set) {
-          return new Set([...object].map(e => this.expand(e)));
-        }
-
-      /*return Object.fromEntries(
-          Object.entries(object).map(([k, v]) => [k, this.expand(v)])
-        );*/
-    }
-
-    return object;
-  }
-
-  error(...args) {
-    console.error(`${this.toString()}:`, ...args);
-  }
-
-  info(...args) {
-    console.info(`${this.toString()}:`, ...args);
-  }
-
-  toString() {
-    return `${this.fullName}(${this.typeName})`;
-  }
-
-  get propertyNames() {
-    return ["name", "description", "directory", "owner"];
-  }
-
-  toJSON() {
-    return extractFrom(this, this.propertyNames);
-  }
-}
+import { Base } from "./base.mjs";
+import { DNSService } from "./dns.mjs";
 
 export class Owner extends Base {
   #hosts = new Map();
@@ -166,6 +35,18 @@ export class Owner extends Base {
       }
     }
     Object.assign(this, data);
+
+    this.finalize(() => {
+      for (const network of this.#networks.values()) {
+        network.execFinalize();
+      }
+    });
+
+    this.finalize(() => {
+      for (const host of this.#hosts.values()) {
+        host.execFinalize();
+      }
+    });
   }
 
   get dns() {
@@ -248,7 +129,7 @@ export class Owner extends Base {
           other.bridge = bridge;
         } else {
           bridge.add(name);
-          this.resolveLater(() => this._resolveBridges());
+          this.finalize(() => this._resolveBridges());
         }
       }
 
@@ -284,18 +165,6 @@ export class Owner extends Base {
     }
   }
 
-  #resolveActions = [];
-
-  resolveLater(action) {
-    this.#resolveActions.push(action);
-  }
-
-  resolve() {
-    for (const action of this.#resolveActions) {
-      action();
-    }
-  }
-
   addSubnet(subnet) {
     this.#subnets.set(subnet.name, subnet);
   }
@@ -414,6 +283,8 @@ export class World extends Owner {
         await this.load(name, { type });
       }
     }
+
+    this.execFinalize();
   }
 
   addObject(object) {
@@ -460,41 +331,15 @@ export class World extends Owner {
   }
 }
 
-class DNSService extends Base {
-  allowedUpdates = [];
-  recordTTL = "1W";
-  forwardsTo = [];
-
-  static get typeName() {
-    return "dns";
-  }
-
-  constructor(owner, data) {
-    super(owner, data);
-    Object.assign(this, data);
-  }
-
-  async *services() {
-    const filter = { type: "dns" };
-
-    yield* this.owner.services(filter);
-
-    for (const s of asArray(this.forwardsTo)) {
-      const owner = await this.owner.world.load(s);
-      yield* owner.services(filter);
-    }
-  }
-
-  get propertyNames() {
-    return ["recordTTL", "forwardsTo", "allowedUpdates"];
-  }
-}
-
 export class Location extends Owner {
   static get typeName() {
     return "location";
   }
 
+  get location() {
+    return this;
+  }
+
   async *hosts() {
     for await (const host of this.owner.hosts()) {
       if (host.location === this) {
@@ -676,6 +521,12 @@ export class Host extends Base {
     }
 
     owner.addHost(this);
+
+    this.finalize(() => {
+      for (const ni of Object.values(this.networkInterfaces)) {
+        ni.execFinalize();
+      }
+    });
   }
 
   get deployment() {
@@ -757,6 +608,10 @@ export class Host extends Base {
     return this.hostName + "." + this.domain;
   }
 
+  get host() {
+    return this;
+  }
+
   addService(service) {
     this.#services.push(service);
   }
@@ -777,7 +632,7 @@ export class Host extends Base {
   addNetworkInterface(networkInterface) {
     this.networkInterfaces[networkInterface.name] = networkInterface;
 
-    if(networkInterface.network) {
+    if (networkInterface.network) {
       networkInterface.network.addHost(this);
     }
   }
@@ -841,9 +696,9 @@ export class NetworkInterface extends Base {
   #metric;
   #ssid;
   #psk;
+  #network;
   arpbridge;
   hwaddr;
-  network;
 
   constructor(owner, data) {
     super(owner, data);
@@ -866,18 +721,20 @@ export class NetworkInterface extends Base {
     }
 
     if (data.network) {
-      const network = owner.owner.network(data.network);
+      let network = owner.owner.network(data.network);
 
       if (network) {
-        data.network = network;
+        this.network = network;
       } else {
-        this.error("Missing network", data.network);
+        network = data.network;
+        this.finalize(() => (this.network = network));
       }
+
+      delete data.network;
+    } else if (owner.owner instanceof Network) {
+      this.network = owner.owner;
     }
-    else if(owner.owner instanceof Network) {
-      data.network = owner.owner;
-    }
-    
+
     Object.assign(this, data);
 
     owner.addNetworkInterface(this);
@@ -885,6 +742,25 @@ export class NetworkInterface extends Base {
     //this.arpbridge = owner.addARPBridge(this, data.arpbridge);
   }
 
+  get network() {
+    return this.#network;
+  }
+
+  set network(networkOrName) {
+    if (!(networkOrName instanceof Network)) {
+      let network = this.owner.owner.network(networkOrName);
+
+      if (network) {
+        this.#network = network;
+        return;
+      } else {
+        this.error("Unknown network", networkOrName);
+      }
+    }
+
+    this.#network = networkOrName;
+  }
+
   get host() {
     return this.owner;
   }
@@ -1070,19 +946,3 @@ export class Service extends Base {
 
 const _types = [Location, Network, Subnet, Host, Service, DNSService];
 const _typesByName = Object.fromEntries(_types.map(t => [t.typeName, t]));
-
-export function extractFrom(object, propertyNames) {
-  const json = {};
-  for (const p of propertyNames) {
-    const value = object[p];
-
-    if (value !== undefined) {
-      if (value instanceof Base && value.name) {
-        json[p] = { name: value.name };
-      } else {
-        json[p] = value;
-      }
-    }
-  }
-  return json;
-}

package/src/module.mjs

@@ -0,0 +1,3 @@
+export * from "./base.mjs";
+export * from "./dns.mjs";
+export * from "./model.mjs";

package/types/base.d.mts

@@ -0,0 +1,30 @@
+export function extractFrom(object: any, propertyNames: any): {};
+export class Base {
+    static get typeName(): string;
+    static get typeFileName(): string;
+    static get fileNameGlob(): string;
+    static prepareData(world: any, data: any): Promise<typeof Base>;
+    static baseName(name: any): any;
+    constructor(owner: any, data: any);
+    owner: any;
+    name: any;
+    description: any;
+    withOwner(owner: any): any;
+    get typeName(): any;
+    get world(): any;
+    get location(): any;
+    get host(): any;
+    network(name: any): Promise<any>;
+    set directory(directory: any);
+    get directory(): any;
+    get fullName(): any;
+    expand(object: any): any;
+    finalize(action: any): void;
+    execFinalize(): void;
+    error(...args: any[]): void;
+    info(...args: any[]): void;
+    toString(): string;
+    get propertyNames(): string[];
+    toJSON(): {};
+    #private;
+}

package/types/dns.d.mts

@@ -0,0 +1,7 @@
+export class DNSService extends Base {
+    allowedUpdates: any[];
+    recordTTL: string;
+    forwardsTo: any[];
+    services(): AsyncGenerator<any, void, any>;
+}
+import { Base } from "./base.mjs";

package/types/model.d.mts

@@ -1,31 +1,3 @@
-export function extractFrom(object: any, propertyNames: any): {};
-export class Base {
-    static get typeName(): string;
-    static get typeFileName(): string;
-    static get fileNameGlob(): string;
-    static prepareData(world: any, data: any): Promise<typeof Base>;
-    static baseName(name: any): any;
-    constructor(owner: any, data: any);
-    owner: any;
-    name: any;
-    description: any;
-    withOwner(owner: any): any;
-    get typeName(): any;
-    get world(): any;
-    get location(): any;
-    get host(): any;
-    network(name: any): Promise<any>;
-    set directory(directory: any);
-    get directory(): any;
-    get fullName(): any;
-    expand(object: any): any;
-    error(...args: any[]): void;
-    info(...args: any[]): void;
-    toString(): string;
-    get propertyNames(): string[];
-    toJSON(): {};
-    #private;
-}
 export class Owner extends Base {
     domain: any;
     ntp: {
@@ -43,8 +15,6 @@ export class Owner extends Base {
     addBridge(network: any, destinationNetworks: any): any;
     _resolveBridges(): void;
     networkAddresses(): AsyncGenerator<any, void, unknown>;
-    resolveLater(action: any): void;
-    resolve(): void;
     addSubnet(subnet: any): void;
     subnet(name: any): any;
     subnets(): MapIterator<any>;
@@ -59,7 +29,7 @@ export class Owner extends Base {
 }
 export class World extends Owner {
     static get types(): {
-        [k: string]: typeof Location | typeof Host | typeof DNSService | typeof Network | typeof Subnet | typeof Service;
+        [k: string]: typeof DNSService | typeof Network | typeof Host | typeof Location | typeof Subnet | typeof Service;
     };
     constructor(directory: any);
     get fullName(): string;
@@ -75,6 +45,7 @@ export class World extends Owner {
     #private;
 }
 export class Location extends Owner {
+    get location(): this;
 }
 export class Network extends Owner {
     kind: any;
@@ -107,6 +78,7 @@ export class Host extends Base {
     get modelName(): any;
     get hostName(): any;
     get domainName(): string;
+    get host(): this;
     addService(service: any): void;
     services(filter: any): Generator<any, void, unknown>;
     addNetworkInterface(networkInterface: any): void;
@@ -126,7 +98,8 @@ export class Host extends Base {
 export class NetworkInterface extends Base {
     arpbridge: any;
     hwaddr: any;
-    network: any;
+    set network(networkOrName: any);
+    get network(): any;
     get scope(): any;
     get metric(): any;
     get ssid(): any;
@@ -149,10 +122,5 @@ export class Service extends Base {
     get type(): any;
     #private;
 }
-declare class DNSService extends Base {
-    allowedUpdates: any[];
-    recordTTL: string;
-    forwardsTo: any[];
-    services(): AsyncGenerator<any, void, any>;
-}
-export {};
+import { Base } from "./base.mjs";
+import { DNSService } from "./dns.mjs";

package/types/module.d.mts

@@ -0,0 +1,3 @@
+export * from "./base.mjs";
+export * from "./dns.mjs";
+export * from "./model.mjs";