@getvitops/astro 2.1.0 → 4.0.0

package/dist/index.mjs

@@ -1,9 +1,9 @@
 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";
@@ -204,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({
@@ -225,6 +225,39 @@ function resolveFonts(decls) {
 	};
 }
 
+//#endregion
+//#region src/tracking.ts
+/** The cookie the capture script writes. Mirrors `TRACKING_COOKIE` in utils. */
+const TRACKING_COOKIE = "_ac";
+/**
+* Resolve the tracking config into what the component emits.
+*
+* Two warnings, both about the same failure — a persistent identifier written
+* with no way for the visitor to decline, or a permission asked for with no way
+* to answer. Returned as data rather than logged here so the check is a test
+* rather than a line someone might scroll past, exactly as `resolveAnalytics`
+* does.
+*/
+function resolveTracking(opts, ctx = {}) {
+	const warnings = [];
+	const category = opts?.category ?? "marketing";
+	const enabled = opts?.enabled === true;
+	if (!enabled) return {
+		enabled: false,
+		category,
+		cookies: [],
+		warnings
+	};
+	if (!ctx.consent) warnings.push(`tracking is on, so this site writes the \`${"_ac"}\` cookie — a 90-day identifier tying a visitor to the ad that brought them — and \`consent\` is off, so it is written for every visitor with no way to decline. Set \`consent: true\`.`);
+	else if (ctx.consentCategories && !ctx.consentCategories.includes(category)) warnings.push(`tracking demands the \`${category}\` consent category, but the banner offers ${ctx.consentCategories.join(", ") || "nothing"}. Add \`${category}\` to \`consent.categories\`, or the visitor is asked about something the banner never names.`);
+	return {
+		enabled,
+		category,
+		cookies: ["_ac"],
+		warnings
+	};
+}
+
 //#endregion
 //#region src/integration.ts
 /**
@@ -237,11 +270,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
@@ -259,7 +292,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 [];
 	}
@@ -328,14 +361,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 }) => {
@@ -347,10 +380,10 @@ function getvitops(opts = {}) {
 			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.");
@@ -358,9 +391,18 @@ function getvitops(opts = {}) {
 			const consentEnabled = !!opts.consent;
 			const consentOpts = typeof opts.consent === "object" ? opts.consent : {};
 			const analytics = resolveAnalytics(opts.analytics, { consent: consentEnabled });
+			const trackingOpts = opts.tracking === true ? { enabled: true } : opts.tracking || void 0;
 			const detectedCategories = consentCategories(analytics.tags);
-			const offeredCategories = consentOpts.categories ?? (detectedCategories.length ? detectedCategories : ["analytics"]);
+			const defaultCategories = ["analytics", "preferences"];
+			const trackingCategory = trackingOpts?.enabled ? trackingOpts.category ?? "marketing" : null;
+			if (detectedCategories.includes("marketing") || trackingCategory === "marketing") defaultCategories.push("marketing");
+			const offeredCategories = consentOpts.categories ?? defaultCategories;
 			for (const warning of analytics.warnings) logger.warn(warning);
+			const tracking = resolveTracking(trackingOpts, {
+				consent: consentEnabled,
+				consentCategories: offeredCategories
+			});
+			for (const warning of tracking.warnings) logger.warn(warning);
 			if (opts.analytics && legalInput) {
 				const undisclosed = undisclosedProviders(resolve(root, legalInput), opts.analytics);
 				if (undisclosed.length) logger.warn(`analytics: ${undisclosed.join(", ")} ${undisclosed.length === 1 ? "is" : "are"} configured here but absent from your site config's \`analytics\` block, so the cookie notice \`legal\` generates will not disclose ${undisclosed.length === 1 ? "it" : "them"}. Add ${undisclosed.map((k) => SITE_CONFIG_KEYS[k]).join(", ")} to ${legalInput}.`);
@@ -395,8 +437,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.");
@@ -441,7 +483,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;
@@ -451,7 +493,7 @@ function getvitops(opts = {}) {
 				}
 			}
 			if (siteInput) try {
-				const key = resolveSiteConfig(JSON.parse(readFileSync(resolve(root, siteInput), "utf8")), opts.site?.siteEnv ?? "production").seo?.indexing?.indexNow?.key;
+				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`);
@@ -558,13 +600,18 @@ function getvitops(opts = {}) {
 				consent: consentEnabled,
 				consentCategories: offeredCategories,
 				consentPolicyUrl: consentOpts.policyUrl ?? null,
-				consentRuntime
+				consentRuntime,
+				tracking: tracking.enabled ? {
+					enabled: true,
+					category: tracking.category,
+					cookies: tracking.cookies
+				} : null
 			})] } });
 			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,
@@ -587,7 +634,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());
 				}
@@ -609,7 +656,7 @@ function getvitops(opts = {}) {
 * 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
+* `vitops search notify`, 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.
 *
@@ -714,7 +761,7 @@ async function commitDates(dirs, cwd) {
 */
 async function gitLastmod(options = {}) {
 	const cwd = options.cwd ?? process.cwd();
-	const warn = options.onWarn ?? ((m) => console.warn(`[getvitops] gitLastmod: ${m}`));
+	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) {
@@ -886,5 +933,5 @@ function resolveSeo(defaults, props, ctx) {
 }
 
 //#endregion
-export { consentCategories, getvitops as default, gitLastmod, resolveAnalytics, resolveSeo, routeFromPage, slugFromContent };
+export { TRACKING_COOKIE, consentCategories, vitops as default, gitLastmod, resolveAnalytics, resolveSeo, resolveTracking, routeFromPage, slugFromContent };
 //# sourceMappingURL=index.mjs.map