node-ipconfig 1.0.0 → 1.0.1

package/src/command.js

@@ -1,117 +1,117 @@
-import { execFile } from "node:child_process";
-
-export class IpconfigError extends Error {
-  constructor(
-    message,
-    {
-      code = "EIPCONFIG",
-      cause,
-      command,
-      stdout = "",
-      stderr = "",
-      exitCode,
-    } = {},
-  ) {
-    super(message, { cause });
-    this.name = "IpconfigError";
-    this.code = code;
-    if (command) this.command = command;
-    this.stdout = stdout;
-    this.stderr = stderr;
-    if (exitCode !== undefined) this.exitCode = exitCode;
-  }
-}
-
-export function createRunner({
-  platform = process.platform,
-  exec = execFile,
-} = {}) {
-  return function run(args = [], options = {}) {
-    if (platform !== "win32")
-      return Promise.reject(
-        new IpconfigError("node-ipconfig is supported only on Windows.", {
-          code: "ENOTSUP",
-        }),
-      );
-    return new Promise((resolve, reject) => {
-      const command = ["ipconfig.exe", ...args];
-      const finish = (error, stdout = "", stderr = "") => {
-        const output =
-          typeof stdout === "string"
-            ? stdout
-            : stdout?.toString(options.encoding ?? "utf8");
-        const errorOutput =
-          typeof stderr === "string"
-            ? stderr
-            : stderr?.toString(options.encoding ?? "utf8");
-        const exitCode = Number.isInteger(error?.code)
-          ? error.code
-          : error
-            ? null
-            : 0;
-        // Some ipconfig commands emit useful localized diagnostics and a non-zero exit status.
-        if (
-          error &&
-          !output?.trim() &&
-          !(options.rawResult && Number.isInteger(error.code))
-        ) {
-          const code =
-            error.code === "EACCES" || error.code === "EPERM"
-              ? "EACCES"
-              : error.code === "ENOENT"
-                ? "ENOENT"
-                : error.code === "ETIMEDOUT" ||
-                    (error.killed && options.timeout)
-                  ? "ETIMEDOUT"
-                  : error.name === "AbortError"
-                    ? "ABORT_ERR"
-                    : (error.code ?? "EIPCONFIG");
-          const message =
-            code === "EACCES"
-              ? "Permission denied while running ipconfig; retry from an appropriately authorized terminal."
-              : code === "ENOENT"
-                ? "ipconfig.exe could not be found on PATH."
-                : code === "ETIMEDOUT"
-                  ? "ipconfig timed out; increase timeout or retry."
-                  : code === "ABORT_ERR"
-                    ? "ipconfig was aborted."
-                    : `ipconfig failed${error.message ? `: ${error.message}` : ""}`;
-          reject(
-            new IpconfigError(message, {
-              code,
-              cause: error,
-              command,
-              stdout: output ?? "",
-              stderr: errorOutput ?? "",
-              exitCode: exitCode ?? undefined,
-            }),
-          );
-          return;
-        }
-        if (options.rawResult)
-          resolve({
-            stdout: output ?? "",
-            stderr: errorOutput ?? "",
-            exitCode: exitCode ?? 0,
-          });
-        else resolve((output ?? "") || (errorOutput ?? ""));
-      };
-      try {
-        exec(
-          "ipconfig.exe",
-          args,
-          {
-            windowsHide: true,
-            encoding: options.encoding ?? "utf8",
-            timeout: options.timeout ?? 15000,
-            maxBuffer: 4 * 1024 * 1024,
-            ...(options.signal ? { signal: options.signal } : {}),
-          },
-          finish,
-        );
-      } catch (error) {
-        finish(error);
-      }
-    });
-  };
-}
+import { execFile } from "node:child_process";
+
+export class IpconfigError extends Error {
+  constructor(
+    message,
+    {
+      code = "EIPCONFIG",
+      cause,
+      command,
+      stdout = "",
+      stderr = "",
+      exitCode,
+    } = {},
+  ) {
+    super(message, { cause });
+    this.name = "IpconfigError";
+    this.code = code;
+    if (command) this.command = command;
+    this.stdout = stdout;
+    this.stderr = stderr;
+    if (exitCode !== undefined) this.exitCode = exitCode;
+  }
+}
+
+export function createRunner({
+  platform = process.platform,
+  exec = execFile,
+} = {}) {
+  return function run(args = [], options = {}) {
+    if (platform !== "win32")
+      return Promise.reject(
+        new IpconfigError("node-ipconfig is supported only on Windows.", {
+          code: "ENOTSUP",
+        }),
+      );
+    return new Promise((resolve, reject) => {
+      const command = ["ipconfig.exe", ...args];
+      const finish = (error, stdout = "", stderr = "") => {
+        const output =
+          typeof stdout === "string"
+            ? stdout
+            : stdout?.toString(options.encoding ?? "utf8");
+        const errorOutput =
+          typeof stderr === "string"
+            ? stderr
+            : stderr?.toString(options.encoding ?? "utf8");
+        const exitCode = Number.isInteger(error?.code)
+          ? error.code
+          : error
+            ? null
+            : 0;
+        // Some ipconfig commands emit useful localized diagnostics and a non-zero exit status.
+        if (
+          error &&
+          !output?.trim() &&
+          !(options.rawResult && Number.isInteger(error.code))
+        ) {
+          const code =
+            error.code === "EACCES" || error.code === "EPERM"
+              ? "EACCES"
+              : error.code === "ENOENT"
+                ? "ENOENT"
+                : error.code === "ETIMEDOUT" ||
+                    (error.killed && options.timeout)
+                  ? "ETIMEDOUT"
+                  : error.name === "AbortError"
+                    ? "ABORT_ERR"
+                    : (error.code ?? "EIPCONFIG");
+          const message =
+            code === "EACCES"
+              ? "Permission denied while running ipconfig; retry from an appropriately authorized terminal."
+              : code === "ENOENT"
+                ? "ipconfig.exe could not be found on PATH."
+                : code === "ETIMEDOUT"
+                  ? "ipconfig timed out; increase timeout or retry."
+                  : code === "ABORT_ERR"
+                    ? "ipconfig was aborted."
+                    : `ipconfig failed${error.message ? `: ${error.message}` : ""}`;
+          reject(
+            new IpconfigError(message, {
+              code,
+              cause: error,
+              command,
+              stdout: output ?? "",
+              stderr: errorOutput ?? "",
+              exitCode: exitCode ?? undefined,
+            }),
+          );
+          return;
+        }
+        if (options.rawResult)
+          resolve({
+            stdout: output ?? "",
+            stderr: errorOutput ?? "",
+            exitCode: exitCode ?? 0,
+          });
+        else resolve((output ?? "") || (errorOutput ?? ""));
+      };
+      try {
+        exec(
+          "ipconfig.exe",
+          args,
+          {
+            windowsHide: true,
+            encoding: options.encoding ?? "utf8",
+            timeout: options.timeout ?? 15000,
+            maxBuffer: 4 * 1024 * 1024,
+            ...(options.signal ? { signal: options.signal } : {}),
+          },
+          finish,
+        );
+      } catch (error) {
+        finish(error);
+      }
+    });
+  };
+}

