@escape-game-over/atlas 0.1.42 → 0.1.44

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@escape-game-over/atlas",
-    "version": "0.1.42",
+    "version": "0.1.44",
     "type": "module",
     "description": "Typed, data-driven machinery for static multi-locale, multi-deployment Astro sites.",
     "private": false,

package/src/astro/Document.astro

@@ -10,6 +10,9 @@
  * `restoreScroll={false}`: the router keeps its own position in the same
  * history state.
  *
+ * A site with a lead form passes `rememberCampaign`, so the `utm_*` tags a
+ * visit landed with survive to the page the form is on; see `attribution.ts`.
+ *
  * ```astro
  * <Document meta={meta} html={{ class: "scroll-smooth" }} body={{ class: "…" }}>
  *     <Fragment slot="head"><link rel="preload" … /></Fragment>
@@ -20,6 +23,7 @@
 import type { HTMLAttributes } from "astro/types";
 import type { PageMeta } from "../site/index.ts";
 import MetaTags from "./MetaTags.astro";
+import RememberCampaign from "./RememberCampaign.astro";
 import ScrollRestore from "./ScrollRestore.astro";
 
 interface Props {
@@ -29,9 +33,17 @@ interface Props {
     readonly body?: HTMLAttributes<"body">;
     /** Defaults to `true`; `false` for a site on `ClientRouter`. */
     readonly restoreScroll?: boolean;
+    /** Off unless stated: a site with no lead form has nothing to keep them for. */
+    readonly rememberCampaign?: boolean;
 }
 
-const { meta, html, body, restoreScroll = true } = Astro.props;
+const {
+    meta,
+    html,
+    body,
+    restoreScroll = true,
+    rememberCampaign = false,
+} = Astro.props;
 ---
 
 <!doctype html>
@@ -49,5 +61,6 @@ const { meta, html, body, restoreScroll = true } = Astro.props;
         <MetaTags tags={meta.bodyTags} />
         <slot />
         {restoreScroll && <ScrollRestore />}
+        {rememberCampaign && <RememberCampaign />}
     </body>
 </html>

package/src/astro/RememberCampaign.astro

@@ -0,0 +1,11 @@
+---
+/**
+ * Keeps the campaign tags a visit landed with for the tab, so a lead form on
+ * another page can still report them — see `attribution.ts`.
+ *
+ * Rendered by `Document` when asked for. A bundled module rather than inline:
+ * the tags are wanted by a form, which cannot be sent before it runs.
+ */
+---
+
+<script src="./remember-campaign.ts" />

package/src/astro/attribution.ts

@@ -11,7 +11,8 @@
  * - **Campaign tags** (`utm_*`) are labels a campaign shares with everyone who
  *   clicked it, not an identifier. They are kept for the tab in
  *   `sessionStorage`, so a visitor who lands on one page and fills a form on
- *   another still reports them. `rememberCampaign()` on every page does that.
+ *   another still reports them. `rememberCampaign()` does that; `Document`'s
+ *   `rememberCampaign` runs it on every page, with analytics consent only.
  * - **The ad click id** (`gclid`, `gbraid`, `wbraid`) identifies one click, and
  *   is never stored here. Google keeps it under the visitor's consent: on the
  *   URL while marketing is denied — `urlPassthrough` in `GoogleSettings` — and

package/src/astro/consent.ts

@@ -80,8 +80,15 @@ export function readConsent(): ConsentRecord | undefined {
 }
 
 /**
- * Remembers an answer, dated now, and tells Google about it — one call, so the
- * two cannot come apart.
+ * The event `recordConsent` fires on `window` with the new answer as `detail`,
+ * for anything on the page that waits on a category — without the banner
+ * having to know it exists.
+ */
+export const CONSENT_EVENT = "atlas:consent";
+
+/**
+ * Remembers an answer, dated now, tells Google about it, and announces it — one
+ * call, so the three cannot come apart.
  */
 export function recordConsent(choices: ConsentChoices): void {
     const record: ConsentRecord = { ...choices, at: new Date().toISOString() };
@@ -92,6 +99,9 @@ export function recordConsent(choices: ConsentChoices): void {
         // one — the choice still applies to this page.
     }
     applyConsent(choices);
+    window.dispatchEvent?.(
+        new CustomEvent<ConsentChoices>(CONSENT_EVENT, { detail: choices })
+    );
 }
 
 /**

package/src/astro/remember-campaign.ts

@@ -0,0 +1,15 @@
+// Every page: a visit can land anywhere before it reaches a form.
+//
+// Only with analytics consent. Keeping campaign tags is measurement, and EU
+// rules ask consent for anything stored on a visitor's device that the site
+// does not need to work — not only cookies. So the tags are kept now if the
+// visitor already agreed, or the moment they agree on this page.
+import { rememberCampaign } from "./attribution.ts";
+import { CONSENT_EVENT, type ConsentChoices, readConsent } from "./consent.ts";
+
+if (readConsent()?.analytics === "granted") rememberCampaign();
+
+addEventListener(CONSENT_EVENT, (event) => {
+    const choices = (event as CustomEvent<ConsentChoices>).detail;
+    if (choices.analytics === "granted") rememberCampaign();
+});

package/src/index.ts

@@ -14,6 +14,7 @@
 
 export {
     CONSENT_CATEGORIES,
+    CONSENT_MONTHS,
     type ConsentCategory,
     type ConsentChoice,
     type ConsentChoices,