@utilix-tech/sdk 0.7.0 → 0.9.0

package/CHANGELOG.md

@@ -2,11 +2,29 @@
 
 Full release notes for all Utilix surfaces (browser tools, REST API, SDKs, MCP server) live at [utilix.tech/changelog](https://utilix.tech/changelog). This file tracks just this package.
 
-## 0.3.1
-- Metadata fixes: corrected repository/bug tracker links, updated tool count in the package description.
+## 0.9.0
+- Added Sitemap.xml Validator.
+
+## 0.8.0
+- Added ID3 Tag Reader and .env.example Diff Checker.
+
+## 0.7.0
+- Added WAV Audio Info and Readability Score Calculator.
+
+## 0.6.0
+- Added EXIF Viewer and Commit Message Generator (AI).
+
+## 0.5.0
+- Added PDF Metadata Reader and JWK Viewer.
+
+## 0.4.1
+- Added HAR File Viewer and NDJSON Formatter/Validator.
+
+## 0.4.0
+- Metadata fixes: corrected repository/bug tracker links, updated the stale dependency, added missing package files.
 
 ## 0.3.0
-- Added the `media` module.
+- Added the `media` module (Passive Voice Detector, Image Info).
 
 ## 0.2.0
 - 400+ functions across 14 modules, including the `ai_agent` module for LLM/RAG pipelines.

package/README.md

@@ -156,12 +156,12 @@ scoreReadability("The cat sat on the mat. It was a sunny day.");
 
 ---
 
-### `/data`: CSV / YAML / TOML / XML / INI / NDJSON
+### `/data`: CSV / YAML / TOML / XML / INI / NDJSON / .env diff
 
 ```ts
 import { parseCsv, csvToJson, validateYaml, tomlToJson, jsonToToml,
          formatXml, xmlToJson, jsonToXml, parseIni,
-         validateNdjson, formatNdjson, ndjsonToJsonArray } from "@utilix-tech/sdk/data";
+         validateNdjson, formatNdjson, ndjsonToJsonArray, diffEnvExample } from "@utilix-tech/sdk/data";
 
 // CSV
 const rows = parseCsv("name,age\nalice,30\nbob,25");
@@ -185,6 +185,10 @@ parseIni("[db]\nhost=localhost\nport=5432");
 validateNdjson('{"id":1}\n{"id":2}');       // { valid: true, totalLines: 2, ... }
 formatNdjson('{"id":1}');                    // '{\n  "id": 1\n}'
 ndjsonToJsonArray('{"id":1}\n{"id":2}');     // '[\n  { "id": 1 },\n  { "id": 2 }\n]'
+
+// Diff a .env file against its .env.example template
+diffEnvExample("FOO=1\nBAR=2", "FOO=\nBAR=y\nBAZ=z");
+// { missingInExample: [], missingInEnv: ["BAZ"], emptyValueInExample: ["FOO"], keysInBoth: 2 }
 ```
 
 ---
@@ -265,7 +269,7 @@ formatValue(1234567.89, { locale: "en-US", currency: "USD" });
 ```ts
 import { getStatusCode, isValidIp, isValidIpv4, isValidIpv6,
          searchStatusCodes, buildGeoUrl, countryCodeToFlag,
-         parseHar } from "@utilix-tech/sdk/network";
+         parseHar, validateSitemap } from "@utilix-tech/sdk/network";
 
 getStatusCode(404);
 // { code: 404, text: "Not Found", description: "...", category: "Client Error" }
@@ -282,6 +286,10 @@ countryCodeToFlag("US");       // "🇺🇸"
 const har = await fs.promises.readFile("network.har", "utf-8");
 parseHar(har);
 // { version: "1.2", entries: [...], summary: { totalRequests, totalSize, failedRequests, ... } }
+
+// Validate a sitemap.xml (or sitemap index) against the sitemaps.org protocol
+validateSitemap('<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url><loc>https://example.com/</loc></url></urlset>');
+// { type: "urlset", urlCount: 1, entries: [...], issues: [...], valid: true }
 ```
 
 ---
@@ -420,10 +428,10 @@ analyzeString("café");          // { length: 4, codePoints: [...], ... }
 
 ---
 
-### `/media`: Image Header Parsing, EXIF, PDF & WAV Metadata
+### `/media`: Image Header Parsing, EXIF, PDF, WAV & ID3 Metadata
 
 ```ts
-import { readImageInfo, readExifData, readPdfMetadata, readWavInfo } from "@utilix-tech/sdk/media";
+import { readImageInfo, readExifData, readPdfMetadata, readWavInfo, readId3Tags } from "@utilix-tech/sdk/media";
 
 // Reads format, dimensions, bit depth, and alpha channel straight from
 // file bytes: no decoding, no canvas, no image library.
@@ -448,9 +456,16 @@ readPdfMetadata(new Uint8Array(pdfBytes));
 const wavBytes = await fs.promises.readFile("recording.wav");
 readWavInfo(new Uint8Array(wavBytes));
 // { audioFormat: 1, audioFormatLabel: "PCM", channels: 2, sampleRate: 44100, bitsPerSample: 16, durationSeconds: 12.4, ... }
+
+// Reads title, artist, album, year, genre, comment, and track number from
+// an MP3's ID3 tags. Prefers ID3v2.3/2.4 text frames, falls back to the
+// classic 128-byte ID3v1/1.1 trailer.
+const mp3Bytes = await fs.promises.readFile("track.mp3");
+readId3Tags(new Uint8Array(mp3Bytes));
+// { version: "ID3v2.3.0", title: "Track Name", artist: "Artist Name", genre: "Rock", ... }
 ```
 
-`readImageInfo` supports PNG, JPEG, GIF, WebP, and BMP. `readExifData` supports JPEG only. `readWavInfo` supports the canonical RIFF/WAVE container only.
+`readImageInfo` supports PNG, JPEG, GIF, WebP, and BMP. `readExifData` supports JPEG only. `readWavInfo` supports the canonical RIFF/WAVE container only. `readId3Tags` decodes ID3v2.3/2.4 and ID3v1/1.1 only (ID3v2.2 is detected but not decoded).
 
 ---
 

package/dist/{chunk-5CKOJXFU.js → chunk-GUUYEIU6.js}

@@ -4,6 +4,7 @@ import { __export } from './chunk-MLKGABMK.js';
 var media_exports = {};
 __export(media_exports, {
   readExifData: () => readExifData,
+  readId3Tags: () => readId3Tags,
   readImageInfo: () => readImageInfo,
   readPdfMetadata: () => readPdfMetadata,
   readWavInfo: () => readWavInfo
@@ -520,5 +521,214 @@ function readWavInfo(bytes) {
     fileSize
   };
 }
+var ID3V1_GENRES = [
+  "Blues",
+  "Classic Rock",
+  "Country",
+  "Dance",
+  "Disco",
+  "Funk",
+  "Grunge",
+  "Hip-Hop",
+  "Jazz",
+  "Metal",
+  "New Age",
+  "Oldies",
+  "Other",
+  "Pop",
+  "R&B",
+  "Rap",
+  "Reggae",
+  "Rock",
+  "Techno",
+  "Industrial",
+  "Alternative",
+  "Ska",
+  "Death Metal",
+  "Pranks",
+  "Soundtrack",
+  "Euro-Techno",
+  "Ambient",
+  "Trip-Hop",
+  "Vocal",
+  "Jazz+Funk",
+  "Fusion",
+  "Trance",
+  "Classical",
+  "Instrumental",
+  "Acid",
+  "House",
+  "Game",
+  "Sound Clip",
+  "Gospel",
+  "Noise",
+  "AlternRock",
+  "Bass",
+  "Soul",
+  "Punk",
+  "Space",
+  "Meditative",
+  "Instrumental Pop",
+  "Instrumental Rock",
+  "Ethnic",
+  "Gothic",
+  "Darkwave",
+  "Techno-Industrial",
+  "Electronic",
+  "Pop-Folk",
+  "Eurodance",
+  "Dream",
+  "Southern Rock",
+  "Comedy",
+  "Cult",
+  "Gangsta",
+  "Top 40",
+  "Christian Rap",
+  "Pop/Funk",
+  "Jungle",
+  "Native American",
+  "Cabaret",
+  "New Wave",
+  "Psychedelic",
+  "Rave",
+  "Showtunes",
+  "Trailer",
+  "Lo-Fi",
+  "Tribal",
+  "Acid Punk",
+  "Acid Jazz",
+  "Polka",
+  "Retro",
+  "Musical",
+  "Rock & Roll",
+  "Hard Rock"
+];
+function readSynchsafeUInt32(bytes, offset) {
+  return (bytes[offset] & 127) << 21 | (bytes[offset + 1] & 127) << 14 | (bytes[offset + 2] & 127) << 7 | bytes[offset + 3] & 127;
+}
+function readUInt32BE(bytes, offset) {
+  return (bytes[offset] << 24 | bytes[offset + 1] << 16 | bytes[offset + 2] << 8 | bytes[offset + 3]) >>> 0;
+}
+function decodeId3Text(frameBytes) {
+  if (frameBytes.length === 0) return "";
+  const encodingByte = frameBytes[0];
+  const content = frameBytes.subarray(1);
+  let out = "";
+  if (encodingByte === 3) {
+    out = Buffer.from(content).toString("utf8");
+  } else if (encodingByte === 1 || encodingByte === 2) {
+    let little = encodingByte === 1;
+    let start = 0;
+    if (encodingByte === 1 && content.length >= 2) {
+      if (content[0] === 255 && content[1] === 254) {
+        little = true;
+        start = 2;
+      } else if (content[0] === 254 && content[1] === 255) {
+        little = false;
+        start = 2;
+      }
+    }
+    for (let i = start; i + 1 < content.length; i += 2) {
+      const code = little ? content[i] | content[i + 1] << 8 : content[i] << 8 | content[i + 1];
+      if (code === 0) break;
+      out += String.fromCharCode(code);
+    }
+  } else {
+    for (const b of content) {
+      if (b === 0) break;
+      out += String.fromCharCode(b);
+    }
+  }
+  return out.replace(/\0+$/, "").trim();
+}
+function readId3v2(bytes) {
+  if (bytes.length < 10 || bytes[0] !== 73 || bytes[1] !== 68 || bytes[2] !== 51) return null;
+  const majorVersion = bytes[3];
+  const revision = bytes[4];
+  const tagSize = readSynchsafeUInt32(bytes, 6);
+  const version = `ID3v2.${majorVersion}.${revision}`;
+  if (majorVersion !== 3 && majorVersion !== 4) {
+    return { version, frames: {}, frameCount: 0 };
+  }
+  const frames = {};
+  let offset = 10;
+  const end = Math.min(10 + tagSize, bytes.length);
+  let frameCount = 0;
+  while (offset + 10 <= end) {
+    const frameId = String.fromCharCode(bytes[offset], bytes[offset + 1], bytes[offset + 2], bytes[offset + 3]);
+    if (frameId === "\0\0\0\0") break;
+    const frameSize = majorVersion === 4 ? readSynchsafeUInt32(bytes, offset + 4) : readUInt32BE(bytes, offset + 4);
+    const frameStart = offset + 10;
+    if (frameSize <= 0 || frameStart + frameSize > bytes.length) break;
+    const frameBytes = bytes.subarray(frameStart, frameStart + frameSize);
+    if (frameId[0] === "T" && frameId !== "TXXX") {
+      frames[frameId] = decodeId3Text(frameBytes);
+    } else if (frameId === "COMM" && frameBytes.length > 4) {
+      const rebuilt = new Uint8Array(frameBytes.length - 3);
+      rebuilt[0] = frameBytes[0];
+      rebuilt.set(frameBytes.subarray(4), 1);
+      const decoded = decodeId3Text(rebuilt);
+      const parts = decoded.split("\0");
+      frames["COMM"] = (parts[parts.length - 1] || decoded).trim();
+    }
+    frameCount++;
+    offset = frameStart + frameSize;
+  }
+  return { version, frames, frameCount };
+}
+function readId3v1(bytes) {
+  if (bytes.length < 128) return null;
+  const start = bytes.length - 128;
+  if (String.fromCharCode(bytes[start], bytes[start + 1], bytes[start + 2]) !== "TAG") return null;
+  const readField = (offset, length) => {
+    let s = "";
+    for (let i = 0; i < length; i++) {
+      const b = bytes[start + offset + i];
+      if (b === 0) break;
+      s += String.fromCharCode(b);
+    }
+    return s.trim();
+  };
+  const title = readField(3, 30);
+  const artist = readField(33, 30);
+  const album = readField(63, 30);
+  const year = readField(93, 4);
+  const isV11 = bytes[start + 125] === 0 && bytes[start + 126] !== 0;
+  const comment = readField(97, isV11 ? 28 : 30);
+  const genreIndex = bytes[start + 127];
+  const genre = ID3V1_GENRES[genreIndex] ?? `Unknown (${genreIndex})`;
+  const result = { genre };
+  if (title) result.title = title;
+  if (artist) result.artist = artist;
+  if (album) result.album = album;
+  if (year) result.year = year;
+  if (comment) result.comment = comment;
+  if (isV11) result.trackNumber = String(bytes[start + 126]);
+  return result;
+}
+function readId3Tags(bytes) {
+  const v2 = readId3v2(bytes);
+  const v1 = readId3v1(bytes);
+  if (v2 && Object.keys(v2.frames).length > 0) {
+    const f = v2.frames;
+    const result = { version: v2.version, frameCount: v2.frameCount };
+    if (f["TIT2"]) result.title = f["TIT2"];
+    if (f["TPE1"]) result.artist = f["TPE1"];
+    if (f["TALB"]) result.album = f["TALB"];
+    const year = f["TYER"] || f["TDRC"];
+    if (year) result.year = year;
+    if (f["TCON"]) result.genre = f["TCON"];
+    if (f["COMM"]) result.comment = f["COMM"];
+    if (f["TRCK"]) result.trackNumber = f["TRCK"];
+    return result;
+  }
+  if (v1) {
+    return { version: v1.trackNumber !== void 0 ? "ID3v1.1" : "ID3v1", ...v1 };
+  }
+  if (v2) {
+    return { error: `Unsupported ID3 tag version: ${v2.version} (only ID3v2.3, ID3v2.4, and ID3v1/1.1 are supported)` };
+  }
+  return { error: "No ID3v1 or ID3v2.3/2.4 tags found in this file" };
+}
 
-export { media_exports, readExifData, readImageInfo, readPdfMetadata, readWavInfo };
+export { media_exports, readExifData, readId3Tags, readImageInfo, readPdfMetadata, readWavInfo };

package/dist/{chunk-V5JKVDBA.js → chunk-LI5AME5R.js}

@@ -32,7 +32,8 @@ __export(network_exports, {
   typeNumberToLabel: () => typeNumberToLabel,
   validateDomain: () => validateDomain,
   validateHeaderName: () => validateHeaderName,
-  validateHeaderValue: () => validateHeaderValue
+  validateHeaderValue: () => validateHeaderValue,
+  validateSitemap: () => validateSitemap
 });
 var DNS_RECORD_TYPES = ["A", "AAAA", "CNAME", "MX", "TXT", "NS", "SOA", "PTR", "SRV", "CAA"];
 function buildDnsQueryUrl(domain, type) {
@@ -1440,5 +1441,95 @@ function parseHar(input) {
     summary: { totalRequests, totalSize, totalTime, avgTime, failedRequests, methods, statusCodes }
   };
 }
+var VALID_CHANGEFREQ = /* @__PURE__ */ new Set(["always", "hourly", "daily", "weekly", "monthly", "yearly", "never"]);
+function sitemapLineNumber(xml, index) {
+  let line = 1;
+  for (let i = 0; i < index; i++) {
+    if (xml[i] === "\n") line++;
+  }
+  return line;
+}
+function extractSitemapTag(block, tag) {
+  const m = block.match(new RegExp(`<${tag}[^>]*>([\\s\\S]*?)</${tag}>`, "i"));
+  return m ? m[1].trim() : void 0;
+}
+function isValidW3CDatetime(s) {
+  return /^\d{4}(-\d{2}(-\d{2}(T\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:\d{2}))?)?)?$/.test(s);
+}
+function isAbsoluteHttpUrl(s) {
+  return /^https?:\/\//i.test(s);
+}
+function validateSitemap(xml) {
+  if (!xml || !xml.trim()) return { error: "Input is empty" };
+  const trimmed = xml.trim();
+  const issues = [];
+  if (!/^\s*<\?xml/i.test(trimmed)) {
+    issues.push({ severity: "warning", line: 1, message: 'Missing XML declaration (<?xml version="1.0" encoding="UTF-8"?>)' });
+  }
+  const isUrlset = /<urlset[\s>]/i.test(trimmed);
+  const isSitemapIndex = /<sitemapindex[\s>]/i.test(trimmed);
+  if (!isUrlset && !isSitemapIndex) {
+    return { error: "Not a valid sitemap: root element must be <urlset> or <sitemapindex>" };
+  }
+  if (isUrlset && isSitemapIndex) {
+    return { error: "Ambiguous file: contains both <urlset> and <sitemapindex> root elements" };
+  }
+  const type = isUrlset ? "urlset" : "sitemapindex";
+  if (isUrlset && !/xmlns\s*=\s*["']http:\/\/www\.sitemaps\.org\/schemas\/sitemap\/0\.9["']/i.test(trimmed)) {
+    issues.push({ severity: "warning", line: 1, message: "Missing or non-standard xmlns namespace (expected http://www.sitemaps.org/schemas/sitemap/0.9)" });
+  }
+  const blockTag = isUrlset ? "url" : "sitemap";
+  const blockRe = new RegExp(`<${blockTag}>([\\s\\S]*?)</${blockTag}>`, "gi");
+  const seenLocs = /* @__PURE__ */ new Set();
+  const entries = [];
+  let match;
+  while ((match = blockRe.exec(trimmed)) !== null) {
+    const block = match[1];
+    const line = sitemapLineNumber(trimmed, match.index);
+    const loc = extractSitemapTag(block, "loc");
+    if (!loc) {
+      issues.push({ severity: "error", line, message: `<${blockTag}> entry is missing required <loc>` });
+      continue;
+    }
+    if (!isAbsoluteHttpUrl(loc)) {
+      issues.push({ severity: "error", line, message: `<loc>${loc}</loc> must be an absolute URL starting with http:// or https://` });
+    }
+    if (/&(?!amp;|lt;|gt;|apos;|quot;|#\d+;)/.test(loc)) {
+      issues.push({ severity: "error", line, message: `<loc>${loc}</loc> contains an unescaped '&' (use &amp; instead)` });
+    }
+    if (seenLocs.has(loc)) {
+      issues.push({ severity: "warning", line, message: `Duplicate <loc>${loc}</loc>` });
+    }
+    seenLocs.add(loc);
+    const lastmod = extractSitemapTag(block, "lastmod");
+    if (lastmod !== void 0 && !isValidW3CDatetime(lastmod)) {
+      issues.push({ severity: "warning", line, message: `<lastmod>${lastmod}</lastmod> is not a valid W3C datetime` });
+    }
+    if (type === "urlset") {
+      const changefreq = extractSitemapTag(block, "changefreq");
+      if (changefreq !== void 0 && !VALID_CHANGEFREQ.has(changefreq.toLowerCase())) {
+        issues.push({ severity: "error", line, message: `<changefreq>${changefreq}</changefreq> must be one of: ${[...VALID_CHANGEFREQ].join(", ")}` });
+      }
+      const priority = extractSitemapTag(block, "priority");
+      if (priority !== void 0) {
+        const p = Number(priority);
+        if (Number.isNaN(p) || p < 0 || p > 1) {
+          issues.push({ severity: "error", line, message: `<priority>${priority}</priority> must be a number between 0.0 and 1.0` });
+        }
+      }
+      entries.push({ loc, lastmod, changefreq, priority, line });
+    } else {
+      entries.push({ loc, lastmod, line });
+    }
+  }
+  if (entries.length === 0) {
+    issues.push({ severity: "error", line: 1, message: `No <${blockTag}> entries found` });
+  }
+  if (type === "urlset" && entries.length > 5e4) {
+    issues.push({ severity: "error", line: 1, message: `Sitemap contains ${entries.length} URLs, exceeding the 50,000 URL limit per the sitemaps.org spec` });
+  }
+  const valid = !issues.some((i) => i.severity === "error");
+  return { type, urlCount: entries.length, entries, issues, valid };
+}
 
-export { DNS_RECORD_TYPES, HTTP_HEADERS, STATUS_CODES, buildDnsQueryUrl, buildGeoUrl, buildMapUrl, countryCodeToFlag, formatCoordinates, formatTtl, getByCategory, getHeader, getHeadersByCategory, getStatusByCategory, getStatusCode, isClientError, isServerError, isSuccess, isValidIp, isValidIpv4, isValidIpv6, network_exports, parseDnsResponse, parseGeoResponse, parseHar, searchHeaders, searchStatusCodes, statusCodeToText, typeNumberToLabel, validateDomain, validateHeaderName, validateHeaderValue };
+export { DNS_RECORD_TYPES, HTTP_HEADERS, STATUS_CODES, buildDnsQueryUrl, buildGeoUrl, buildMapUrl, countryCodeToFlag, formatCoordinates, formatTtl, getByCategory, getHeader, getHeadersByCategory, getStatusByCategory, getStatusCode, isClientError, isServerError, isSuccess, isValidIp, isValidIpv4, isValidIpv6, network_exports, parseDnsResponse, parseGeoResponse, parseHar, searchHeaders, searchStatusCodes, statusCodeToText, typeNumberToLabel, validateDomain, validateHeaderName, validateHeaderValue, validateSitemap };

package/dist/{chunk-DNCOIO5N.js → chunk-TINQFTLO.js}

@@ -7,6 +7,7 @@ var data_exports = {};
 __export(data_exports, {
   csvToJson: () => csvToJson,
   detectDelimiter: () => detectDelimiter,
+  diffEnvExample: () => diffEnvExample,
   envToExport: () => envToExport,
   envToJson: () => envToJson,
   formatNdjson: () => formatNdjson,
@@ -1081,6 +1082,23 @@ function envToExport(input) {
 function validateEnvKey(key) {
   return /^[A-Za-z_][A-Za-z0-9_]*$/.test(key);
 }
+function diffEnvExample(envInput, exampleInput) {
+  const envParsed = parseEnv(envInput);
+  if (envParsed.errors.length > 0) {
+    return { error: `.env: ${envParsed.errors.map((e) => `Line ${e.line}: ${e.message}`).join("; ")}` };
+  }
+  const exampleParsed = parseEnv(exampleInput);
+  if (exampleParsed.errors.length > 0) {
+    return { error: `.env.example: ${exampleParsed.errors.map((e) => `Line ${e.line}: ${e.message}`).join("; ")}` };
+  }
+  const envKeys = new Set(envParsed.entries.map((e) => e.key));
+  const exampleValues = new Map(exampleParsed.entries.map((e) => [e.key, e.value]));
+  const missingInExample = [...envKeys].filter((k) => !exampleValues.has(k)).sort();
+  const missingInEnv = [...exampleValues.keys()].filter((k) => !envKeys.has(k)).sort();
+  const emptyValueInExample = [...exampleValues.entries()].filter(([k, v]) => envKeys.has(k) && v === "").map(([k]) => k).sort();
+  const keysInBoth = [...envKeys].filter((k) => exampleValues.has(k)).length;
+  return { missingInExample, missingInEnv, emptyValueInExample, keysInBoth };
+}
 function validateNdjson(input) {
   const rawLines = input.split("\n");
   const lines = [];
@@ -1140,4 +1158,4 @@ function jsonArrayToNdjson(input) {
   return parsed.map((item) => JSON.stringify(item)).join("\n");
 }
 
-export { csvToJson, data_exports, detectDelimiter, envToExport, envToJson, formatNdjson, formatToml, formatXml, getSection, getSectionNames, getTomlStats, getXmlStats, getYamlStats, iniToJson, jsonArrayToNdjson, jsonToIni, jsonToToml, jsonToXml, minifyNdjson, minifyToml, minifyXml, ndjsonToJsonArray, parseCsv, parseEnv, parseIni, parseXmlToObject, stringifyIni, toCsvString, tomlToJson, validateEnvKey, validateIni, validateNdjson, validateToml, validateXml, validateYaml, xmlToJson };
+export { csvToJson, data_exports, detectDelimiter, diffEnvExample, envToExport, envToJson, formatNdjson, formatToml, formatXml, getSection, getSectionNames, getTomlStats, getXmlStats, getYamlStats, iniToJson, jsonArrayToNdjson, jsonToIni, jsonToToml, jsonToXml, minifyNdjson, minifyToml, minifyXml, ndjsonToJsonArray, parseCsv, parseEnv, parseIni, parseXmlToObject, stringifyIni, toCsvString, tomlToJson, validateEnvKey, validateIni, validateNdjson, validateToml, validateXml, validateYaml, xmlToJson };

package/dist/{data-CakDxAcT.d.ts → data-D8XTI7Du.d.cts}

@@ -10,6 +10,7 @@
  *  - csv-viewer      : detectDelimiter, parseCsv, csvToJson, toCsvString
  *  - ini-parser      : parseIni, stringifyIni, iniToJson, jsonToIni, getSection, getSectionNames, validateIni
  *  - env-parser      : parseEnv, envToJson, envToExport, validateEnvKey
+ *  - env-diff-checker: diffEnvExample
  *  - ndjson-formatter: validateNdjson, minifyNdjson, formatNdjson, ndjsonToJsonArray, jsonArrayToNdjson
  */
 interface ValidationResult {
@@ -168,6 +169,21 @@ declare function envToJson(input: string): string | {
 };
 declare function envToExport(input: string): string;
 declare function validateEnvKey(key: string): boolean;
+interface EnvDiffResult {
+    missingInExample: string[];
+    missingInEnv: string[];
+    emptyValueInExample: string[];
+    keysInBoth: number;
+}
+interface EnvDiffError {
+    error: string;
+}
+/**
+ * Diff a .env file against its .env.example template. Flags keys present in
+ * one file but not the other, plus keys that exist in both but whose
+ * .env.example value is an empty placeholder (i.e. undocumented default).
+ */
+declare function diffEnvExample(envInput: string, exampleInput: string): EnvDiffResult | EnvDiffError;
 interface NdjsonLineResult {
     line: number;
     raw: string;
@@ -196,6 +212,8 @@ declare function jsonArrayToNdjson(input: string): string | {
 };
 
 type data_CsvParseResult = CsvParseResult;
+type data_EnvDiffError = EnvDiffError;
+type data_EnvDiffResult = EnvDiffResult;
 type data_EnvEntry = EnvEntry;
 type data_EnvParseResult = EnvParseResult;
 type data_IniSection = IniSection;
@@ -209,6 +227,7 @@ type data_XmlFormatResult = XmlFormatResult;
 type data_XmlToJsonOptions = XmlToJsonOptions;
 declare const data_csvToJson: typeof csvToJson;
 declare const data_detectDelimiter: typeof detectDelimiter;
+declare const data_diffEnvExample: typeof diffEnvExample;
 declare const data_envToExport: typeof envToExport;
 declare const data_envToJson: typeof envToJson;
 declare const data_formatNdjson: typeof formatNdjson;
@@ -243,7 +262,7 @@ declare const data_validateXml: typeof validateXml;
 declare const data_validateYaml: typeof validateYaml;
 declare const data_xmlToJson: typeof xmlToJson;
 declare namespace data {
-  export { type data_CsvParseResult as CsvParseResult, type data_EnvEntry as EnvEntry, type data_EnvParseResult as EnvParseResult, type data_IniSection as IniSection, type data_NdjsonLineResult as NdjsonLineResult, type data_NdjsonValidateResult as NdjsonValidateResult, type data_ParseOptions as ParseOptions, type data_ParsedIni as ParsedIni, type data_TomlFormatResult as TomlFormatResult, type data_ValidationResult as ValidationResult, type data_XmlFormatResult as XmlFormatResult, type data_XmlToJsonOptions as XmlToJsonOptions, data_csvToJson as csvToJson, data_detectDelimiter as detectDelimiter, data_envToExport as envToExport, data_envToJson as envToJson, data_formatNdjson as formatNdjson, data_formatToml as formatToml, data_formatXml as formatXml, data_getSection as getSection, data_getSectionNames as getSectionNames, data_getTomlStats as getTomlStats, data_getXmlStats as getXmlStats, data_getYamlStats as getYamlStats, data_iniToJson as iniToJson, data_jsonArrayToNdjson as jsonArrayToNdjson, data_jsonToIni as jsonToIni, data_jsonToToml as jsonToToml, data_jsonToXml as jsonToXml, data_minifyNdjson as minifyNdjson, data_minifyToml as minifyToml, data_minifyXml as minifyXml, data_ndjsonToJsonArray as ndjsonToJsonArray, data_parseCsv as parseCsv, data_parseEnv as parseEnv, data_parseIni as parseIni, data_parseXmlToObject as parseXmlToObject, data_stringifyIni as stringifyIni, data_toCsvString as toCsvString, data_tomlToJson as tomlToJson, data_validateEnvKey as validateEnvKey, data_validateIni as validateIni, data_validateNdjson as validateNdjson, data_validateToml as validateToml, data_validateXml as validateXml, data_validateYaml as validateYaml, data_xmlToJson as xmlToJson };
+  export { type data_CsvParseResult as CsvParseResult, type data_EnvDiffError as EnvDiffError, type data_EnvDiffResult as EnvDiffResult, type data_EnvEntry as EnvEntry, type data_EnvParseResult as EnvParseResult, type data_IniSection as IniSection, type data_NdjsonLineResult as NdjsonLineResult, type data_NdjsonValidateResult as NdjsonValidateResult, type data_ParseOptions as ParseOptions, type data_ParsedIni as ParsedIni, type data_TomlFormatResult as TomlFormatResult, type data_ValidationResult as ValidationResult, type data_XmlFormatResult as XmlFormatResult, type data_XmlToJsonOptions as XmlToJsonOptions, data_csvToJson as csvToJson, data_detectDelimiter as detectDelimiter, data_diffEnvExample as diffEnvExample, data_envToExport as envToExport, data_envToJson as envToJson, data_formatNdjson as formatNdjson, data_formatToml as formatToml, data_formatXml as formatXml, data_getSection as getSection, data_getSectionNames as getSectionNames, data_getTomlStats as getTomlStats, data_getXmlStats as getXmlStats, data_getYamlStats as getYamlStats, data_iniToJson as iniToJson, data_jsonArrayToNdjson as jsonArrayToNdjson, data_jsonToIni as jsonToIni, data_jsonToToml as jsonToToml, data_jsonToXml as jsonToXml, data_minifyNdjson as minifyNdjson, data_minifyToml as minifyToml, data_minifyXml as minifyXml, data_ndjsonToJsonArray as ndjsonToJsonArray, data_parseCsv as parseCsv, data_parseEnv as parseEnv, data_parseIni as parseIni, data_parseXmlToObject as parseXmlToObject, data_stringifyIni as stringifyIni, data_toCsvString as toCsvString, data_tomlToJson as tomlToJson, data_validateEnvKey as validateEnvKey, data_validateIni as validateIni, data_validateNdjson as validateNdjson, data_validateToml as validateToml, data_validateXml as validateXml, data_validateYaml as validateYaml, data_xmlToJson as xmlToJson };
 }
 
-export { parseCsv as A, parseEnv as B, type CsvParseResult as C, parseIni as D, type EnvEntry as E, parseXmlToObject as F, stringifyIni as G, toCsvString as H, type IniSection as I, tomlToJson as J, validateEnvKey as K, validateIni as L, validateNdjson as M, type NdjsonLineResult as N, validateToml as O, type ParseOptions as P, validateXml as Q, validateYaml as R, xmlToJson as S, type TomlFormatResult as T, type ValidationResult as V, type XmlFormatResult as X, type EnvParseResult as a, type NdjsonValidateResult as b, type ParsedIni as c, data as d, type XmlToJsonOptions as e, csvToJson as f, detectDelimiter as g, envToExport as h, envToJson as i, formatNdjson as j, formatToml as k, formatXml as l, getSection as m, getSectionNames as n, getTomlStats as o, getXmlStats as p, getYamlStats as q, iniToJson as r, jsonArrayToNdjson as s, jsonToIni as t, jsonToToml as u, jsonToXml as v, minifyNdjson as w, minifyToml as x, minifyXml as y, ndjsonToJsonArray as z };
+export { minifyToml as A, minifyXml as B, type CsvParseResult as C, ndjsonToJsonArray as D, type EnvDiffError as E, parseCsv as F, parseEnv as G, parseIni as H, type IniSection as I, parseXmlToObject as J, stringifyIni as K, toCsvString as L, tomlToJson as M, type NdjsonLineResult as N, validateEnvKey as O, type ParseOptions as P, validateIni as Q, validateNdjson as R, validateToml as S, type TomlFormatResult as T, validateXml as U, type ValidationResult as V, validateYaml as W, type XmlFormatResult as X, xmlToJson as Y, type EnvDiffResult as a, type EnvEntry as b, type EnvParseResult as c, data as d, type NdjsonValidateResult as e, type ParsedIni as f, type XmlToJsonOptions as g, csvToJson as h, detectDelimiter as i, diffEnvExample as j, envToExport as k, envToJson as l, formatNdjson as m, formatToml as n, formatXml as o, getSection as p, getSectionNames as q, getTomlStats as r, getXmlStats as s, getYamlStats as t, iniToJson as u, jsonArrayToNdjson as v, jsonToIni as w, jsonToToml as x, jsonToXml as y, minifyNdjson as z };

package/dist/{data-CakDxAcT.d.cts → data-D8XTI7Du.d.ts}

@@ -10,6 +10,7 @@
  *  - csv-viewer      : detectDelimiter, parseCsv, csvToJson, toCsvString
  *  - ini-parser      : parseIni, stringifyIni, iniToJson, jsonToIni, getSection, getSectionNames, validateIni
  *  - env-parser      : parseEnv, envToJson, envToExport, validateEnvKey
+ *  - env-diff-checker: diffEnvExample
  *  - ndjson-formatter: validateNdjson, minifyNdjson, formatNdjson, ndjsonToJsonArray, jsonArrayToNdjson
  */
 interface ValidationResult {
@@ -168,6 +169,21 @@ declare function envToJson(input: string): string | {
 };
 declare function envToExport(input: string): string;
 declare function validateEnvKey(key: string): boolean;
+interface EnvDiffResult {
+    missingInExample: string[];
+    missingInEnv: string[];
+    emptyValueInExample: string[];
+    keysInBoth: number;
+}
+interface EnvDiffError {
+    error: string;
+}
+/**
+ * Diff a .env file against its .env.example template. Flags keys present in
+ * one file but not the other, plus keys that exist in both but whose
+ * .env.example value is an empty placeholder (i.e. undocumented default).
+ */
+declare function diffEnvExample(envInput: string, exampleInput: string): EnvDiffResult | EnvDiffError;
 interface NdjsonLineResult {
     line: number;
     raw: string;
@@ -196,6 +212,8 @@ declare function jsonArrayToNdjson(input: string): string | {
 };
 
 type data_CsvParseResult = CsvParseResult;
+type data_EnvDiffError = EnvDiffError;
+type data_EnvDiffResult = EnvDiffResult;
 type data_EnvEntry = EnvEntry;
 type data_EnvParseResult = EnvParseResult;
 type data_IniSection = IniSection;
@@ -209,6 +227,7 @@ type data_XmlFormatResult = XmlFormatResult;
 type data_XmlToJsonOptions = XmlToJsonOptions;
 declare const data_csvToJson: typeof csvToJson;
 declare const data_detectDelimiter: typeof detectDelimiter;
+declare const data_diffEnvExample: typeof diffEnvExample;
 declare const data_envToExport: typeof envToExport;
 declare const data_envToJson: typeof envToJson;
 declare const data_formatNdjson: typeof formatNdjson;
@@ -243,7 +262,7 @@ declare const data_validateXml: typeof validateXml;
 declare const data_validateYaml: typeof validateYaml;
 declare const data_xmlToJson: typeof xmlToJson;
 declare namespace data {
-  export { type data_CsvParseResult as CsvParseResult, type data_EnvEntry as EnvEntry, type data_EnvParseResult as EnvParseResult, type data_IniSection as IniSection, type data_NdjsonLineResult as NdjsonLineResult, type data_NdjsonValidateResult as NdjsonValidateResult, type data_ParseOptions as ParseOptions, type data_ParsedIni as ParsedIni, type data_TomlFormatResult as TomlFormatResult, type data_ValidationResult as ValidationResult, type data_XmlFormatResult as XmlFormatResult, type data_XmlToJsonOptions as XmlToJsonOptions, data_csvToJson as csvToJson, data_detectDelimiter as detectDelimiter, data_envToExport as envToExport, data_envToJson as envToJson, data_formatNdjson as formatNdjson, data_formatToml as formatToml, data_formatXml as formatXml, data_getSection as getSection, data_getSectionNames as getSectionNames, data_getTomlStats as getTomlStats, data_getXmlStats as getXmlStats, data_getYamlStats as getYamlStats, data_iniToJson as iniToJson, data_jsonArrayToNdjson as jsonArrayToNdjson, data_jsonToIni as jsonToIni, data_jsonToToml as jsonToToml, data_jsonToXml as jsonToXml, data_minifyNdjson as minifyNdjson, data_minifyToml as minifyToml, data_minifyXml as minifyXml, data_ndjsonToJsonArray as ndjsonToJsonArray, data_parseCsv as parseCsv, data_parseEnv as parseEnv, data_parseIni as parseIni, data_parseXmlToObject as parseXmlToObject, data_stringifyIni as stringifyIni, data_toCsvString as toCsvString, data_tomlToJson as tomlToJson, data_validateEnvKey as validateEnvKey, data_validateIni as validateIni, data_validateNdjson as validateNdjson, data_validateToml as validateToml, data_validateXml as validateXml, data_validateYaml as validateYaml, data_xmlToJson as xmlToJson };
+  export { type data_CsvParseResult as CsvParseResult, type data_EnvDiffError as EnvDiffError, type data_EnvDiffResult as EnvDiffResult, type data_EnvEntry as EnvEntry, type data_EnvParseResult as EnvParseResult, type data_IniSection as IniSection, type data_NdjsonLineResult as NdjsonLineResult, type data_NdjsonValidateResult as NdjsonValidateResult, type data_ParseOptions as ParseOptions, type data_ParsedIni as ParsedIni, type data_TomlFormatResult as TomlFormatResult, type data_ValidationResult as ValidationResult, type data_XmlFormatResult as XmlFormatResult, type data_XmlToJsonOptions as XmlToJsonOptions, data_csvToJson as csvToJson, data_detectDelimiter as detectDelimiter, data_diffEnvExample as diffEnvExample, data_envToExport as envToExport, data_envToJson as envToJson, data_formatNdjson as formatNdjson, data_formatToml as formatToml, data_formatXml as formatXml, data_getSection as getSection, data_getSectionNames as getSectionNames, data_getTomlStats as getTomlStats, data_getXmlStats as getXmlStats, data_getYamlStats as getYamlStats, data_iniToJson as iniToJson, data_jsonArrayToNdjson as jsonArrayToNdjson, data_jsonToIni as jsonToIni, data_jsonToToml as jsonToToml, data_jsonToXml as jsonToXml, data_minifyNdjson as minifyNdjson, data_minifyToml as minifyToml, data_minifyXml as minifyXml, data_ndjsonToJsonArray as ndjsonToJsonArray, data_parseCsv as parseCsv, data_parseEnv as parseEnv, data_parseIni as parseIni, data_parseXmlToObject as parseXmlToObject, data_stringifyIni as stringifyIni, data_toCsvString as toCsvString, data_tomlToJson as tomlToJson, data_validateEnvKey as validateEnvKey, data_validateIni as validateIni, data_validateNdjson as validateNdjson, data_validateToml as validateToml, data_validateXml as validateXml, data_validateYaml as validateYaml, data_xmlToJson as xmlToJson };
 }
 
-export { parseCsv as A, parseEnv as B, type CsvParseResult as C, parseIni as D, type EnvEntry as E, parseXmlToObject as F, stringifyIni as G, toCsvString as H, type IniSection as I, tomlToJson as J, validateEnvKey as K, validateIni as L, validateNdjson as M, type NdjsonLineResult as N, validateToml as O, type ParseOptions as P, validateXml as Q, validateYaml as R, xmlToJson as S, type TomlFormatResult as T, type ValidationResult as V, type XmlFormatResult as X, type EnvParseResult as a, type NdjsonValidateResult as b, type ParsedIni as c, data as d, type XmlToJsonOptions as e, csvToJson as f, detectDelimiter as g, envToExport as h, envToJson as i, formatNdjson as j, formatToml as k, formatXml as l, getSection as m, getSectionNames as n, getTomlStats as o, getXmlStats as p, getYamlStats as q, iniToJson as r, jsonArrayToNdjson as s, jsonToIni as t, jsonToToml as u, jsonToXml as v, minifyNdjson as w, minifyToml as x, minifyXml as y, ndjsonToJsonArray as z };
+export { minifyToml as A, minifyXml as B, type CsvParseResult as C, ndjsonToJsonArray as D, type EnvDiffError as E, parseCsv as F, parseEnv as G, parseIni as H, type IniSection as I, parseXmlToObject as J, stringifyIni as K, toCsvString as L, tomlToJson as M, type NdjsonLineResult as N, validateEnvKey as O, type ParseOptions as P, validateIni as Q, validateNdjson as R, validateToml as S, type TomlFormatResult as T, validateXml as U, type ValidationResult as V, validateYaml as W, type XmlFormatResult as X, xmlToJson as Y, type EnvDiffResult as a, type EnvEntry as b, type EnvParseResult as c, data as d, type NdjsonValidateResult as e, type ParsedIni as f, type XmlToJsonOptions as g, csvToJson as h, detectDelimiter as i, diffEnvExample as j, envToExport as k, envToJson as l, formatNdjson as m, formatToml as n, formatXml as o, getSection as p, getSectionNames as q, getTomlStats as r, getXmlStats as s, getYamlStats as t, iniToJson as u, jsonArrayToNdjson as v, jsonToIni as w, jsonToToml as x, jsonToXml as y, minifyNdjson as z };