package/src/format.js

@@ -1,119 +1,119 @@
-const FORMATS = new Set(["json", "xml", "yaml", "csv", "ndjson"]);
-
-function escapeXml(value) {
-  return String(value).replace(
-    /[<>&"']/g,
-    (character) =>
-      ({
-        "<": "&lt;",
-        ">": "&gt;",
-        "&": "&amp;",
-        '"': "&quot;",
-        "'": "&apos;",
-      })[character],
-  );
-}
-
-function xmlNode(name, value) {
-  if (Array.isArray(value))
-    return `<${name}>${value.map((item) => xmlNode("item", item)).join("")}</${name}>`;
-  if (value && typeof value === "object")
-    return `<${name}>${Object.entries(value)
-      .map(([key, item]) =>
-        xmlNode(key.replace(/[^A-Za-z0-9_.-]/g, "_") || "field", item),
-      )
-      .join("")}</${name}>`;
-  return `<${name}>${escapeXml(value ?? "")}</${name}>`;
-}
-
-function yamlScalar(value) {
-  if (value === null) return "null";
-  if (typeof value === "string") return JSON.stringify(value);
-  return String(value);
-}
-
-function yamlLines(value, indent = 0) {
-  const pad = " ".repeat(indent);
-  if (Array.isArray(value))
-    return value.length
-      ? value.flatMap((item) => {
-          if (item && typeof item === "object") {
-            const lines = yamlLines(item, indent + 2);
-            return [
-              `${pad}- ${lines[0]?.trimStart() ?? "{}"}`,
-              ...lines.slice(1),
-            ];
-          }
-          return [`${pad}- ${yamlScalar(item)}`];
-        })
-      : [`${pad}[]`];
-  if (value && typeof value === "object") {
-    const entries = Object.entries(value);
-    return entries.length
-      ? entries.flatMap(([key, item]) => {
-          const safeKey = /^[A-Za-z_][\w.-]*$/.test(key)
-            ? key
-            : JSON.stringify(key);
-          if (item && typeof item === "object")
-            return [`${pad}${safeKey}:`, ...yamlLines(item, indent + 2)];
-          return [`${pad}${safeKey}: ${yamlScalar(item)}`];
-        })
-      : [`${pad}{}`];
-  }
-  return [`${pad}${yamlScalar(value)}`];
-}
-
-function csvCell(value) {
-  const text =
-    value == null
-      ? ""
-      : typeof value === "object"
-        ? JSON.stringify(value)
-        : String(value);
-  return /[",\r\n]/.test(text) ? `"${text.replace(/"/g, '""')}"` : text;
-}
-
-/** Format a parsed configuration as JSON data or a serialized JSON, XML, YAML, CSV, or NDJSON document. */
-export function formatConfig(config, format = "json") {
-  if (!FORMATS.has(format))
-    throw new TypeError(
-      `Unsupported format: ${format}. Choose json, xml, yaml, csv, or ndjson.`,
-    );
-  if (format === "json") return config;
-  if (format === "xml")
-    return `<?xml version="1.0" encoding="UTF-8"?>\n${xmlNode("config", config)}`;
-  if (format === "yaml") return `${yamlLines(config).join("\n")}\n`;
-  if (format === "ndjson")
-    return `${config.adapters.map((adapter) => JSON.stringify({ ...(config.hostname ? { hostname: config.hostname } : {}), adapter })).join("\n")}${config.adapters.length ? "\n" : ""}`;
-  const columns = [
-    "name",
-    "type",
-    "description",
-    "macAddress",
-    "ipv4",
-    "ipv6",
-    "subnetMask",
-    "ipv4PrefixLength",
-    "defaultGateways",
-    "dnsServers",
-    "dhcpEnabled",
-    "autoconfigurationEnabled",
-    "dhcpServer",
-    "leaseObtained",
-    "leaseExpires",
-    "connectionSpecificDnsSuffix",
-    "mediaState",
-    "addresses",
-    "fields",
-  ];
-  return (
-    [
-      columns.join(","),
-      ...config.adapters.map((adapter) =>
-        columns.map((key) => csvCell(adapter[key])).join(","),
-      ),
-    ].join("\r\n") + "\r\n"
-  );
-}
-
-export const CONFIG_FORMATS = Object.freeze([...FORMATS]);
+const FORMATS = new Set(["json", "xml", "yaml", "csv", "ndjson"]);
+
+function escapeXml(value) {
+  return String(value).replace(
+    /[<>&"']/g,
+    (character) =>
+      ({
+        "<": "&lt;",
+        ">": "&gt;",
+        "&": "&amp;",
+        '"': "&quot;",
+        "'": "&apos;",
+      })[character],
+  );
+}
+
+function xmlNode(name, value) {
+  if (Array.isArray(value))
+    return `<${name}>${value.map((item) => xmlNode("item", item)).join("")}</${name}>`;
+  if (value && typeof value === "object")
+    return `<${name}>${Object.entries(value)
+      .map(([key, item]) =>
+        xmlNode(key.replace(/[^A-Za-z0-9_.-]/g, "_") || "field", item),
+      )
+      .join("")}</${name}>`;
+  return `<${name}>${escapeXml(value ?? "")}</${name}>`;
+}
+
+function yamlScalar(value) {
+  if (value === null) return "null";
+  if (typeof value === "string") return JSON.stringify(value);
+  return String(value);
+}
+
+function yamlLines(value, indent = 0) {
+  const pad = " ".repeat(indent);
+  if (Array.isArray(value))
+    return value.length
+      ? value.flatMap((item) => {
+          if (item && typeof item === "object") {
+            const lines = yamlLines(item, indent + 2);
+            return [
+              `${pad}- ${lines[0]?.trimStart() ?? "{}"}`,
+              ...lines.slice(1),
+            ];
+          }
+          return [`${pad}- ${yamlScalar(item)}`];
+        })
+      : [`${pad}[]`];
+  if (value && typeof value === "object") {
+    const entries = Object.entries(value);
+    return entries.length
+      ? entries.flatMap(([key, item]) => {
+          const safeKey = /^[A-Za-z_][\w.-]*$/.test(key)
+            ? key
+            : JSON.stringify(key);
+          if (item && typeof item === "object")
+            return [`${pad}${safeKey}:`, ...yamlLines(item, indent + 2)];
+          return [`${pad}${safeKey}: ${yamlScalar(item)}`];
+        })
+      : [`${pad}{}`];
+  }
+  return [`${pad}${yamlScalar(value)}`];
+}
+
+function csvCell(value) {
+  const text =
+    value == null
+      ? ""
+      : typeof value === "object"
+        ? JSON.stringify(value)
+        : String(value);
+  return /[",\r\n]/.test(text) ? `"${text.replace(/"/g, '""')}"` : text;
+}
+
+/** Format a parsed configuration as JSON data or a serialized JSON, XML, YAML, CSV, or NDJSON document. */
+export function formatConfig(config, format = "json") {
+  if (!FORMATS.has(format))
+    throw new TypeError(
+      `Unsupported format: ${format}. Choose json, xml, yaml, csv, or ndjson.`,
+    );
+  if (format === "json") return config;
+  if (format === "xml")
+    return `<?xml version="1.0" encoding="UTF-8"?>\n${xmlNode("config", config)}`;
+  if (format === "yaml") return `${yamlLines(config).join("\n")}\n`;
+  if (format === "ndjson")
+    return `${config.adapters.map((adapter) => JSON.stringify({ ...(config.hostname ? { hostname: config.hostname } : {}), adapter })).join("\n")}${config.adapters.length ? "\n" : ""}`;
+  const columns = [
+    "name",
+    "type",
+    "description",
+    "macAddress",
+    "ipv4",
+    "ipv6",
+    "subnetMask",
+    "ipv4PrefixLength",
+    "defaultGateways",
+    "dnsServers",
+    "dhcpEnabled",
+    "autoconfigurationEnabled",
+    "dhcpServer",
+    "leaseObtained",
+    "leaseExpires",
+    "connectionSpecificDnsSuffix",
+    "mediaState",
+    "addresses",
+    "fields",
+  ];
+  return (
+    [
+      columns.join(","),
+      ...config.adapters.map((adapter) =>
+        columns.map((key) => csvCell(adapter[key])).join(","),
+      ),
+    ].join("\r\n") + "\r\n"
+  );
+}
+
+export const CONFIG_FORMATS = Object.freeze([...FORMATS]);

package/src/index.cjs

@@ -1,64 +1,64 @@
-"use strict";
-const load = () => import("./index.js");
-const api = {};
-for (const name of [
-  "execute",
-  "getRawOutput",
-  "getConfig",
-  "getAdapters",
-  "getAdapter",
-  "getIPv4",
-  "getIPv6",
-  "getDefaultGateway",
-  "getDnsServers",
-  "getMacAddresses",
-  "getHostname",
-  "release",
-  "renew",
-  "flushDns",
-  "getDnsCache",
-  "displayDns",
-  "registerDns",
-  "showClassId",
-  "setClassId",
-  "showClassId6",
-  "setClassId6",
-]) {
-  api[name] = (...args) =>
-    load().then(({ ipconfig }) => ipconfig[name](...args));
-}
-api.parseIpconfig = (...args) =>
-  load().then(({ parseIpconfig }) => parseIpconfig(...args));
-api.createIpconfig = (options) => {
-  const instance = {};
-  for (const name of [
-    "execute",
-    "getRawOutput",
-    "getConfig",
-    "getAdapters",
-    "getAdapter",
-    "getIPv4",
-    "getIPv6",
-    "getDefaultGateway",
-    "getDnsServers",
-    "getMacAddresses",
-    "getHostname",
-    "release",
-    "renew",
-    "flushDns",
-    "getDnsCache",
-    "displayDns",
-    "registerDns",
-    "showClassId",
-    "setClassId",
-    "showClassId6",
-    "setClassId6",
-  ]) {
-    instance[name] = (...args) =>
-      load().then(({ createIpconfig }) =>
-        createIpconfig(options)[name](...args),
-      );
-  }
-  return instance;
-};
-module.exports = api;
+"use strict";
+const load = () => import("./index.js");
+const api = {};
+for (const name of [
+  "execute",
+  "getRawOutput",
+  "getConfig",
+  "getAdapters",
+  "getAdapter",
+  "getIPv4",
+  "getIPv6",
+  "getDefaultGateway",
+  "getDnsServers",
+  "getMacAddresses",
+  "getHostname",
+  "release",
+  "renew",
+  "flushDns",
+  "getDnsCache",
+  "displayDns",
+  "registerDns",
+  "showClassId",
+  "setClassId",
+  "showClassId6",
+  "setClassId6",
+]) {
+  api[name] = (...args) =>
+    load().then(({ ipconfig }) => ipconfig[name](...args));
+}
+api.parseIpconfig = (...args) =>
+  load().then(({ parseIpconfig }) => parseIpconfig(...args));
+api.createIpconfig = (options) => {
+  const instance = {};
+  for (const name of [
+    "execute",
+    "getRawOutput",
+    "getConfig",
+    "getAdapters",
+    "getAdapter",
+    "getIPv4",
+    "getIPv6",
+    "getDefaultGateway",
+    "getDnsServers",
+    "getMacAddresses",
+    "getHostname",
+    "release",
+    "renew",
+    "flushDns",
+    "getDnsCache",
+    "displayDns",
+    "registerDns",
+    "showClassId",
+    "setClassId",
+    "showClassId6",
+    "setClassId6",
+  ]) {
+    instance[name] = (...args) =>
+      load().then(({ createIpconfig }) =>
+        createIpconfig(options)[name](...args),
+      );
+  }
+  return instance;
+};
+module.exports = api;