pmcf 1.2.2 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmcf",
-  "version": "1.2.2",
+  "version": "1.4.0",
   "publishConfig": {
     "access": "public"
   },
@@ -23,21 +23,21 @@
   "license": "0BSD",
   "bin": {
     "pmcf-host-defs": "./bin/pmcf-host-defs",
+    "pmcf-info": "./bin/pmcf-info",
     "pmcf-location-defs": "./bin/pmcf-location-defs",
     "pmcf-named-defs": "./bin/pmcf-named-defs",
-    "pmcf-info": "./bin/pmcf-info",
     "pmcf-network": "./bin/pmcf-network"
   },
   "scripts": {
     "prepare": "node --run prepare:typescript",
-    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target es2024 --lib 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 es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "devDependencies": {
     "@types/node": "^22.10.7",

package/src/model.mjs

@@ -18,7 +18,7 @@ export class Base {
     return "**/" + this.typeFileName;
   }
 
-  static refinedType(data) {
+  static async prepareData(world, data) {
     return this;
   }
 
@@ -96,13 +96,12 @@ export class Base {
     return this.typeName + ":" + this.owner.name + "/" + this.name;
   }
 
+  get propertyNames() {
+    return ["name", "description", "directory", "owner"];
+  }
+
   toJSON() {
-    return {
-      name: this.name,
-      directory: this.directory,
-      owner: this.owner.name,
-      description: this.description
-    };
+    return extractFrom(this, this.propertyNames);
   }
 }
 
@@ -122,23 +121,35 @@ export class World {
     return "";
   }
 
+  async _loadType(name, type) {
+    const baseName = type.baseName(name);
+
+    let object = this.#byName.get(baseName);
+
+    if (!object) {
+      const data = JSON.parse(
+        await readFile(
+          join(this.directory, baseName, type.typeFileName),
+          "utf8"
+        )
+      );
+
+      data.name = baseName;
+
+      type = await type.prepareData(this, data);
+      object = new type(this, data);
+      this.#byName.set(data.name, object);
+    }
+
+    return object;
+  }
+
   async load() {
     for (let type of Object.values(World.types)) {
       for await (const name of glob(type.fileNameGlob, {
         cwd: this.directory
       })) {
-        const baseName = type.baseName(name);
-        if (!this.#byName.get(baseName)) {
-          const data = JSON.parse(
-            await readFile(join(this.directory, name), "utf8")
-          );
-
-          data.name = baseName;
-
-          type = type.refinedType(data);
-          const object = new type(this, data);
-          this.#byName.set(data.name, object);
-        }
+        await this._loadType(name, type);
       }
     }
   }
@@ -175,34 +186,11 @@ export class World {
   }
 
   async location(name) {
-    await this.load();
-    return this.#byName.get(Location.baseName(name));
+    return this._loadType(name, Location);
   }
 
   async host(name) {
-    await this.load();
-    return this.#byName.get(Host.baseName(name));
-    /*
-    if (!data.name) {
-      data.name = name;
-    } else {
-      name = data.name;
-    }
-
-    if (!data.location) {
-      const parts = name.split(/\//);
-
-      if (parts.length > 1 && parts[0] !== "services" && parts[0] !== "model") {
-        data.location = parts[0];
-      }
-    }
-
-    data.location = await this.location(data.location);
-
-    if (data.extends) {
-      data.extends = await Promise.all(data.extends.map(e => this.host(e)));
-    }
-    */
+    return this._loadType(name, Host);
   }
 
   async *subnets() {
@@ -238,7 +226,15 @@ export class Host extends Base {
     return "host";
   }
 
-  static refinedType(data) {
+  static async prepareData(world, data) {
+    if (data.location) {
+      data.location = await world.location(data.location);
+    }
+
+    if (data.extends) {
+      data.extends = await Promise.all(data.extends.map(e => world.host(e)));
+    }
+
     if (data.name?.indexOf("model/") >= 0) {
       return Model;
     }
@@ -388,24 +384,24 @@ export class Host extends Base {
     return readFile(join(this.directory, `ssh_host_${type}_key.pub`), "utf8");
   }
 
+  get propertyNames() {
+    return [
+      ...super.propertyNames,
+      "os",
+      "distribution",
+      "deployment",
+      "master",
+      "location",
+      "model",
+      "replaces",
+      "depends",
+      "networkInterfaces"
+    ];
+  }
+
   toJSON() {
     return {
       ...super.toJSON(),
-      ...Object.fromEntries(
-        [
-          "location",
-          "model",
-          "os",
-          "distribution",
-          "deployment",
-          "replaces",
-          "depends",
-          "master",
-          "networkInterfaces"
-        ]
-          .filter(p => this[p])
-          .map(p => [p, this[p]])
-      ),
       extends: this.extends.map(host => host.name),
       services: Object.fromEntries(
         Object.values(this.services).map(s => [s.name, s.toJSON()])
@@ -574,10 +570,13 @@ export class Location extends Base {
     return this.#administratorEmail || "admin@" + this.domain;
   }
 
+  get propertyNames() {
+    return [...super.propertyNames, "domain"];
+  }
+
   toJSON() {
     return {
       ...super.toJSON(),
-      domain: this.domain,
       hosts: [...this.#hosts.keys()].sort()
     };
   }
@@ -627,14 +626,8 @@ export class Network extends Base {
     this.#hosts.set(host.name, host);
   }
 
-  toJSON() {
-    return {
-      ...super.toJSON(),
-      kind: this.kind,
-      ipv4: this.ipv4,
-      scope: this.scope,
-      metric: this.metric
-    };
+  get propertyNames() {
+    return [...super.propertyNames, "kind", "ipv4", "scope", "metric"];
   }
 }
 
@@ -734,16 +727,16 @@ export class Service extends Base {
     return this.#type || this.name;
   }
 
-  toJSON() {
-    return {
-      ...super.toJSON(),
-      ipAddress: this.ipAddress,
-      alias: this.alias,
-      type: this.type,
-      master: this.master,
-      priority: this.priority,
-      weight: this.weight
-    };
+  get propertyNames() {
+    return [
+      ...super.propertyNames,
+      "ipAddress",
+      "alias",
+      "type",
+      "master",
+      "priority",
+      "weight"
+    ];
   }
 }
 
@@ -776,3 +769,14 @@ export function sectionLines(sectionName, values) {
 
   return lines;
 }
+
+function extractFrom(object, propertyNames) {
+  const json = {};
+  for (const p of propertyNames) {
+    const value = object[p];
+    if (value !== undefined) {
+      json[p] = value;
+    }
+  }
+  return json;
+}

package/types/model.d.mts

@@ -4,7 +4,7 @@ export class Base {
     static get typeName(): string;
     static get typeFileName(): string;
     static get fileNameGlob(): string;
-    static refinedType(data: any): typeof Base;
+    static prepareData(world: any, data: any): Promise<typeof Base>;
     static baseName(name: any): any;
     constructor(owner: any, data: any);
     owner: any;
@@ -17,12 +17,8 @@ export class Base {
     get directory(): any;
     expand(object: any): any;
     toString(): string;
-    toJSON(): {
-        name: any;
-        directory: any;
-        owner: any;
-        description: any;
-    };
+    get propertyNames(): string[];
+    toJSON(): {};
     #private;
 }
 export class World {
@@ -32,6 +28,7 @@ export class World {
     constructor(directory: any);
     directory: any;
     get name(): string;
+    _loadType(name: any, type: any): Promise<any>;
     load(): Promise<void>;
     named(name: any): Promise<any>;
     locations(): AsyncGenerator<Location, void, unknown>;
@@ -47,7 +44,7 @@ export class World {
     #private;
 }
 export class Host extends Base {
-    static refinedType(data: any): typeof Host;
+    static prepareData(world: any, data: any): Promise<typeof Host>;
     networkInterfaces: {};
     services: {};
     postinstall: any[];
@@ -75,10 +72,6 @@ export class Host extends Base {
     toJSON(): {
         extends: any[];
         services: any;
-        name: any;
-        directory: any;
-        owner: any;
-        description: any;
     };
     #private;
 }
@@ -101,12 +94,7 @@ export class Location extends Base {
     get dnsRecordTTL(): any;
     get administratorEmail(): any;
     toJSON(): {
-        domain: any;
         hosts: any[];
-        name: any;
-        directory: any;
-        owner: any;
-        description: any;
     };
     #private;
 }
@@ -120,16 +108,6 @@ export class Network extends Base {
     get subnetAddress(): any;
     hosts(): AsyncGenerator<any, void, unknown>;
     addHost(host: any): void;
-    toJSON(): {
-        kind: any;
-        ipv4: any;
-        scope: any;
-        metric: any;
-        name: any;
-        directory: any;
-        owner: any;
-        description: any;
-    };
     #private;
 }
 export class Subnet extends Base {
@@ -145,17 +123,5 @@ export class Service extends Base {
     get weight(): any;
     get master(): any;
     get type(): any;
-    toJSON(): {
-        ipAddress: any;
-        alias: any;
-        type: any;
-        master: any;
-        priority: any;
-        weight: any;
-        name: any;
-        directory: any;
-        owner: any;
-        description: any;
-    };
     #private;
 }