@intentius/chant-lexicon-terraform 0.124.54 → 0.124.56

package/dist/module-catalog/index.js

@@ -0,0 +1,110 @@
+/**
+ * The known-module catalog (chant#4560): choudoufu's module compatibility
+ * table (choudoufu#2292, `live/module-compat.json`), vendored in
+ * `./static-tier.ts` and read by TF047 and by terragucci's tip and estate
+ * column (terragucci#1286).
+ *
+ * The catalog holds the static tier only. A static row is one
+ * terraform-aws-modules example at one tag, measured offline by choudoufu's
+ * refusal probe in the onboarded form: `clear` means `choudoufu live-check`
+ * plans it, `refused` lists choudoufu refusal IDs with site counts. The
+ * gauntlet tier (end-to-end runs against an emulator) is a separate table in
+ * choudoufu, has no rows until choudoufu#2291's run, and is never folded into
+ * these numbers: every result here carries `tier: "static"`, and a figure in
+ * it counts static rows only.
+ *
+ * This subpath, `@intentius/chant-lexicon-terraform/module-catalog`, imports
+ * nothing but its own data, so a consumer can load it on its own.
+ */
+import { SOURCE_COMMIT, SOURCE_PATH, STATIC_MEASUREMENT, STATIC_ROWS } from "./static-tier.js";
+/** Where the vendored rows came from. */
+export const MODULE_CATALOG_SOURCE = {
+    repo: "INTENTIUS/choudoufu",
+    path: SOURCE_PATH,
+    commit: SOURCE_COMMIT,
+    /** The static tier's measurement date. */
+    date: STATIC_MEASUREMENT.date,
+    /** The choudoufu commit the static tier was measured at. */
+    measuredAt: STATIC_MEASUREMENT.commit,
+    /** The hashicorp/aws provider version the static tier was measured with. */
+    awsProvider: STATIC_MEASUREMENT.aws_provider,
+};
+/** choudoufu's site page that renders both tiers. */
+export const MODULE_COMPATIBILITY_PAGE = "https://intentius.io/choudoufu/aws/compatibility/#modules";
+/** Every static row, as vendored. */
+export const staticRows = STATIC_ROWS;
+/**
+ * The registry address of a module source, without a registry host, a
+ * `//subdir` or a query, lowercased: `registry.terraform.io/terraform-aws-modules/iam/aws//modules/iam-role`
+ * gives `terraform-aws-modules/iam/aws`. Undefined when the source is not a
+ * three-part registry address.
+ */
+export function registryModuleAddress(source) {
+    let s = source.trim().split("?")[0];
+    const sub = s.indexOf("//");
+    if (sub >= 0)
+        s = s.slice(0, sub);
+    const parts = s.split("/");
+    if (parts.length === 4 && parts[0].includes("."))
+        parts.shift();
+    if (parts.length !== 3 || parts.some((p) => !/^[A-Za-z0-9][A-Za-z0-9_.-]*$/.test(p)))
+        return undefined;
+    return parts.join("/").toLowerCase();
+}
+/** `= 1.4.0`, `v1.4.0` and `1.4.0` all give `1.4.0`; a range gives undefined. */
+export function exactModuleVersion(version) {
+    const v = version.trim().replace(/^=\s*/, "").replace(/^v/, "");
+    return /^\d+(?:\.\d+){0,2}(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/.test(v) ? v : undefined;
+}
+const bare = (version) => version.replace(/^v/, "");
+function byModule() {
+    const out = new Map();
+    for (const row of STATIC_ROWS) {
+        const key = row.module.toLowerCase();
+        const list = out.get(key) ?? [];
+        list.push(row);
+        out.set(key, list);
+    }
+    return out;
+}
+let index;
+/**
+ * The catalog's answer for a module `source` pinned at `version`, or
+ * undefined when the source is not a registry address or the version is not
+ * exact (a range is TF039's finding, and the catalog has no row for one).
+ */
+export function moduleCompatibility(source, version) {
+    const module = registryModuleAddress(source);
+    const pinned = exactModuleVersion(version);
+    if (module === undefined || pinned === undefined)
+        return undefined;
+    index ?? (index = byModule());
+    const rows = index.get(module) ?? [];
+    const measuredVersions = [...new Set(rows.map((r) => bare(r.version)))].sort();
+    const at = rows.filter((r) => bare(r.version) === pinned && r.verdict !== "unmeasured");
+    const refusedRows = at.filter((r) => r.verdict === "refused");
+    const refusals = new Map();
+    for (const row of refusedRows) {
+        for (const r of row.refusals) {
+            const s = refusals.get(r.id) ?? { id: r.id, sites: 0, docsUrl: r.docs_url, examples: [] };
+            s.sites += r.sites;
+            if (!s.examples.includes(row.example))
+                s.examples.push(row.example);
+            refusals.set(r.id, s);
+        }
+    }
+    for (const s of refusals.values())
+        s.examples.sort();
+    const status = rows.length === 0 ? "unknown-module" : at.length === 0 ? "unknown-version" : refusedRows.length > 0 ? "refused" : "clear";
+    return {
+        module,
+        version: pinned,
+        tier: "static",
+        status,
+        examples: at.length,
+        clearExamples: at.filter((r) => r.verdict === "clear").length,
+        refusedExamples: refusedRows.length,
+        refusals: [...refusals.values()].sort((a, b) => b.examples.length - a.examples.length || a.id.localeCompare(b.id)),
+        measuredVersions,
+    };
+}

package/dist/module-catalog/refresh-cli.d.ts

@@ -0,0 +1,4 @@
+import { type StaticMeasurement, type StaticRow } from "./types.js";
+/** The TypeScript source of `static-tier.ts` for one snapshot. */
+export declare function renderStaticTier(commit: string, measurement: StaticMeasurement, rows: readonly StaticRow[]): string;
+//# sourceMappingURL=refresh-cli.d.ts.map

package/dist/module-catalog/refresh-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh-cli.d.ts","sourceRoot":"","sources":["../../src/module-catalog/refresh-cli.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAqB,KAAK,iBAAiB,EAAE,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AASpF,kEAAkE;AAClE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,SAAS,SAAS,EAAE,GAAG,MAAM,CAiBnH"}

package/dist/module-catalog/refresh-cli.js

@@ -0,0 +1,64 @@
+/**
+ * Refresh the vendored known-module catalog (chant#4560) from choudoufu's
+ * module compatibility table.
+ *
+ *   npm run --prefix lexicons/terraform module-catalog:refresh -- <choudoufu checkout> [ref]
+ *
+ * It reads `live/module-compat.json` at `ref` (default `origin/main`) with
+ * `git show`, so the checkout's working tree is never read and a local edit
+ * cannot leak into the snapshot. The header of the written file names the
+ * source path and the choudoufu commit that last changed the table at that
+ * ref, so a reader can check the snapshot against its source with
+ * `git -C <choudoufu> show <commit>:live/module-compat.json`.
+ *
+ * Only the static tier is vendored. choudoufu keeps the gauntlet tier in a
+ * separate array and the two tiers share no figure (choudoufu#2292 ruling);
+ * the gauntlet array stays out until it has rows (choudoufu#2291), and then
+ * comes in as its own export, never folded into the static rows.
+ */
+import { execFileSync } from "node:child_process";
+import { writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { parseModuleCompat } from "./types.js";
+const SOURCE_PATH = "live/module-compat.json";
+const OUT = join(dirname(fileURLToPath(import.meta.url)), "static-tier.ts");
+function git(dir, ...args) {
+    return execFileSync("git", ["-C", dir, ...args], { encoding: "utf8", maxBuffer: 64 * 1024 * 1024 });
+}
+/** The TypeScript source of `static-tier.ts` for one snapshot. */
+export function renderStaticTier(commit, measurement, rows) {
+    return [
+        "// Code generated by src/module-catalog/refresh-cli.ts. DO NOT EDIT.",
+        "//",
+        `// Vendored from INTENTIUS/choudoufu ${SOURCE_PATH} at commit`,
+        `// ${commit}, static tier only (chant#4560).`,
+        "// The gauntlet tier is a separate array in that file and is not vendored here.",
+        "import type { StaticMeasurement, StaticRow } from \"./types\";",
+        "",
+        `export const SOURCE_PATH = ${JSON.stringify(SOURCE_PATH)};`,
+        `export const SOURCE_COMMIT = ${JSON.stringify(commit)};`,
+        "",
+        `export const STATIC_MEASUREMENT: StaticMeasurement = ${JSON.stringify(measurement, null, 2)};`,
+        "",
+        `export const STATIC_ROWS: readonly StaticRow[] = ${JSON.stringify(rows, null, 2)};`,
+        "",
+    ].join("\n");
+}
+function main(argv) {
+    const [dir, ref = "origin/main"] = argv;
+    if (!dir) {
+        console.error("usage: refresh-cli.ts <choudoufu checkout> [ref]");
+        process.exit(2);
+    }
+    const commit = git(dir, "log", "-1", "--format=%H", ref, "--", SOURCE_PATH).trim();
+    if (!/^[0-9a-f]{40}$/.test(commit)) {
+        console.error(`${SOURCE_PATH} has no history at ${ref} in ${dir}`);
+        process.exit(1);
+    }
+    const file = parseModuleCompat(JSON.parse(git(dir, "show", `${commit}:${SOURCE_PATH}`)));
+    writeFileSync(OUT, renderStaticTier(commit, file.static_measurement, file.static));
+    console.log(`module catalog: ${file.static.length} static rows from ${SOURCE_PATH} at ${commit}`);
+}
+if (process.argv[1] && fileURLToPath(import.meta.url) === process.argv[1])
+    main(process.argv.slice(2));

package/dist/module-catalog/static-tier.d.ts

@@ -0,0 +1,6 @@
+import type { StaticMeasurement, StaticRow } from "./types.js";
+export declare const SOURCE_PATH = "live/module-compat.json";
+export declare const SOURCE_COMMIT = "39a143679a6f5ffeae7dc186190049e8b55f7149";
+export declare const STATIC_MEASUREMENT: StaticMeasurement;
+export declare const STATIC_ROWS: readonly StaticRow[];
+//# sourceMappingURL=static-tier.d.ts.map

package/dist/module-catalog/static-tier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"static-tier.d.ts","sourceRoot":"","sources":["../../src/module-catalog/static-tier.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE5D,eAAO,MAAM,WAAW,4BAA4B,CAAC;AACrD,eAAO,MAAM,aAAa,6CAA6C,CAAC;AAExE,eAAO,MAAM,kBAAkB,EAAE,iBAkHhC,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,SAAS,SAAS,EA4/C3C,CAAC"}