pmcf 1.2.1 → 1.3.0

package/README.md

@@ -1,5 +1,6 @@
 [![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)

package/bin/{location-info → pmcf-info}

@@ -4,12 +4,11 @@ import { World } from "../src/model.mjs";
 
 const world = new World(argv[2] || cwd());
 
-const locationName = argv[3];
+const objectName = argv[3];
 
-if (locationName) {
-  const location = await world.location(locationName);
-  await location.load();
-  console.log(location.toJSON());
+if (objectName) {
+  const object = await world.named(objectName);
+  console.log(object.toJSON());
 } else {
   for await (const location of world.locations()) {
     console.log(location.name);

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "pmcf",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "publishConfig": {
     "access": "public"
   },
+  "exports": {
+    ".": {
+      "default": "./src/model.mjs"
+    }
+  },
   "description": "Poor mans configuration management",
   "keywords": [
-    "config management",
-    "config"
+    "config",
+    "config management"
   ],
   "contributors": [
     {
@@ -17,26 +22,30 @@
   ],
   "license": "0BSD",
   "bin": {
-    "gen-host-defs": "./bin/gen-host-defs",
-    "gen-location-defs": "./bin/gen-location-defs",
-    "gen-named-defs": "./bin/gen-named-defs",
-    "host-info": "./bin/host-info",
-    "location-info": "./bin/location-info",
-    "network": "./bin/network"
+    "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-network": "./bin/pmcf-network"
   },
   "scripts": {
+    "prepare": "node --run prepare:typescript",
+    "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",
-    "lint:docs": "documentation lint ./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 esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "devDependencies": {
+    "@types/node": "^22.10.7",
     "ava": "^6.2.0",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",
-    "semantic-release": "^24.2.1"
+    "semantic-release": "^24.2.1",
+    "typescript": "^5.7.3"
   },
   "engines": {
     "node": ">=22.13.0"
@@ -52,7 +61,8 @@
   "template": {
     "inheritFrom": [
       "arlac77/template-arlac77-github",
-      "arlac77/template-node-app"
+      "arlac77/template-node-app",
+      "arlac77/template-typescript"
     ]
   }
 }

package/src/model.mjs

@@ -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);
   }
 }
 
@@ -114,8 +113,6 @@ export class World {
   directory;
   #byName = new Map();
 
-  /** @typedef {Map<string,Host>} */ #hosts = new Map();
-
   constructor(directory) {
     this.directory = directory;
   }
@@ -185,7 +182,6 @@ export class World {
     await this.load();
     return this.#byName.get(Host.baseName(name));
     /*
-
     if (!data.name) {
       data.name = name;
     } else {
@@ -391,24 +387,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()])
@@ -577,10 +573,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()
     };
   }
@@ -630,14 +629,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"];
   }
 }
 
@@ -737,16 +730,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"
+    ];
   }
 }
 
@@ -779,3 +772,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

@@ -0,0 +1,126 @@
+export function writeLines(dir: any, name: any, lines: any): Promise<void>;
+export function sectionLines(sectionName: any, values: any): string[];
+export class Base {
+    static get typeName(): string;
+    static get typeFileName(): string;
+    static get fileNameGlob(): string;
+    static refinedType(data: any): typeof Base;
+    static baseName(name: any): any;
+    constructor(owner: any, data: any);
+    owner: any;
+    name: any;
+    description: any;
+    get typeName(): any;
+    get host(): any;
+    get network(): any;
+    set directory(directory: any);
+    get directory(): any;
+    expand(object: any): any;
+    toString(): string;
+    get propertyNames(): string[];
+    toJSON(): {};
+    #private;
+}
+export class World {
+    static get types(): {
+        [k: string]: typeof Host | typeof Network | typeof Location | typeof Subnet | typeof Service;
+    };
+    constructor(directory: any);
+    directory: any;
+    get name(): string;
+    load(): Promise<void>;
+    named(name: any): Promise<any>;
+    locations(): AsyncGenerator<Location, void, unknown>;
+    hosts(): AsyncGenerator<Host, void, unknown>;
+    domains(): AsyncGenerator<any, void, unknown>;
+    location(name: any): Promise<any>;
+    host(name: any): Promise<any>;
+    subnets(): AsyncGenerator<any, void, unknown>;
+    networkAddresses(): AsyncGenerator<{
+        address: any;
+        networkInterface: any;
+    }, void, unknown>;
+    #private;
+}
+export class Host extends Base {
+    static refinedType(data: any): typeof Host;
+    networkInterfaces: {};
+    services: {};
+    postinstall: any[];
+    location: any;
+    get deployment(): any;
+    get extends(): any[];
+    get provides(): Set<any>;
+    get replaces(): Set<any>;
+    get _depends(): Set<any>;
+    get depends(): any;
+    get master(): boolean;
+    get os(): any;
+    get distribution(): any;
+    get model(): Model;
+    get domain(): any;
+    get modelName(): any;
+    get hostName(): any;
+    get domainName(): string;
+    networkAddresses(): Generator<{
+        address: any;
+        networkInterface: any;
+    }, void, unknown>;
+    get ipAddress(): any;
+    publicKey(type?: string): Promise<string>;
+    toJSON(): {
+        extends: any[];
+        services: any;
+    };
+    #private;
+}
+export class Model extends Host {
+}
+export class Location extends Base {
+    domain: any;
+    dns: any;
+    load(): Promise<void>;
+    hosts(): AsyncGenerator<any, void, unknown>;
+    service(filter: any): Promise<any>;
+    services(filter: any): AsyncGenerator<any, void, unknown>;
+    network(name: any): any;
+    networkAddresses(): AsyncGenerator<any, void, unknown>;
+    networks(): AsyncGenerator<any, void, unknown>;
+    subnets(): AsyncGenerator<any, void, unknown>;
+    addNetwork(data: any): any;
+    addHost(host: any): void;
+    get dnsAllowedUpdates(): any;
+    get dnsRecordTTL(): any;
+    get administratorEmail(): any;
+    toJSON(): {
+        hosts: any[];
+    };
+    #private;
+}
+export class Network extends Base {
+    kind: any;
+    scope: any;
+    metric: any;
+    ipv4: any;
+    ipv4_netmask: any;
+    subnet: any;
+    get subnetAddress(): any;
+    hosts(): AsyncGenerator<any, void, unknown>;
+    addHost(host: any): void;
+    #private;
+}
+export class Subnet extends Base {
+    networks: Set<any>;
+    get address(): any;
+}
+export class Service extends Base {
+    alias: any;
+    get prefix(): any;
+    get ipAddress(): any;
+    get port(): any;
+    get priority(): any;
+    get weight(): any;
+    get master(): any;
+    get type(): any;
+    #private;
+}

package/bin/host-info

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-import { cwd, argv } from "node:process";
-import { World } from "../src/model.mjs";
-
-const world = new World(argv[2] || cwd());
-
-const hostName = argv[3];
-
-if (hostName) {
-  const host = await world.host(hostName);
-  console.log(host.toJSON());
-} else {
-  for await (const host of world.hosts()) {
-    console.log(host.name);
-  }
-}