@evinvest/kitstart 0.15.0 → 0.16.0

package/README.md

@@ -45,7 +45,7 @@ brand's `flake.nix` is its own config plus one call — `template/flake.nix` is
 the whole of one:
 
 ```nix
-inputs.ev.url = "github:EV-invest/lib?ref=@evinvest/kitstart-v0.15.0"; # the version in package-lock.json
+inputs.ev.url = "github:EV-invest/lib?ref=@evinvest/kitstart-v0.16.0"; # the version in package-lock.json
 inputs.ev.inputs.v_flakes.follows = "v_flakes";
 
 landing = ev.lib.mkLanding {
@@ -349,7 +349,9 @@ it is the plain POST to `/quote` it always was.
   (`contact` / `need` in `qualify-first`; in `steps` each screen moved to —
   `intro`, `need`, `estimate_<input>`, `locality`, `phone`), each with `form_id`, `layout`, `experiment`,
   `variant`; `contact_intent_click {channel}` for `phone`, `whatsapp`, `sms`,
-  `callback`, with the experiment; and on the server `lead_form_submit
+  `callback`, with the experiment (and `forced: true` on a test visit, as
+  `location_page_view`, when the boundary has `qaCookie` — see `AbSwitcher`);
+  and on the server `lead_form_submit
   {form_id, channel}` and `lead_form_reject {form_id, channel, field,
   reason}` with the posted experiment.
 - **Weight.** 8.9 KB gz of first-load JS on the template's place page
@@ -936,6 +938,15 @@ adds no server path: a tap on a variant goes to the same URL with
   too. **Minimize** and **Hide** last until the next load.
 - Screenshots: the chip and its panel carry `data-ab-switcher`; hide it in the
   section stylesheet, `[data-ab-switcher] { display: none !important; }`.
+- **Pass the same `qaCookie` to `AnalyticsBoundary`.** Every tap in the menu
+  is a full reload, so a test visit would add page views to the place's
+  traffic; with the cookie set, the boundary's `location_page_view` and
+  `contact_intent_click` carry `forced: true`. Without the prop, or without
+  the cookie, the events are as before — no `forced` key at all.
+
+  ```tsx
+  <AnalyticsBoundary target={target} placeSlug={slug} qaCookie="ab__qa">
+  ```
 
 The decisions are plain functions in the core (`abSwitcherVisible`,
 `abVariantUrl`, `abReset`, `abAssignments`), for a brand's own tests.

package/dist/core/ab-switcher.js

@@ -57,5 +57,9 @@ export function abReset(href, keys, qaCookie, mode, forceParam = AB_FORCE_PARAM)
     const url = new URL(href);
     for (const key of keys)
         url.searchParams.delete(`${forceParam}${key}`);
+    // `/fr#quote` with no force parameter would otherwise be the URL itself: the
+    // browser only scrolls to the anchor, the page never reloads, and the cookies
+    // just dropped are never re-drawn.
+    url.hash = "";
     return { cookies: names.map(n => `${n}=; path=/; max-age=0`), url: url.toString() };
 }

package/dist/core/analytics.d.ts

