@getvitops/astro 8.2.0-alpha.0 → 8.3.0-alpha.0

package/src/seo.ts

@@ -20,11 +20,12 @@ export type SeoOgType = 'website' | 'article' | 'profile';
  * Site-level SEO defaults, passed to `vitops({ seo })` and baked into the
  * `virtual:getvitops/head` module. Per-page `<Seo />` props override these.
  *
- * The vocabulary mirrors the site-config schema's `seo` block
- * (`@getvitops/generator`, `src/config.ts`) so a `Config` → these adapter would
- * be a flat field map — but it is not imported from there. This is the
- * integration's own option surface, and it must stay JSON-serialisable: it is
- * `JSON.stringify`d into the virtual module, so no functions, no `URL`s, no dates.
+ * `site.seo` in the site config is the source (`@getvitops/config`'s `SeoSchema`);
+ * `resolveSeoDefaults()` turns it into this shape for a build locale, and `vitops({ seo })` is merged
+ * over the result as an override. This interface is therefore the *resolved* shape — plain strings,
+ * `Localizable` already picked — and must stay JSON-serialisable: it is `JSON.stringify`d into the
+ * virtual module, so no functions, no `URL`s, no dates. `seo-defaults.test.ts` fails when a
+ * `site.seo` field is added to the schema and not read here (ADR-0002).
  */
 export interface GetvitopsSeoOptions {
   /** `og:site_name`, and the `<title>` when a page passes none. */

package/src/tracking.ts

@@ -12,17 +12,13 @@
  * under `analytics`, and that is the consumer's call to make, not ours to guess.
  */
 
+import type { TrackingConfig } from '@getvitops/config';
+
 /** Which consent category the attribution cookie waits on. */
-export type TrackingCategory = 'marketing' | 'analytics';
+export type TrackingCategory = NonNullable<TrackingConfig['category']>;
 
-export interface GetvitopsTrackingOptions {
-  /** Capture ad click IDs and UTMs into `_ac`. */
-  enabled?: boolean;
-  /** Default `marketing`. */
-  category?: TrackingCategory;
-  /** Informational; capture recognises every known click-ID parameter regardless. */
-  platforms?: string[];
-}
+/** The `site.tracking` block — the schema's own type from `@getvitops/config`, not a copy. */
+export type GetvitopsTrackingOptions = TrackingConfig;
 
 /** The cookie the capture script writes. Mirrors `TRACKING_COOKIE` in utils. */
 export const TRACKING_COOKIE = '_ac';

package/virtual.d.ts

@@ -63,11 +63,28 @@ declare module 'virtual:getvitops/head' {
     // site config is already parsed, and because a pixel is a `marketing` demand
     // the banner must have a row for.
     ads: { enabled: boolean; properties: Record<string, unknown> } | null;
+    turnstileSiteKey: string | null;
   }
   const data: HeadData;
   export default data;
 }
 
+/**
+ * The committed `.vitops/reviews.json` cache as a build-time import — for components that
+ * render in a Worker and so cannot read the file (the EmDash `vitops.reviews` block). Always
+ * defined: with no cache file it is `{ version: 1, locations: {} }`.
+ */
+declare module 'virtual:getvitops/reviews' {
+  // Structurally `ReviewCache` from `@getvitops/utils/reviews` (an ambient module in a
+  // shipped .d.ts cannot import from src). Kept loose on purpose: callers re-type it on the
+  // way into `selectReviews`, which is where the real contract is.
+  const cache: {
+    version: 1;
+    locations: Record<string, { reviews: Record<string, unknown>[] } & Record<string, unknown>>;
+  };
+  export default cache;
+}
+
 /** Types for the virtual module the getvitops() integration provides to <Icon />. */
 declare module 'virtual:getvitops/icons' {
   // Keep these keys in step with `IconsData` in src/integration.ts, for the same

package/dist/tracking-BNKKBqOe.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracking-BNKKBqOe.d.mts","names":[],"sources":["../src/tracking.ts"],"mappings":";;;;;;;;;;;;;;;KAeY;UAEK;;EAEf;;EAEA,WAAW;;EAEX;;;cAIW;;;;;;;;;;;;cAaA;UAEI;EACf;EACA,UAAU;;EAEV;;EAEA;;UAGe;;EAEf;;EAEA;;;;;;;;;;;iBAYc,gBACd,MAAM,sCACN,MAAK,yBACJ"}

package/dist/tracking-M2PqlMpw.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracking-M2PqlMpw.mjs","names":[],"sources":["../src/tracking.ts"],"sourcesContent":["/**\n * The `<Tracking />` resolution layer — tracking config in, what to emit out.\n *\n * Separate from `Tracking.astro` for the same reason `analytics.ts` is separate\n * from `Analytics.astro`: everything decidable is a pure function asserted in\n * `tracking.test.ts`, and the component only renders what this returns.\n *\n * The one decision here is **which consent category the `_ac` cookie waits on**,\n * and it is stated rather than inferred. `_ac` is a 90-day identifier tying a\n * visitor to the ad that brought them, so `marketing` is the default — but a site\n * using click IDs purely for its own campaign reporting may reasonably file it\n * under `analytics`, and that is the consumer's call to make, not ours to guess.\n */\n\n/** Which consent category the attribution cookie waits on. */\nexport type TrackingCategory = 'marketing' | 'analytics';\n\nexport interface GetvitopsTrackingOptions {\n  /** Capture ad click IDs and UTMs into `_ac`. */\n  enabled?: boolean;\n  /** Default `marketing`. */\n  category?: TrackingCategory;\n  /** Informational; capture recognises every known click-ID parameter regardless. */\n  platforms?: string[];\n}\n\n/** The cookie the capture script writes. Mirrors `TRACKING_COOKIE` in utils. */\nexport const TRACKING_COOKIE = '_ac';\n\n/**\n * Where the capture script sends its `tel:`/`mailto:` conversion beacons.\n *\n * The route itself is the consumer's to write (`createConversionRoute()` in\n * `@getvitops/astro/routes`), so this is the one place the two halves agree on\n * a path. It was a bare literal inside the inlined script: a consumer who named\n * the file anything else got a silent 404 on every beacon and lost conversions\n * with no error anywhere to explain it. Exported so a consumer can assert\n * against it, mirrored in `scripts/tracking.ts` because that file is inlined\n * into the document and cannot import, and pinned by `tracking.test.ts`.\n */\nexport const TRACKING_ENDPOINT = '/api/track';\n\nexport interface ResolvedTracking {\n  enabled: boolean;\n  category: TrackingCategory;\n  /** Cookie names to clear on revoke — rides on `data-consent-cookies`. */\n  cookies: string[];\n  /** Configuration problems, as prose. The integration logs these. */\n  warnings: string[];\n}\n\nexport interface ResolveTrackingContext {\n  /** Is the consent gate enabled on this site (`vitops({ consent })`)? */\n  consent?: boolean;\n  /** Categories the banner offers, so we can catch a demand with no row. */\n  consentCategories?: readonly string[];\n}\n\n/**\n * Resolve the tracking config into what the component emits.\n *\n * Two warnings, both about the same failure — a persistent identifier written\n * with no way for the visitor to decline, or a permission asked for with no way\n * to answer. Returned as data rather than logged here so the check is a test\n * rather than a line someone might scroll past, exactly as `resolveAnalytics`\n * does.\n */\nexport function resolveTracking(\n  opts: GetvitopsTrackingOptions | undefined,\n  ctx: ResolveTrackingContext = {},\n): ResolvedTracking {\n  const warnings: string[] = [];\n  const category: TrackingCategory = opts?.category ?? 'marketing';\n  const enabled = opts?.enabled === true;\n\n  if (!enabled) return { enabled: false, category, cookies: [], warnings };\n\n  if (!ctx.consent) {\n    warnings.push(\n      `tracking is on, so this site writes the \\`${TRACKING_COOKIE}\\` cookie — a 90-day ` +\n        'identifier tying a visitor to the ad that brought them — and `consent` is off, so it ' +\n        'is written for every visitor with no way to decline. Set `consent: true`.',\n    );\n  } else if (ctx.consentCategories && !ctx.consentCategories.includes(category)) {\n    // The banner would be raised for a category it renders no row for: the\n    // visitor is asked a question the form does not show them.\n    warnings.push(\n      `tracking demands the \\`${category}\\` consent category, but the banner offers ` +\n        `${ctx.consentCategories.join(', ') || 'nothing'}. Add \\`${category}\\` to ` +\n        '`consent.categories`, or the visitor is asked about something the banner never names.',\n    );\n  }\n\n  return { enabled, category, cookies: [TRACKING_COOKIE], warnings };\n}\n"],"mappings":";;AA2BA,MAAa,kBAAkB;;;;;;;;;;;;AAa/B,MAAa,oBAAoB;;;;;;;;;;AA2BjC,SAAgB,gBACd,MACA,MAA8B,CAAC,GACb;CAClB,MAAM,WAAqB,CAAC;CAC5B,MAAM,WAA6B,MAAM,YAAY;CACrD,MAAM,UAAU,MAAM,YAAY;CAElC,IAAI,CAAC,SAAS,OAAO;EAAE,SAAS;EAAO;EAAU,SAAS,CAAC;EAAG;CAAS;CAEvE,IAAI,CAAC,IAAI,SACP,SAAS,KACP,mDAA6D,wLAG/D;MACK,IAAI,IAAI,qBAAqB,CAAC,IAAI,kBAAkB,SAAS,QAAQ,GAG1E,SAAS,KACP,0BAA0B,SAAS,6CAC9B,IAAI,kBAAkB,KAAK,IAAI,KAAK,UAAU,UAAU,SAAS,8FAExE;CAGF,OAAO;EAAE;EAAS;EAAU,SAAS,MAAgB;EAAG;CAAS;AACnE"}