@getvitops/astro 2.0.0 → 3.0.0

package/dist/index.mjs

@@ -1,10 +1,12 @@
-import { cpSync, existsSync, readFileSync } from "node:fs";
+import { cpSync, existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname, join, relative, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
-import { isSiteConfig, resolveSiteConfig } from "@getvitops/generator";
+import { isConfig, resolveConfig } from "@getvitops/generator";
 import { collectIconRefs, faviconLinks, generateFavicons, generateIconInclude, resolveIcon, scanFiles, writeFaviconManifest } from "@getvitops/utils";
-import vitops from "@getvitops/vite";
+import vitopsPlugin from "@getvitops/vite";
 import { fontProviders } from "astro/config";
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
 
 export * from "@getvitops/utils"
 
@@ -202,10 +204,10 @@ function resolveFonts(decls) {
 	const head = [];
 	const seen = /* @__PURE__ */ new Set();
 	for (const decl of decls) {
-		if (!PROVIDERS.has(decl.provider)) throw new Error(`[getvitops] fonts: unknown provider "${decl.provider}" for "${decl.name}". Astro provides: ${[...PROVIDERS].sort().join(", ")}.`);
-		if (NEEDS_OPTIONS.has(decl.provider)) throw new Error(`[getvitops] fonts: provider "${decl.provider}" needs an API id from your environment ("${decl.name}"), and a JSON declaration has nowhere to hold one. Declare this family in astro.config instead — fonts: [{ provider: fontProviders.${decl.provider}({ id: process.env.ADOBE_ID }), name: '${decl.name}', cssVariable: '${decl.cssVariable}' }] — and render its <Font /> yourself; the design-system token can still point at it.`);
-		if (!decl.cssVariable.startsWith("--")) throw new Error(`[getvitops] fonts: cssVariable "${decl.cssVariable}" (${decl.name}) must start with "--".`);
-		if (seen.has(decl.cssVariable)) throw new Error(`[getvitops] fonts: two families both declare ${decl.cssVariable} (the second is "${decl.name}"). Astro resolves one family per variable — give them separate variables, or drop one.`);
+		if (!PROVIDERS.has(decl.provider)) throw new Error(`[vitops] fonts: unknown provider "${decl.provider}" for "${decl.name}". Astro provides: ${[...PROVIDERS].sort().join(", ")}.`);
+		if (NEEDS_OPTIONS.has(decl.provider)) throw new Error(`[vitops] fonts: provider "${decl.provider}" needs an API id from your environment ("${decl.name}"), and a JSON declaration has nowhere to hold one. Declare this family in astro.config instead — fonts: [{ provider: fontProviders.${decl.provider}({ id: process.env.ADOBE_ID }), name: '${decl.name}', cssVariable: '${decl.cssVariable}' }] — and render its <Font /> yourself; the design-system token can still point at it.`);
+		if (!decl.cssVariable.startsWith("--")) throw new Error(`[vitops] fonts: cssVariable "${decl.cssVariable}" (${decl.name}) must start with "--".`);
+		if (seen.has(decl.cssVariable)) throw new Error(`[vitops] fonts: two families both declare ${decl.cssVariable} (the second is "${decl.name}"). Astro resolves one family per variable — give them separate variables, or drop one.`);
 		seen.add(decl.cssVariable);
 		const { provider, preload, ...rest } = decl;
 		fonts.push({
@@ -235,11 +237,11 @@ function resolveFonts(decls) {
 * config from the `virtual:getvitops/head` module this integration provides.
 */
 /**
-* Which providers `getvitops({ analytics })` configures that the site config's
+* Which providers `vitops({ analytics })` configures that the site config's
 * own `analytics` block does not.
 *
 * The two are separate surfaces on purpose — the integration must not import
-* `SiteConfig` — but they describe the same site, and a disagreement between them
+* `Config` — but they describe the same site, and a disagreement between them
 * is a compliance defect rather than a style issue: `vitops legal` derives the
 * cookie notice from the site config, so a provider missing there is a tag the
 * site runs and its own notice never mentions. That is precisely what the
@@ -257,7 +259,7 @@ const SITE_CONFIG_KEYS = {
 function undisclosedProviders(configPath, analytics) {
 	let declared;
 	try {
-		declared = JSON.parse(readFileSync(configPath, "utf8")).analytics ?? {};
+		declared = JSON.parse(readFileSync(configPath, "utf8")).site?.analytics ?? {};
 	} catch {
 		return [];
 	}
@@ -326,14 +328,14 @@ async function probeIconPackage(name) {
 * the build here would turn "your JSON has a trailing comma" into an error about
 * an option the consumer never set.
 */
-function readsAsSiteConfig(path) {
+function readsAsConfig(path) {
 	try {
-		return isSiteConfig(JSON.parse(readFileSync(path, "utf8")));
+		return isConfig(JSON.parse(readFileSync(path, "utf8")));
 	} catch {
 		return false;
 	}
 }
-function getvitops(opts = {}) {
+function vitops(opts = {}) {
 	return {
 		name: "@getvitops/astro",
 		hooks: { "astro:config:setup": async ({ config, updateConfig, injectScript, logger }) => {
@@ -343,11 +345,12 @@ function getvitops(opts = {}) {
 			const editor = opts.editor === true;
 			if (editor && !opts.css) logger.warn("editor: true needs a `css` config — it reads design-manifest.json.");
 			if (opts.legal && !opts.css) logger.warn("legal: needs a `css` config — the generation runs in the Vite plugin that `css` registers. Run `npx vitops legal` instead if you do not use `css`.");
+			if (opts.media && !opts.css) logger.warn("media: needs a `css` config — the encoding runs in the Vite plugin that `css` registers. Run `npx vitops media` instead if you do not use `css`.");
 			const cssInput = opts.css ? opts.css.input ?? "design-system.json" : void 0;
-			const siteInput = opts.site?.input ?? (cssInput != null && readsAsSiteConfig(resolve(root, cssInput)) ? cssInput : void 0);
+			const siteInput = opts.site?.input ?? (cssInput != null && readsAsConfig(resolve(root, cssInput)) ? cssInput : void 0);
 			if (opts.site && !opts.css) logger.warn("site: needs a `css` config — it is read during generation, which runs in the Vite plugin that `css` registers. Without it the site config changes nothing here.");
 			const legalInput = opts.legal?.input ?? siteInput;
-			if (opts.legal && !legalInput) throw new Error("[getvitops] legal: needs `legal.input` (a site config path), the top-level `site` option, or a `css.input` that is itself a site config.");
+			if (opts.legal && !legalInput) throw new Error("[vitops] legal: needs `legal.input` (a site config path), the top-level `site` option, or a `css.input` that is itself a site config.");
 			if (opts.seo) {
 				if (!config.site) logger.warn("seo: needs the `site` astro.config option (your deployed URL) — without it <Seo /> omits canonical, og:url and any relative og:image rather than guessing an origin.");
 				if (config.integrations.some((i) => i.name === "emdash")) logger.warn("seo: emdash() is registered, and its <EmDashHead> emits the same title/description/canonical/og tags from the CMS. Use one or the other — rendering both duplicates every tag.");
@@ -392,8 +395,8 @@ function getvitops(opts = {}) {
 				};
 				const declared = [];
 				if (o.input) {
-					const site = resolveSiteConfig(JSON.parse(readFileSync(resolve(root, o.input), "utf8")), o.siteEnv ?? "production");
-					declared.push(...site.fonts ?? []);
+					const cfg = resolveConfig(JSON.parse(readFileSync(resolve(root, o.input), "utf8")), o.siteEnv ?? "production");
+					declared.push(...cfg.site.fonts ?? []);
 				}
 				declared.push(...o.families ?? []);
 				if (declared.length === 0) logger.warn("fonts: nothing declared — no webfonts will load. Add families, or drop the option.");
@@ -438,7 +441,7 @@ function getvitops(opts = {}) {
 					try {
 						({default: sitemap} = await import("@astrojs/sitemap"));
 					} catch {
-						throw new Error("[getvitops] sitemap requires `@astrojs/sitemap` in your devDependencies — install it, or drop the `sitemap` option.");
+						throw new Error("[vitops] sitemap requires `@astrojs/sitemap` in your devDependencies — install it, or drop the `sitemap` option.");
 					}
 					if (config.output === "server") logger.warn("sitemap: output: 'server' — @astrojs/sitemap lists prerendered routes only, so on-demand pages are left out. Add `export const prerender = true` to the pages you want indexed, or list them in `sitemap.customPages`.");
 					const sitemapOpts = opts.sitemap === true ? void 0 : opts.sitemap;
@@ -447,6 +450,16 @@ function getvitops(opts = {}) {
 					logger.info(`sitemap registered → ${sitemapHref.slice(1)}`);
 				}
 			}
+			if (siteInput) try {
+				const key = resolveConfig(JSON.parse(readFileSync(resolve(root, siteInput), "utf8")), opts.site?.siteEnv ?? "production").site.seo?.indexing?.indexNow?.key;
+				if (key) {
+					mkdirSync(publicDir, { recursive: true });
+					writeFileSync(join(publicDir, `${key}.txt`), `${key}\n`);
+					logger.info(`IndexNow key file → public/${key}.txt`);
+				}
+			} catch (err) {
+				logger.warn(`IndexNow key file skipped: ${err.message}`);
+			}
 			let iconsData = null;
 			if (opts.icons) {
 				const o = opts.icons === true ? {} : opts.icons;
@@ -549,9 +562,9 @@ function getvitops(opts = {}) {
 			})] } });
 			if (opts.css) {
 				const format = opts.css.format ?? "tailwind";
-				if (format === "design") throw new Error("[getvitops] css.format: 'design' emits only DESIGN.md, not a stylesheet. Run `npx vitops generate --format design --out .` for that file, and set css.format to 'tailwind' | 'css' | 'bricks' here.");
+				if (format === "design") throw new Error("[vitops] css.format: 'design' emits only DESIGN.md, not a stylesheet. Run `npx vitops generate --format design --out .` for that file, and set css.format to 'tailwind' | 'css' | 'bricks' here.");
 				const out = opts.css.out ?? "src/styles";
-				const plugins = [vitops({
+				const plugins = [vitopsPlugin({
 					input: opts.css.input ?? "design-system.json",
 					...opts.css.theme != null ? { theme: opts.css.theme } : {},
 					format,
@@ -562,6 +575,7 @@ function getvitops(opts = {}) {
 						...opts.legal,
 						input: legalInput
 					} } : {},
+					...opts.media ? { media: opts.media } : {},
 					...opts.site ? { site: opts.site } : {},
 					...opts.css.systemColorScheme != null ? { systemColorScheme: opts.css.systemColorScheme } : {}
 				})];
@@ -573,7 +587,7 @@ function getvitops(opts = {}) {
 							TAILWIND_VITE
 ));
 					} catch {
-						throw new Error("[getvitops] css.format: 'tailwind' requires `tailwindcss` and `@tailwindcss/vite` in your devDependencies — install them, or switch to css.format: 'css' for the standalone bundle.");
+						throw new Error("[vitops] css.format: 'tailwind' requires `tailwindcss` and `@tailwindcss/vite` in your devDependencies — install them, or switch to css.format: 'css' for the standalone bundle.");
 					}
 					plugins.push(...tailwindcss());
 				}
@@ -589,6 +603,166 @@ function getvitops(opts = {}) {
 	};
 }
 
+//#endregion
+//#region src/lastmod.ts
+/**
+* Real per-page `<lastmod>` for the sitemap, derived from git.
+*
+* This is the one lever that reliably moves Google. It is also load-bearing for
+* `vitops indexing`, which decides what to submit by diffing lastmod against the
+* previous build — with no lastmod, that diff can see pages appear and disappear
+* but never see one *change*, so an edited page is never resubmitted.
+*
+* A plain exported helper rather than magic inside the `sitemap` option, because
+* it carries a caveat the caller needs to see: it shells out to `git`, so it
+* returns nothing useful from a shallow CI clone (`fetch-depth: 1` — the default
+* in actions/checkout) or from a tarball with no history. In that case it warns
+* and emits no dates at all.
+*
+*     import vitops, { gitLastmod } from '@getvitops/astro';
+*     export default defineConfig({
+*       site: 'https://acme.ca',
+*       integrations: [vitops({ sitemap: { serialize: await gitLastmod() } })],
+*     });
+*
+* **No date beats a wrong date.** An unmatched URL is left alone rather than
+* stamped with the build time: Google weighs lastmod only while it stays
+* consistent with what actually changed, and a site that stamps every page on
+* every deploy teaches it to stop believing the field — site-wide, not just for
+* the pages that were wrong.
+*/
+const exec = promisify(execFile);
+/** Route-bearing sources: file-based pages, and the collections they render. */
+const DEFAULT_DIRS = [
+	"src/pages",
+	"src/content",
+	"src/data"
+];
+const PAGE_EXT = /\.(astro|md|mdx|markdown|html)$/;
+const CONTENT_EXT = /\.(md|mdx|markdown|json|yaml|yml)$/;
+/**
+* `src/pages/blog/index.astro` → `/blog`; `src/pages/index.astro` → `/`.
+*
+* Dynamic routes return `undefined`: one source file backs many URLs, and its
+* commit date describes the template rather than any of them. Stamping every
+* generated page with the template's date is exactly the "wrong date" case above.
+*/
+function routeFromPage(file) {
+	const m = /(?:^|\/)src\/pages\/(.+)$/.exec(file);
+	if (!m) return void 0;
+	let rest = m[1];
+	if (!PAGE_EXT.test(rest)) return void 0;
+	if (rest.includes("[")) return void 0;
+	rest = rest.replace(PAGE_EXT, "");
+	if (rest === "index") return "/";
+	rest = rest.replace(/\/index$/, "");
+	return `/${rest}`;
+}
+/** The slug a content entry is most likely published under. */
+function slugFromContent(file) {
+	const m = /(?:^|\/)src\/(?:content|data)\/(.+)$/.exec(file);
+	if (!m) return void 0;
+	const rest = m[1];
+	if (!CONTENT_EXT.test(rest)) return void 0;
+	const base = rest.split("/").pop().replace(CONTENT_EXT, "");
+	return base === "index" ? void 0 : base;
+}
+const normalise = (pathname) => {
+	const p = pathname.replace(/\/+$/, "");
+	return p === "" ? "/" : p;
+};
+/**
+* Most recent commit date per file, from one `git log` pass.
+*
+* One process rather than one per file: a `git log -1` per page is fine for
+* twenty pages and unusable for two thousand. `--name-only` interleaves each
+* commit's date with its files, and because `git log` is newest-first the first
+* time a path appears is its latest change.
+*/
+async function commitDates(dirs, cwd) {
+	const dates = /* @__PURE__ */ new Map();
+	const { stdout } = await exec("git", [
+		"log",
+		"--date-order",
+		"--pretty=format:%x00%cI",
+		"--name-only",
+		"--",
+		...dirs
+	], {
+		cwd,
+		maxBuffer: 64 * 1024 * 1024
+	});
+	let current;
+	for (const line of stdout.split("\n")) {
+		if (line.startsWith("\0")) {
+			current = line.slice(1).trim();
+			continue;
+		}
+		const file = line.trim();
+		if (!file || !current) continue;
+		if (!dates.has(file)) dates.set(file, current);
+	}
+	return dates;
+}
+/**
+* Build a `serialize` function that stamps `lastmod` from git history.
+*
+* Resolution order per URL: an exact file-based route first, then a unique
+* content slug. "Unique" is doing real work — a slug appearing in two collections
+* is dropped rather than guessed at, since picking either one would be a coin
+* flip presented as a fact.
+*/
+async function gitLastmod(options = {}) {
+	const cwd = options.cwd ?? process.cwd();
+	const warn = options.onWarn ?? ((m) => console.warn(`[vitops] gitLastmod: ${m}`));
+	const dirs = (options.dirs ?? DEFAULT_DIRS).filter((d) => existsSync(`${cwd}/${d}`));
+	const identity = (item) => item;
+	if (dirs.length === 0) {
+		warn(`none of ${(options.dirs ?? DEFAULT_DIRS).join(", ")} exist — no dates emitted`);
+		return identity;
+	}
+	let dates;
+	try {
+		dates = await commitDates(dirs, cwd);
+	} catch (err) {
+		warn(`git log failed (${err.message}) — no dates emitted`);
+		return identity;
+	}
+	if (dates.size === 0) {
+		warn("git history has no commits touching your source — a shallow clone? Set fetch-depth: 0 in your checkout step. No dates emitted.");
+		return identity;
+	}
+	const byRoute = /* @__PURE__ */ new Map();
+	const bySlug = /* @__PURE__ */ new Map();
+	const ambiguous = /* @__PURE__ */ new Set();
+	for (const [file, date] of dates) {
+		const route = routeFromPage(file);
+		if (route) {
+			byRoute.set(route, date);
+			continue;
+		}
+		const slug = slugFromContent(file);
+		if (!slug) continue;
+		if (bySlug.has(slug)) ambiguous.add(slug);
+		else bySlug.set(slug, date);
+	}
+	for (const slug of ambiguous) bySlug.delete(slug);
+	return (item) => {
+		if (item.lastmod) return item;
+		let pathname;
+		try {
+			pathname = normalise(new URL(item.url).pathname);
+		} catch {
+			return item;
+		}
+		const date = byRoute.get(pathname) ?? bySlug.get(pathname.split("/").pop() ?? "");
+		return date ? {
+			...item,
+			lastmod: date
+		} : item;
+	};
+}
+
 //#endregion
 //#region src/seo.ts
 /** `en-CA` → `en_CA`; Open Graph wants the underscore form. */
@@ -712,5 +886,5 @@ function resolveSeo(defaults, props, ctx) {
 }
 
 //#endregion
-export { consentCategories, getvitops as default, resolveAnalytics, resolveSeo };
+export { consentCategories, vitops as default, gitLastmod, resolveAnalytics, resolveSeo, routeFromPage, slugFromContent };
 //# sourceMappingURL=index.mjs.map