@cartbase/storefront 0.17.0 → 0.18.0

package/src/tracking/chatgpt-pixel.tsx

@@ -1,99 +1,99 @@
-"use client"
-
-import Script from "next/script"
-
-import { adsConsentSnippet } from "./consent"
-import { jsStringLiteral } from "./inline-script"
-
-/**
- * ChatGptPixel — the OpenAI measurement pixel, the ChatGPT Ads twin of
- * <MetaPixel> and <TikTokPixel>.
- *
- * The loader is OpenAI's own, verbatim from
- * https://developers.openai.com/ads/measurement-pixel: a command queue on
- * `window.oaiq` that buffers calls until the SDK arrives from
- * bzrcdn.openai.com, injected with `<Script strategy="afterInteractive">`.
- *
- * CONSENT IS CLOSED BEFORE INIT, and that order is the whole point. Their
- * consent default is TRUE, so an unconsented visitor is measured unless we
- * say otherwise first:
- *
- *     oaiq("consent", false)   // queued BEFORE init — no pings
- *     oaiq("init", { pixelId })
- *     oaiq("consent", true)    // only once the visitor accepted
- *
- * The script is LOADED either way, like the Meta and TikTok gates beside
- * it, so a later grant costs no round trip. But the page view is fired
- * only AFTER a grant, and that is deliberate rather than cautious: their
- * docs state that with consent false the pixel sends no measurement
- * pings, and they do NOT document whether a call made while consent was
- * false is released on a later grant. TikTok documents exactly that
- * (`holdConsent` queues, `grantConsent` flushes) and our TikTok gate
- * relies on it. Nothing here relies on behaviour OpenAI has not written
- * down: an unconsented page view is not sent, and not counted on later.
- *
- * The decision is the store's default overridden by the visitor's stored
- * choice (`adsConsentSnippet`), resolved inside the snippet before anything
- * can be sent: a store that collects consent starts closed, a store with
- * no consent gate starts open, the cookie winning either way. Live changes
- * arrive through `applyConsent()` in ./consent.ts — there is no cookie
- * watcher. `consentRequired` is `tracking.consent_required`, passed by
- * <StorefrontTags>, and required for the reason <ConsentInit> gives.
- *
- * The page view is ours to fire at all: their pixel sends nothing at init,
- * unlike Meta's and TikTok's base code.
- *
- * Their SDK also captures `oppref` off the landing URL into a first-party
- * `__oppref` cookie by itself. Our attribution module captures the same
- * parameter into `_1c_oppref` independently, so the server-side
- * Conversions API event can carry the click even on a visit where this
- * script never loaded at all.
- *
- * Renders nothing when `pixelId` is falsy, so a layout can mount it
- * unconditionally.
- */
-export function ChatGptPixel({
-  pixelId,
-  consentRequired,
-}: {
-  pixelId?: string
-  /** `tracking.consent_required`: does this store collect consent before it tracks? */
-  consentRequired: boolean
-}) {
-  if (!pixelId) return null
-
-  const id = jsStringLiteral(pixelId)
-
-  const initSnippet = `
-(function (w, d, s, u) {
-  if (w.oaiq) return;
-  var q = function () { q.q.push(arguments); };
-  q.q = [];
-  w.oaiq = q;
-  var js = d.createElement(s);
-  js.async = true;
-  js.src = u;
-  var f = d.getElementsByTagName(s)[0];
-  f.parentNode.insertBefore(js, f);
-})(window, document, "script", "https://bzrcdn.openai.com/sdk/oaiq.min.js");
-
-oaiq("consent", false);
-oaiq("init", { pixelId: ${id} });
-
-(function (d) {
-  ${adsConsentSnippet(consentRequired, "d")}
-  if (ads) {
-    oaiq("consent", true);
-    oaiq("measure", "page_viewed", { type: "contents" });
-  }
-})(document);
-`.trim()
-
-  return (
-    <Script
-      id="chatgpt-pixel-init"
-      strategy="afterInteractive"
-      dangerouslySetInnerHTML={{ __html: initSnippet }}
-    />
-  )
-}
+"use client"
+
+import Script from "next/script"
+
+import { adsConsentSnippet } from "./consent"
+import { jsStringLiteral } from "./inline-script"
+
+/**
+ * ChatGptPixel — the OpenAI measurement pixel, the ChatGPT Ads twin of
+ * <MetaPixel> and <TikTokPixel>.
+ *
+ * The loader is OpenAI's own, verbatim from
+ * https://developers.openai.com/ads/measurement-pixel: a command queue on
+ * `window.oaiq` that buffers calls until the SDK arrives from
+ * bzrcdn.openai.com, injected with `<Script strategy="afterInteractive">`.
+ *
+ * CONSENT IS CLOSED BEFORE INIT, and that order is the whole point. Their
+ * consent default is TRUE, so an unconsented visitor is measured unless we
+ * say otherwise first:
+ *
+ *     oaiq("consent", false)   // queued BEFORE init — no pings
+ *     oaiq("init", { pixelId })
+ *     oaiq("consent", true)    // only once the visitor accepted
+ *
+ * The script is LOADED either way, like the Meta and TikTok gates beside
+ * it, so a later grant costs no round trip. But the page view is fired
+ * only AFTER a grant, and that is deliberate rather than cautious: their
+ * docs state that with consent false the pixel sends no measurement
+ * pings, and they do NOT document whether a call made while consent was
+ * false is released on a later grant. TikTok documents exactly that
+ * (`holdConsent` queues, `grantConsent` flushes) and our TikTok gate
+ * relies on it. Nothing here relies on behaviour OpenAI has not written
+ * down: an unconsented page view is not sent, and not counted on later.
+ *
+ * The decision is the store's default overridden by the visitor's stored
+ * choice (`adsConsentSnippet`), resolved inside the snippet before anything
+ * can be sent: a store that collects consent starts closed, a store with
+ * no consent gate starts open, the cookie winning either way. Live changes
+ * arrive through `applyConsent()` in ./consent.ts — there is no cookie
+ * watcher. `consentRequired` is `tracking.consent_required`, passed by
+ * <StorefrontTags>, and required for the reason <ConsentInit> gives.
+ *
+ * The page view is ours to fire at all: their pixel sends nothing at init,
+ * unlike Meta's and TikTok's base code.
+ *
+ * Their SDK also captures `oppref` off the landing URL into a first-party
+ * `__oppref` cookie by itself. Our attribution module captures the same
+ * parameter into `_1c_oppref` independently, so the server-side
+ * Conversions API event can carry the click even on a visit where this
+ * script never loaded at all.
+ *
+ * Renders nothing when `pixelId` is falsy, so a layout can mount it
+ * unconditionally.
+ */
+export function ChatGptPixel({
+  pixelId,
+  consentRequired,
+}: {
+  pixelId?: string
+  /** `tracking.consent_required`: does this store collect consent before it tracks? */
+  consentRequired: boolean
+}) {
+  if (!pixelId) return null
+
+  const id = jsStringLiteral(pixelId)
+
+  const initSnippet = `
+(function (w, d, s, u) {
+  if (w.oaiq) return;
+  var q = function () { q.q.push(arguments); };
+  q.q = [];
+  w.oaiq = q;
+  var js = d.createElement(s);
+  js.async = true;
+  js.src = u;
+  var f = d.getElementsByTagName(s)[0];
+  f.parentNode.insertBefore(js, f);
+})(window, document, "script", "https://bzrcdn.openai.com/sdk/oaiq.min.js");
+
+oaiq("consent", false);
+oaiq("init", { pixelId: ${id} });
+
+(function (d) {
+  ${adsConsentSnippet(consentRequired, "d")}
+  if (ads) {
+    oaiq("consent", true);
+    oaiq("measure", "page_viewed", { type: "contents" });
+  }
+})(document);
+`.trim()
+
+  return (
+    <Script
+      id="chatgpt-pixel-init"
+      strategy="afterInteractive"
+      dangerouslySetInnerHTML={{ __html: initSnippet }}
+    />
+  )
+}