@@ -40,7 +40,7 @@ export type LeadStep = "need" | "contact" | "intro" | "locality" | "phone" | `es
  * throws, prod drops) rather than by review. `experiment` and `variant` are
  * the site's assignment, passed in; `field` is a field's role, never its value.
  */
-export declare const ALLOWED_PROPS: readonly ["brand_id", "location_id", "source", "device", "channel", "form_id", "experiment", "variant", "field", "step", "layout", "reason", "blocking", "need", "cents_bucket", "provider"];
+export declare const ALLOWED_PROPS: readonly ["brand_id", "location_id", "source", "device", "channel", "form_id", "experiment", "variant", "field", "step", "layout", "reason", "blocking", "need", "cents_bucket", "provider", "forced"];
 /**
  * The beacon's `distinct_id` as a lead may carry it to the panel
  * (`lead.created`'s `analytics_id`), so PostHog can join the lead to the

package/dist/core/analytics.js

@@ -57,6 +57,9 @@ export const ALLOWED_PROPS = [
     "cents_bucket",
     // The booking's provider, `manual` | `link` | `cal_com` — never its URL.
     "provider",
+    // A test visit (`true`): the brand's QA cookie was set, by a forced variant
+    // or the QA menu. Absent otherwise, never `false`.
+    "forced",
 ];
 /**
  * The beacon's `distinct_id` as a lead may carry it to the panel

package/dist/react/AnalyticsBoundary.d.ts

@@ -7,8 +7,16 @@ import { type AnalyticsTarget } from "../core/analytics.js";
  * writes no cookie. `target` is plain data from the server layout — the key
  * is read from the container when the page renders, never inlined.
  */
-export declare function AnalyticsBoundary({ target, placeSlug, children }: {
+export interface AnalyticsBoundaryProps {
     target: AnalyticsTarget;
     placeSlug: string | null;
+    /**
+     * The cookie the brand's force parameter sets (`AbSwitcher`'s `qaCookie`).
+     * A visit carrying it is a test: its page views and intents say
+     * `forced: true`, so the QA menu's reloads do not count as a place's
+     * traffic. Read in the browser at each event, never on the server.
+     */
+    qaCookie?: string;
     children: ReactNode;
-}): import("react").JSX.Element;
+}
+export declare function AnalyticsBoundary({ target, placeSlug, qaCookie, children }: AnalyticsBoundaryProps): import("react").JSX.Element;

package/dist/react/AnalyticsBoundary.js

@@ -12,6 +12,15 @@ import { newSubmissionId } from "./use-lead-submit.js";
  */
 const INTENT_ATTR = "data-intent";
 const INTENTS = ["form_open", "booking", "sms", "callback"];
+/**
+ * Whether the QA cookie is set with a value. Its own copy, not `ab-gate`'s:
+ * a module shared with `AbSwitcher` makes Turbopack split it into a chunk of
+ * its own, which costs every visitor more than these lines.
+ */
+const qaVisit = (name) => document.cookie.split(";").some(c => {
+    const eq = c.indexOf("=");
+    return eq > 0 && c.slice(0, eq).trim() === name && c.slice(eq + 1).trim() !== "";
+});
 function source() {
     const utm = new URLSearchParams(window.location.search).get("utm_source");
     if (utm)
@@ -26,14 +35,7 @@ function source() {
         return "unknown";
     }
 }
-/**
- * The only client island analytics needs. Everything it wraps stays server
- * rendered; this adds one delegated listener (capture phase, never cancelling
- * the navigation) and a page-view beacon. With no key it sends nothing, and it
- * writes no cookie. `target` is plain data from the server layout — the key
- * is read from the container when the page renders, never inlined.
- */
-export function AnalyticsBoundary({ target, placeSlug, children }) {
+export function AnalyticsBoundary({ target, placeSlug, qaCookie, children }) {
     // On the target's values: a server layout hands a fresh object every render.
     const { key, host, brandId } = target;
     // One visitor for the boundary's life, in memory only: a sink rebuilt for
@@ -41,25 +43,29 @@ export function AnalyticsBoundary({ target, placeSlug, children }) {
     const [distinctId] = useState(newSubmissionId);
     const sink = useMemo(() => analyticsSink({ key, host, brandId }, placeSlug, distinctId), [key, host, brandId, placeSlug, distinctId]);
     const pathname = usePathname();
+    // Spread into an event: `{}` without the cookie, so a brand that never
+    // passes `qaCookie` sends exactly what it sent before.
+    const forced = () => (qaCookie && qaVisit(qaCookie) ? { forced: true } : {});
     useEffect(() => {
         if (!countsAsPageView(pathname))
             return;
         sink.capture(EVENTS.pageView, {
             source: source(),
             device: window.matchMedia("(max-width: 767px)").matches ? "mobile" : "desktop",
+            ...forced(),
         });
-    }, [sink, pathname]);
+    }, [sink, pathname, qaCookie]);
     useEffect(() => {
         const onClick = (event) => {
             const el = event.target instanceof Element ? event.target.closest(`[${INTENT_ATTR}]`) : null;
             const channel = el?.getAttribute(INTENT_ATTR);
             if (channel && INTENTS.some(i => i === channel))
-                sink.capture(EVENTS.intent, { channel, ...experimentOf(el) }, { transport: "beacon" });
+                sink.capture(EVENTS.intent, { channel, ...experimentOf(el), ...forced() }, { transport: "beacon" });
         };
         document.addEventListener("click", onClick, { capture: true });
         return () => document.removeEventListener("click", onClick, { capture: true });
-    }, [sink]);
+    }, [sink, qaCookie]);
     // A link inside an experiment's island (`LeadCapture`) carries the
     // assignment on itself, which is what the tracker reads.
-    return (_jsx(AnalyticsIdContext.Provider, { value: key ? distinctId : null, children: _jsx(AnalyticsSinkContext.Provider, { value: sink, children: _jsx(ContactLinkTracker, { channels: ["phone", "whatsapp"], onContact: ({ channel, data }) => sink.capture(EVENTS.intent, { channel, ...experimentProps(data["experiment"], data["variant"]) }, { transport: "beacon" }), children: children }) }) }));
+    return (_jsx(AnalyticsIdContext.Provider, { value: key ? distinctId : null, children: _jsx(AnalyticsSinkContext.Provider, { value: sink, children: _jsx(ContactLinkTracker, { channels: ["phone", "whatsapp"], onContact: ({ channel, data }) => sink.capture(EVENTS.intent, { channel, ...experimentProps(data["experiment"], data["variant"]), ...forced() }, { transport: "beacon" }), children: children }) }) }));
 }

package/dist/react/index.d.ts

@@ -15,7 +15,7 @@
  */
 export { AbSwitcher } from "./AbSwitcher.js";
 export type { AbSwitcherExperiment, AbSwitcherProps, AbSwitcherText, AbSwitcherVariant } from "./ab-switcher-types.js";
-export { AnalyticsBoundary } from "./AnalyticsBoundary.js";
+export { AnalyticsBoundary, type AnalyticsBoundaryProps } from "./AnalyticsBoundary.js";
 export { AreaChips } from "./AreaChips.js";
 export { CallBar, type CallBarPart, type CallBarProps } from "./CallBar.js";
 export { Coverage, type CoveragePart, type CoverageProps } from "./Coverage.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evinvest/kitstart",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Landing-site machinery for local-service brands: a site composition root, the Place/Presence/ServiceArea model with a publication gate, host/locale routing, schema.org and SEO builders, the lead funnel with its antispam, and analytics events. Pure core at '.', more subpaths per runtime.",
   "license": "BlueOak-1.0.0",
   "publishConfig": {

package/template/app/[locale]/[location]/layout.tsx

@@ -23,7 +23,7 @@ export default async function PlaceLayout({ children, params }: { children: Reac
   const env = serverEnv();
   // The key is read from the container when the page renders, never inlined.
   return (
-    <AnalyticsBoundary target={{ key: env.posthogKey, host: env.posthogHost, brandId: site.brand.id }} placeSlug={view.place.slug}>
+    <AnalyticsBoundary target={{ key: env.posthogKey, host: env.posthogHost, brandId: site.brand.id }} placeSlug={view.place.slug} qaCookie={QA_COOKIE}>
       {children}
       {/* Above the phone's call bar; nothing at all for a visit without the QA cookie. */}
       <AbSwitcher experiments={EXPERIMENTS} qaCookie={QA_COOKIE} className="bottom-20 md:bottom-4" />

package/template/flake.nix

@@ -3,7 +3,7 @@
     v_flakes.url = "github:valeratrades/v_flakes?ref=v1.6";
     # The lib flake at the tag of the @evinvest/kitstart version in
     # package-lock.json — mkLanding refuses a mismatch.
-    ev.url = "github:EV-invest/lib?ref=@evinvest/kitstart-v0.15.0";
+    ev.url = "github:EV-invest/lib?ref=@evinvest/kitstart-v0.16.0";
     ev.inputs.v_flakes.follows = "v_flakes";
   };
 

package/template/package.json

@@ -20,7 +20,7 @@
   "dependencies": {
     "@evinvest/analytics": "^0.4.0",
     "@evinvest/i18n": "^0.9.0",
-    "@evinvest/kitstart": "^0.15.0",
+    "@evinvest/kitstart": "^0.16.0",
     "@evinvest/marketing": "^0.3.0",
     "@evinvest/uikit": "^0.26.0",
     "next": "16.3.6",

package/template/tests/e2e/ab-switcher.spec.ts

@@ -83,6 +83,21 @@ test("Leave test drops the QA cookie too: after the load there is no chip", asyn
   await expect(chip(page)).toHaveCount(0);
 });
 
+test("Leave test from a page reached by an anchor still reloads it, and the chip goes", async ({ page, context, baseURL }) => {
+  await asTester(context, baseURL);
+  await page.goto("/fr#quote");
+  await chip(page).click();
+  // A same-URL replace with the anchor kept is a scroll, not a load: this waits forever.
+  const reloaded = page.waitForEvent("load");
+  await panel(page).getByRole("button", { name: "Leave test" }).click();
+  await reloaded;
+  await expect(page).toHaveURL(/\/fr$/);
+  await hydrated(page);
+  await page.waitForLoadState("networkidle");
+  expect(await cookieNames(context)).not.toContain(QA_COOKIE);
+  await expect(chip(page)).toHaveCount(0);
+});
+
 test("Escape closes the panel and gives the focus back to the chip", async ({ page, context, baseURL }) => {
   await assignedB(page, context, baseURL);
   await page.keyboard.press("Escape");