wkd-checker 1.1.1 → 1.2.1

package/README.md

@@ -22,4 +22,10 @@ wkd.getKey(email)
     .catch(err => {
         console.error('Error retrieving key:', err);
     });
+```
+
+or using the CLI:
+
+```bash
+npx wkd-checker test@example.com
 ```

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+// ANSI Colors and Styles
+const RESET = "\x1b[0m";
+const BOLD = "\x1b[1m";
+const DIM = "\x1b[2m";
+const RED = "\x1b[31m";
+const GREEN = "\x1b[32m";
+const CYAN = "\x1b[36m";
+// Symbols
+const CHECK_MARK = "\u2713"; // ✓
+const CROSS_MARK = "\u2717"; // ✗
+const formatStatus = (isValid, label) => {
+    if (isValid) {
+        return `${GREEN}${CHECK_MARK} ${label}${RESET}`;
+    }
+    return `${RED}${CROSS_MARK} Invalid${RESET}`;
+};
+const formatBoolean = (val) => val ? formatStatus(true, "Valid") : formatStatus(false, "Invalid");
+const printSection = (title, result) => {
+    const isWorking = result.valid;
+    const titleColor = isWorking ? GREEN : RED;
+    const statusLabel = isWorking ? "Working" : "Not Working";
+    const statusBadge = isWorking ? `${GREEN} ${statusLabel} ${RESET}` : `${RED} ${statusLabel} ${RESET}`;
+    console.log(`\n${BOLD}${title}${RESET} ${statusBadge}`);
+    console.log(`${DIM}------------------------------------------------------------${RESET}`);
+    console.log(`Policy Available:   ${formatBoolean(result.policyAvailable)}`);
+    console.log(`Policy CORS Valid:  ${formatBoolean(result.policyCorsValid)}`);
+    console.log(`\nKey Location:       ${CYAN}${result.key_location || 'N/A'}${RESET}`);
+    console.log(`\nKey Available:      ${formatBoolean(result.key_available)}`);
+    console.log(`Key CORS Valid:     ${formatBoolean(result.keyCorsValid)}`);
+    console.log(`Key Type:           ${result.keyTypeValid ? GREEN : RED}${result.keyType}${RESET}`);
+    console.log(`Fingerprint:        ${BOLD}${result.fingerprint || 'N/A'}${RESET}`);
+    console.log(`Email in Key:       ${formatBoolean(result.emailInKey)}`);
+};
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const args = process.argv.slice(2);
+        const jsonOutput = args.includes('--json');
+        const cleanArgs = args.filter((arg) => arg !== '--json');
+        if (cleanArgs.length !== 1) {
+            console.error(`${RED}Error: Please provide exactly one email address.${RESET}`);
+            console.log(`Usage: wkd-checker <email> [--json]`);
+            process.exit(1);
+        }
+        const email = cleanArgs[0];
+        if (!jsonOutput) {
+            console.log(`Checking WKD status for: ${BOLD}${email}${RESET}...`);
+        }
+        try {
+            const results = yield (0, index_1.checkKey)(email);
+            const isOverallValid = results.direct.valid || results.advanced.valid;
+            if (jsonOutput) {
+                console.log(JSON.stringify(results, null, 2));
+                process.exit(isOverallValid ? 0 : 1);
+            }
+            printSection("Direct Method", results.direct);
+            printSection("Advanced Method", results.advanced);
+            console.log(`\n${BOLD}Overall Status${RESET}`);
+            console.log(`${DIM}------------------------------------------------------------${RESET}`);
+            console.log(`Valid: ${formatBoolean(isOverallValid)}`);
+            process.exit(isOverallValid ? 0 : 1);
+        }
+        catch (error) {
+            if (jsonOutput) {
+                console.error(JSON.stringify({ error: error.message || error }));
+                process.exit(1);
+            }
+            console.error(`\n${RED}${CROSS_MARK} Error:${RESET} ${error.message || error}`);
+            process.exit(1);
+        }
+    });
+}
+main();

package/dist/index.js

@@ -28,6 +28,7 @@ class WKDError extends Error {
 }
 exports.WKDError = WKDError;
 const EMAIL_REGEX = /^[^@]+@[^@]+\.[^@]+$/;
+const USER_AGENT = "WKD-Checker (+https://www.npmjs.com/package/wkd-checker)";
 /**
  * Validates an email address format.
  * @param {string} email - The email address to validate.
@@ -183,7 +184,7 @@ const getKey = (email) => __awaiter(void 0, void 0, void 0, function* () {
     const urls = [advancedUrl, directUrl];
     for (const url of urls) {
         try {
-            const response = yield fetch(url);
+            const response = yield fetch(url, { headers: { 'User-Agent': USER_AGENT } });
             if (response.ok) {
                 return new Uint8Array(yield response.arrayBuffer());
             }
@@ -203,7 +204,7 @@ exports.getKey = getKey;
 const checkKey = (email) => __awaiter(void 0, void 0, void 0, function* () {
     const { advancedUrl, directUrl, advancedPolicyUrl, directPolicyUrl } = yield generateWkdUrls(email);
     const options = {
-        headers: { "User-Agent": "WKD-Checker (+https://miarecki.eu/posts/web-key-directory-setup/)" }
+        headers: { "User-Agent": USER_AGENT }
     };
     const [advancedResult, directResult] = yield Promise.all([
         checkKeyUrl(advancedUrl, advancedPolicyUrl, options, email),

package/package.json

@@ -1,10 +1,29 @@
 {
   "name": "wkd-checker",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "Web Key Directory library for Node.js. Retreive OpenPGP keys from WKD servers and validate them.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JonatanMGit/wkd-checker.git"
+  },
+  "keywords": [
+    "wkd",
+    "openpgp",
+    "pgp",
+    "gpg",
+    "keyserver"
+  ],
+  "homepage": "https://miarecki.eu/tools/wkd-checker/",
+  "bugs": {
+    "url": "https://github.com/JonatanMGit/wkd-checker/issues"
+  },
+  "bin": {
+    "wkd-checker": "dist/cli.js"
+  },
   "author": "Jonatan Miarecki",
   "license": "MIT",
   "devDependencies": {
+    "@types/node": "^25.0.6",
     "typescript": "^5.4.2"
   },
   "dependencies": {