package/src/tracking/consent-init.tsx

@@ -1,62 +1,62 @@
-import { consentInitSnippet } from "./consent"
-
-/**
- * ConsentInit — the synchronous Consent Mode v2 "default" snippet.
- *
- * Ported from the Cartbase reference implementation
- * `src/components/storefront/consent/consent-init.tsx` (itself from
- * `@1click/ui/src/tracking/consent-init.tsx` v2.3.1); the snippet lives in
- * ./consent.ts (`consentInitSnippet`) so its ordering contract is
- * unit-testable.
- *
- * Render it as the FIRST child of <body> (App Router layouts don't
- * expose <head> for inline scripts). A plain inline <script>
- * (deliberately NOT next/script) executes at HTML-parse time — long
- * before the afterInteractive <GA4>/<MetaPixel> loaders, which run
- * post-hydration. Google's consent-mode docs require the default to be
- * set synchronously ahead of the tag; an async default races the
- * loader and the first hit of a returning consented visitor would
- * ship denied.
- *
- * `required` is the store's consent switch, `consent.enabled` from
- * `GET /api/store/consent`, which the layout already fetches for the
- * banner. It is REQUIRED on purpose: with it absent there is no safe
- * default to fall back on. Defaulting to true would keep the pixels of a
- * store that switched its banner off silent forever (the defect fixed on
- * 2026-09-14); defaulting to false would fire them on an EU store whose
- * layout forgot the prop. So the layout states it, and a layout that does
- * not fails to compile.
- *
- * Behavior:
- *   - `required` and no stored choice (first visit) → default ALL DENIED.
- *     Tags still load (advanced consent mode): gtag sends cookieless
- *     pings, the Pixel queues client-side. The <ConsentBanner> then
- *     collects the choice and applies the live 'update'.
- *   - not `required` and no stored choice → default ALL GRANTED: the store
- *     collects no consent, so there is nothing to wait for.
- *   - Stored choice → default mirrors it, whatever the switch, so
- *     returning visitors are correct from the very first hit with no
- *     banner and no race, and a visitor who declined keeps that decision.
- *
- * `ads_data_redaction` strips ad-click identifiers (gclid et al.) from
- * the cookieless pings while ad_storage is denied, per Google's docs.
- *
- * The script interpolates one boolean literal and the shared cookie name,
- * nothing typed by a person — safe as a server-component inline script
- * with a stable id. CARD TRAP: it must NEVER wait on the
- * /api/store/consent fetch inside the browser; the layout resolves the
- * setting on the server and inlines it here.
- */
-export function ConsentInit({
-  required,
-}: {
-  /** The store's consent switch: `consent.enabled` from `GET /api/store/consent`. */
-  required: boolean
-}) {
-  return (
-    <script
-      id="1click-consent-init"
-      dangerouslySetInnerHTML={{ __html: consentInitSnippet(required) }}
-    />
-  )
-}
+import { consentInitSnippet } from "./consent"
+
+/**
+ * ConsentInit — the synchronous Consent Mode v2 "default" snippet.
+ *
+ * Ported from the Cartbase reference implementation
+ * `src/components/storefront/consent/consent-init.tsx` (itself from
+ * `@1click/ui/src/tracking/consent-init.tsx` v2.3.1); the snippet lives in
+ * ./consent.ts (`consentInitSnippet`) so its ordering contract is
+ * unit-testable.
+ *
+ * Render it as the FIRST child of <body> (App Router layouts don't
+ * expose <head> for inline scripts). A plain inline <script>
+ * (deliberately NOT next/script) executes at HTML-parse time — long
+ * before the afterInteractive <GA4>/<MetaPixel> loaders, which run
+ * post-hydration. Google's consent-mode docs require the default to be
+ * set synchronously ahead of the tag; an async default races the
+ * loader and the first hit of a returning consented visitor would
+ * ship denied.
+ *
+ * `required` is the store's consent switch, `consent.enabled` from
+ * `GET /api/store/consent`, which the layout already fetches for the
+ * banner. It is REQUIRED on purpose: with it absent there is no safe
+ * default to fall back on. Defaulting to true would keep the pixels of a
+ * store that switched its banner off silent forever (the defect fixed on
+ * 2026-09-14); defaulting to false would fire them on an EU store whose
+ * layout forgot the prop. So the layout states it, and a layout that does
+ * not fails to compile.
+ *
+ * Behavior:
+ *   - `required` and no stored choice (first visit) → default ALL DENIED.
+ *     Tags still load (advanced consent mode): gtag sends cookieless
+ *     pings, the Pixel queues client-side. The <ConsentBanner> then
+ *     collects the choice and applies the live 'update'.
+ *   - not `required` and no stored choice → default ALL GRANTED: the store
+ *     collects no consent, so there is nothing to wait for.
+ *   - Stored choice → default mirrors it, whatever the switch, so
+ *     returning visitors are correct from the very first hit with no
+ *     banner and no race, and a visitor who declined keeps that decision.
+ *
+ * `ads_data_redaction` strips ad-click identifiers (gclid et al.) from
+ * the cookieless pings while ad_storage is denied, per Google's docs.
+ *
+ * The script interpolates one boolean literal and the shared cookie name,
+ * nothing typed by a person — safe as a server-component inline script
+ * with a stable id. CARD TRAP: it must NEVER wait on the
+ * /api/store/consent fetch inside the browser; the layout resolves the
+ * setting on the server and inlines it here.
+ */
+export function ConsentInit({
+  required,
+}: {
+  /** The store's consent switch: `consent.enabled` from `GET /api/store/consent`. */
+  required: boolean
+}) {
+  return (
+    <script
+      id="1click-consent-init"
+      dangerouslySetInnerHTML={{ __html: consentInitSnippet(required) }}
+    />
+  )
+}