@codefast/tracking 0.5.0-canary.4 → 0.5.0-canary.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +473 -0
- package/README.md +177 -95
- package/dist/adapters/tanstack-start.d.ts +80 -0
- package/dist/adapters/tanstack-start.d.ts.map +1 -0
- package/dist/adapters/tanstack-start.js +74 -0
- package/dist/adapters/tanstack-start.js.map +1 -0
- package/dist/client/ad-framework-consent.d.ts +62 -0
- package/dist/client/ad-framework-consent.d.ts.map +1 -0
- package/dist/client/ad-framework-consent.js +40 -0
- package/dist/client/ad-framework-consent.js.map +1 -0
- package/dist/client/browser-cookie.d.ts +9 -0
- package/dist/client/browser-cookie.d.ts.map +1 -0
- package/dist/client/browser-cookie.js +15 -0
- package/dist/client/browser-cookie.js.map +1 -0
- package/dist/client/consent-runtime.d.ts +53 -0
- package/dist/client/consent-runtime.d.ts.map +1 -0
- package/dist/client/consent-runtime.js +33 -0
- package/dist/client/consent-runtime.js.map +1 -0
- package/dist/client/{consent-storage.d.mts → consent-storage.d.ts} +8 -6
- package/dist/client/consent-storage.d.ts.map +1 -0
- package/dist/client/consent-storage.js +109 -0
- package/dist/client/consent-storage.js.map +1 -0
- package/dist/client/consent-withdrawal.d.ts +18 -0
- package/dist/client/consent-withdrawal.d.ts.map +1 -0
- package/dist/client/consent-withdrawal.js +17 -0
- package/dist/client/consent-withdrawal.js.map +1 -0
- package/dist/client/cookie-anonymous-id.d.ts +41 -0
- package/dist/client/cookie-anonymous-id.d.ts.map +1 -0
- package/dist/client/cookie-anonymous-id.js +65 -0
- package/dist/client/cookie-anonymous-id.js.map +1 -0
- package/dist/client/create-client-tracker.d.ts +60 -0
- package/dist/client/create-client-tracker.d.ts.map +1 -0
- package/dist/client/create-client-tracker.js +91 -0
- package/dist/client/create-client-tracker.js.map +1 -0
- package/dist/client/gpc.d.ts +10 -0
- package/dist/client/gpc.d.ts.map +1 -0
- package/dist/client/gpc.js +12 -0
- package/dist/client/gpc.js.map +1 -0
- package/dist/client/initial-consent-store.d.ts +63 -0
- package/dist/client/initial-consent-store.d.ts.map +1 -0
- package/dist/client/initial-consent-store.js +138 -0
- package/dist/client/initial-consent-store.js.map +1 -0
- package/dist/client/is-analytics-allowed.d.ts +26 -0
- package/dist/client/is-analytics-allowed.d.ts.map +1 -0
- package/dist/client/is-analytics-allowed.js +22 -0
- package/dist/client/is-analytics-allowed.js.map +1 -0
- package/dist/client/server-persisted-anonymous-id.d.ts +30 -0
- package/dist/client/server-persisted-anonymous-id.d.ts.map +1 -0
- package/dist/client/server-persisted-anonymous-id.js +72 -0
- package/dist/client/server-persisted-anonymous-id.js.map +1 -0
- package/dist/core/consent-config.d.ts +24 -0
- package/dist/core/consent-config.d.ts.map +1 -0
- package/dist/core/consent-config.js +9 -0
- package/dist/core/consent-config.js.map +1 -0
- package/dist/core/consent-receipt.d.ts +71 -0
- package/dist/core/consent-receipt.d.ts.map +1 -0
- package/dist/core/consent-receipt.js +39 -0
- package/dist/core/consent-receipt.js.map +1 -0
- package/dist/core/consent.d.ts +182 -0
- package/dist/core/consent.d.ts.map +1 -0
- package/dist/core/consent.js +159 -0
- package/dist/core/consent.js.map +1 -0
- package/dist/core/cookie.d.ts +15 -0
- package/dist/core/cookie.d.ts.map +1 -0
- package/dist/core/cookie.js +26 -0
- package/dist/core/cookie.js.map +1 -0
- package/dist/core/destination.d.ts +29 -0
- package/dist/core/destination.d.ts.map +1 -0
- package/dist/core/destination.js +2 -0
- package/dist/core/destination.js.map +1 -0
- package/dist/core/event-catalog.d.ts +35 -0
- package/dist/core/event-catalog.d.ts.map +1 -0
- package/dist/core/event-catalog.js +30 -0
- package/dist/core/event-catalog.js.map +1 -0
- package/dist/core/event-id.d.ts +7 -0
- package/dist/core/event-id.d.ts.map +1 -0
- package/dist/core/event-id.js +9 -0
- package/dist/core/event-id.js.map +1 -0
- package/dist/core/tracked-event.d.ts +15 -0
- package/dist/core/tracked-event.d.ts.map +1 -0
- package/dist/core/tracked-event.js +2 -0
- package/dist/core/tracked-event.js.map +1 -0
- package/dist/destinations/ad-consent.d.ts +23 -0
- package/dist/destinations/ad-consent.d.ts.map +1 -0
- package/dist/destinations/ad-consent.js +12 -0
- package/dist/destinations/ad-consent.js.map +1 -0
- package/dist/destinations/google-analytics.d.ts +148 -0
- package/dist/destinations/google-analytics.d.ts.map +1 -0
- package/dist/destinations/google-analytics.js +156 -0
- package/dist/destinations/google-analytics.js.map +1 -0
- package/dist/destinations/google-consent.d.ts +62 -0
- package/dist/destinations/google-consent.d.ts.map +1 -0
- package/dist/destinations/google-consent.js +109 -0
- package/dist/destinations/google-consent.js.map +1 -0
- package/dist/destinations/meta.d.ts +63 -0
- package/dist/destinations/meta.d.ts.map +1 -0
- package/dist/destinations/meta.js +44 -0
- package/dist/destinations/meta.js.map +1 -0
- package/dist/destinations/microsoft-uet.d.ts +56 -0
- package/dist/destinations/microsoft-uet.d.ts.map +1 -0
- package/dist/destinations/microsoft-uet.js +41 -0
- package/dist/destinations/microsoft-uet.js.map +1 -0
- package/dist/destinations/shared.d.ts +18 -0
- package/dist/destinations/shared.d.ts.map +1 -0
- package/dist/destinations/shared.js +19 -0
- package/dist/destinations/shared.js.map +1 -0
- package/dist/destinations/tiktok.d.ts +55 -0
- package/dist/destinations/tiktok.d.ts.map +1 -0
- package/dist/destinations/tiktok.js +40 -0
- package/dist/destinations/tiktok.js.map +1 -0
- package/dist/destinations/vercel-analytics.d.ts +25 -0
- package/dist/destinations/vercel-analytics.d.ts.map +1 -0
- package/dist/destinations/vercel-analytics.js +23 -0
- package/dist/destinations/vercel-analytics.js.map +1 -0
- package/dist/index.d.ts +64 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +41 -0
- package/dist/index.js.map +1 -0
- package/dist/react/consent-banner.d.ts +155 -0
- package/dist/react/consent-banner.d.ts.map +1 -0
- package/dist/react/consent-banner.js +171 -0
- package/dist/react/consent-banner.js.map +1 -0
- package/dist/react/gtag-consent-bootstrap.d.ts +17 -0
- package/dist/react/gtag-consent-bootstrap.d.ts.map +1 -0
- package/dist/react/gtag-consent-bootstrap.js +22 -0
- package/dist/react/gtag-consent-bootstrap.js.map +1 -0
- package/dist/react/use-consent.d.ts +42 -0
- package/dist/react/use-consent.d.ts.map +1 -0
- package/dist/react/use-consent.js +60 -0
- package/dist/react/use-consent.js.map +1 -0
- package/dist/react/use-google-consent-sync.d.ts +20 -0
- package/dist/react/use-google-consent-sync.d.ts.map +1 -0
- package/dist/react/use-google-consent-sync.js +22 -0
- package/dist/react/use-google-consent-sync.js.map +1 -0
- package/dist/react/use-initial-consent.d.ts +11 -0
- package/dist/react/use-initial-consent.d.ts.map +1 -0
- package/dist/react/use-initial-consent.js +18 -0
- package/dist/react/use-initial-consent.js.map +1 -0
- package/dist/server/anonymous-id-cookie.d.ts +67 -0
- package/dist/server/anonymous-id-cookie.d.ts.map +1 -0
- package/dist/server/anonymous-id-cookie.js +71 -0
- package/dist/server/anonymous-id-cookie.js.map +1 -0
- package/dist/server/consent-receipt-store.d.ts +56 -0
- package/dist/server/consent-receipt-store.d.ts.map +1 -0
- package/dist/server/consent-receipt-store.js +44 -0
- package/dist/server/consent-receipt-store.js.map +1 -0
- package/dist/server/consent-receipt.d.ts +41 -0
- package/dist/server/consent-receipt.d.ts.map +1 -0
- package/dist/server/consent-receipt.js +60 -0
- package/dist/server/consent-receipt.js.map +1 -0
- package/dist/server/initial-consent.d.ts +26 -0
- package/dist/server/initial-consent.d.ts.map +1 -0
- package/dist/server/initial-consent.js +31 -0
- package/dist/server/initial-consent.js.map +1 -0
- package/dist/server/measurement-protocol.d.ts +69 -0
- package/dist/server/measurement-protocol.d.ts.map +1 -0
- package/dist/server/measurement-protocol.js +61 -0
- package/dist/server/measurement-protocol.js.map +1 -0
- package/dist/server/region.d.ts +27 -0
- package/dist/server/region.d.ts.map +1 -0
- package/dist/server/region.js +69 -0
- package/dist/server/region.js.map +1 -0
- package/dist/server/user-deletion.d.ts +64 -0
- package/dist/server/user-deletion.d.ts.map +1 -0
- package/dist/server/user-deletion.js +54 -0
- package/dist/server/user-deletion.js.map +1 -0
- package/dist/tooling/import-protection.d.ts +19 -0
- package/dist/tooling/import-protection.d.ts.map +1 -0
- package/dist/tooling/import-protection.js +23 -0
- package/dist/tooling/import-protection.js.map +1 -0
- package/package.json +202 -107
- package/src/adapters/tanstack-start.ts +135 -0
- package/src/client/ad-framework-consent.ts +86 -0
- package/src/client/browser-cookie.ts +16 -0
- package/src/client/consent-runtime.ts +80 -0
- package/src/client/consent-storage.ts +31 -1
- package/src/client/consent-withdrawal.ts +32 -0
- package/src/client/cookie-anonymous-id.ts +112 -0
- package/src/client/create-client-tracker.ts +128 -86
- package/src/client/gpc.ts +4 -2
- package/src/client/initial-consent-store.ts +218 -0
- package/src/client/is-analytics-allowed.ts +43 -0
- package/src/client/server-persisted-anonymous-id.ts +102 -0
- package/src/core/consent-config.ts +27 -0
- package/src/core/consent-receipt.ts +115 -0
- package/src/core/consent.ts +164 -10
- package/src/core/cookie.ts +29 -0
- package/src/core/destination.ts +17 -8
- package/src/core/event-catalog.ts +29 -15
- package/src/core/event-id.ts +1 -2
- package/src/core/tracked-event.ts +4 -4
- package/src/css/consent.css +119 -0
- package/src/destinations/ad-consent.ts +29 -0
- package/src/destinations/google-analytics.ts +196 -133
- package/src/destinations/google-consent.ts +164 -0
- package/src/destinations/meta.ts +96 -0
- package/src/destinations/microsoft-uet.ts +86 -0
- package/src/destinations/shared.ts +45 -0
- package/src/destinations/tiktok.ts +85 -0
- package/src/destinations/vercel-analytics.ts +23 -24
- package/src/index.ts +165 -8
- package/src/react/consent-banner.tsx +308 -111
- package/src/react/gtag-consent-bootstrap.tsx +48 -0
- package/src/react/use-consent.ts +53 -45
- package/src/react/use-google-consent-sync.ts +38 -0
- package/src/react/use-initial-consent.ts +22 -0
- package/src/server/anonymous-id-cookie.ts +103 -0
- package/src/server/consent-receipt-store.ts +79 -0
- package/src/server/consent-receipt.ts +89 -0
- package/src/server/initial-consent.ts +46 -0
- package/src/server/measurement-protocol.ts +114 -0
- package/src/server/region.ts +22 -15
- package/src/server/user-deletion.ts +93 -0
- package/src/tooling/import-protection.ts +22 -0
- package/dist/client/consent-storage.mjs +0 -63
- package/dist/client/create-client-tracker.d.mts +0 -37
- package/dist/client/create-client-tracker.mjs +0 -66
- package/dist/client/gpc.d.mts +0 -10
- package/dist/client/gpc.mjs +0 -12
- package/dist/client/index.d.mts +0 -8
- package/dist/client/index.mjs +0 -8
- package/dist/client/lifecycle.d.mts +0 -23
- package/dist/client/lifecycle.mjs +0 -30
- package/dist/client/local-storage.d.mts +0 -13
- package/dist/client/local-storage.mjs +0 -31
- package/dist/client/queue.d.mts +0 -49
- package/dist/client/queue.mjs +0 -71
- package/dist/client/router.d.mts +0 -30
- package/dist/client/router.mjs +0 -17
- package/dist/core/consent.d.mts +0 -89
- package/dist/core/consent.mjs +0 -57
- package/dist/core/destination.d.mts +0 -23
- package/dist/core/destination.mjs +0 -1
- package/dist/core/event-catalog.d.mts +0 -36
- package/dist/core/event-catalog.mjs +0 -12
- package/dist/core/event-id.d.mts +0 -10
- package/dist/core/event-id.mjs +0 -12
- package/dist/core/index.d.mts +0 -6
- package/dist/core/index.mjs +0 -4
- package/dist/core/tracked-event.d.mts +0 -17
- package/dist/core/tracked-event.mjs +0 -1
- package/dist/destinations/ga4-measurement-protocol.d.mts +0 -54
- package/dist/destinations/ga4-measurement-protocol.mjs +0 -89
- package/dist/destinations/google-analytics.d.mts +0 -98
- package/dist/destinations/google-analytics.mjs +0 -126
- package/dist/destinations/http-destination.d.mts +0 -20
- package/dist/destinations/http-destination.mjs +0 -25
- package/dist/destinations/index.d.mts +0 -5
- package/dist/destinations/index.mjs +0 -5
- package/dist/destinations/vercel-analytics.d.mts +0 -13
- package/dist/destinations/vercel-analytics.mjs +0 -30
- package/dist/index.d.mts +0 -6
- package/dist/index.mjs +0 -4
- package/dist/react/consent-banner.d.mts +0 -75
- package/dist/react/consent-banner.mjs +0 -114
- package/dist/react/index.d.mts +0 -3
- package/dist/react/index.mjs +0 -3
- package/dist/react/use-consent.d.mts +0 -49
- package/dist/react/use-consent.mjs +0 -54
- package/dist/server/create-server-tracker.d.mts +0 -42
- package/dist/server/create-server-tracker.mjs +0 -67
- package/dist/server/index.d.mts +0 -3
- package/dist/server/index.mjs +0 -3
- package/dist/server/region.d.mts +0 -20
- package/dist/server/region.mjs +0 -56
- package/src/client/index.ts +0 -17
- package/src/client/lifecycle.ts +0 -50
- package/src/client/local-storage.ts +0 -44
- package/src/client/queue.ts +0 -117
- package/src/client/router.ts +0 -37
- package/src/core/index.ts +0 -24
- package/src/destinations/ga4-measurement-protocol.ts +0 -166
- package/src/destinations/http-destination.ts +0 -33
- package/src/destinations/index.ts +0 -20
- package/src/react/index.ts +0 -5
- package/src/server/create-server-tracker.ts +0 -128
- package/src/server/index.ts +0 -4
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
|
|
3
|
+
import { useEffect } from "react";
|
|
4
|
+
|
|
5
|
+
import { updateGoogleConsent } from "#/destinations/google-analytics";
|
|
6
|
+
import type { UseConsentResult } from "#/react/use-consent";
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* @since 1.0.0-canary.6
|
|
10
|
+
*/
|
|
11
|
+
export interface UseGoogleConsentSyncOptions {
|
|
12
|
+
/**
|
|
13
|
+
* Idempotent gtag.js load — advanced Consent Mode already injects the tag from a
|
|
14
|
+
* bootstrap; pass a loader as a safety net after a runtime grant.
|
|
15
|
+
*/
|
|
16
|
+
loadGtagScript?: (() => void) | undefined;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Keeps Google Consent Mode v2 in sync with `useConsent`: emits `update` when a stored
|
|
21
|
+
* decision exists (including cross-tab / privacy-page saves), and optionally loads gtag
|
|
22
|
+
* when analytics is effective. Mount once on a page-wide surface (e.g. the footer gate).
|
|
23
|
+
*
|
|
24
|
+
* @since 1.0.0-canary.6
|
|
25
|
+
*/
|
|
26
|
+
export function useGoogleConsentSync(consent: UseConsentResult, options: UseGoogleConsentSyncOptions = {}): void {
|
|
27
|
+
const { loadGtagScript } = options;
|
|
28
|
+
|
|
29
|
+
useEffect(() => {
|
|
30
|
+
if (consent.decision !== undefined) {
|
|
31
|
+
updateGoogleConsent(consent.decision);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
if (consent.effectiveConsent.analytics) {
|
|
35
|
+
loadGtagScript?.();
|
|
36
|
+
}
|
|
37
|
+
}, [consent.decision, consent.effectiveConsent.analytics, loadGtagScript]);
|
|
38
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
|
|
3
|
+
import { useEffect, useSyncExternalStore } from "react";
|
|
4
|
+
|
|
5
|
+
import type { InitialConsentSnapshot, InitialConsentStore } from "#/client/initial-consent-store";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Reactive view of a `createInitialConsentStore` — kicks off resolution on mount (a no-op
|
|
9
|
+
* when the app already did so at router creation) and re-renders once the server lane
|
|
10
|
+
* answers. SSR and the first client render read the strictest snapshot, so hydration can
|
|
11
|
+
* never mismatch on region.
|
|
12
|
+
*
|
|
13
|
+
* @since 1.0.0-canary.6
|
|
14
|
+
*/
|
|
15
|
+
export function useInitialConsent(store: InitialConsentStore): InitialConsentSnapshot {
|
|
16
|
+
// Post-hydration safety net — idempotent with an earlier, pre-hydration kick.
|
|
17
|
+
useEffect(() => {
|
|
18
|
+
store.ensureResolved();
|
|
19
|
+
}, [store]);
|
|
20
|
+
|
|
21
|
+
return useSyncExternalStore(store.subscribe, store.getSnapshot, store.getServerSnapshot);
|
|
22
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { ONE_YEAR_IN_SECONDS } from "#/core/cookie";
|
|
2
|
+
|
|
3
|
+
// The only shape the client ever mints (crypto.randomUUID) — anything else is rejected.
|
|
4
|
+
const UUID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
5
|
+
|
|
6
|
+
// Conservative subset of the RFC 6265 cookie-name token.
|
|
7
|
+
const COOKIE_NAME_PATTERN = /^[\w-]+$/;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Guards the cookie name against anything outside the RFC 6265 token set.
|
|
11
|
+
*
|
|
12
|
+
* @throws Error when `cookieName` is not a valid token.
|
|
13
|
+
*
|
|
14
|
+
* @since 1.0.0-canary.7
|
|
15
|
+
*/
|
|
16
|
+
export function assertValidAnonymousIdCookieName(cookieName: string): void {
|
|
17
|
+
if (!COOKIE_NAME_PATTERN.test(cookieName)) {
|
|
18
|
+
throw new Error(`Invalid anonymous-id cookie name: ${JSON.stringify(cookieName)}`);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Whether a value is safe to persist as an anonymous id. The persist endpoint is public and
|
|
24
|
+
* writes its input into a `Set-Cookie`, so only an exactly-UUID-shaped value may pass —
|
|
25
|
+
* anything else is a header-injection attempt or corruption, never a valid id.
|
|
26
|
+
*
|
|
27
|
+
* @since 1.0.0-canary.6
|
|
28
|
+
*/
|
|
29
|
+
export function isValidAnonymousId(value: string): boolean {
|
|
30
|
+
return UUID_PATTERN.test(value);
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* @since 1.0.0-canary.6
|
|
35
|
+
*/
|
|
36
|
+
export interface AnonymousIdCookieOptions {
|
|
37
|
+
/** Cookie name — must match what the client tracker reads. */
|
|
38
|
+
cookieName: string;
|
|
39
|
+
/** The client-minted id to persist — throws unless it is exactly UUID-shaped. */
|
|
40
|
+
id: string;
|
|
41
|
+
/** How long the id survives a return visit. Defaults to one year. */
|
|
42
|
+
maxAgeSeconds?: number | undefined;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* The validated name/value plus cookie attributes for persisting a client-minted anonymous
|
|
47
|
+
* id from the server — feed straight into the framework's cookie helper (`setCookie`).
|
|
48
|
+
*
|
|
49
|
+
* @remarks
|
|
50
|
+
* Always `Secure` — on a plain-HTTP dev origin a browser may drop it, and the
|
|
51
|
+
* client-written cookie (`createServerPersistedAnonymousId`'s optimistic write) still
|
|
52
|
+
* covers that session. Not `httpOnly`: the client tracker must read the id to stamp it onto
|
|
53
|
+
* events. A server-set cookie escapes Safari ITP's 7-day cap on `document.cookie` writes, so
|
|
54
|
+
* the id actually lives its full max-age. The server only ever re-sets an id the client
|
|
55
|
+
* hands it — minting stays client-side, after consent, by design.
|
|
56
|
+
*
|
|
57
|
+
* @throws Error when `id` is not UUID-shaped or `cookieName` is not a valid token.
|
|
58
|
+
*
|
|
59
|
+
* @since 1.0.0-canary.6
|
|
60
|
+
*/
|
|
61
|
+
export function resolveAnonymousIdCookie(options: AnonymousIdCookieOptions): {
|
|
62
|
+
maxAge: number;
|
|
63
|
+
name: string;
|
|
64
|
+
path: string;
|
|
65
|
+
sameSite: "lax";
|
|
66
|
+
secure: true;
|
|
67
|
+
value: string;
|
|
68
|
+
} {
|
|
69
|
+
assertValidAnonymousIdCookieName(options.cookieName);
|
|
70
|
+
|
|
71
|
+
if (!isValidAnonymousId(options.id)) {
|
|
72
|
+
throw new Error("Invalid anonymous id: expected a UUID-shaped value");
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
return {
|
|
76
|
+
maxAge: options.maxAgeSeconds ?? ONE_YEAR_IN_SECONDS,
|
|
77
|
+
name: options.cookieName,
|
|
78
|
+
path: "/",
|
|
79
|
+
sameSite: "lax",
|
|
80
|
+
secure: true,
|
|
81
|
+
value: options.id,
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Name plus attributes for expiring the anonymous-id cookie — the server half of a consent
|
|
87
|
+
* withdrawal. Attributes must match {@link resolveAnonymousIdCookie} so the browser targets
|
|
88
|
+
* the same cookie. Feed into the framework's `deleteCookie`.
|
|
89
|
+
*
|
|
90
|
+
* @throws Error when `cookieName` is not a valid token.
|
|
91
|
+
*
|
|
92
|
+
* @since 1.0.0-canary.6
|
|
93
|
+
*/
|
|
94
|
+
export function resolveClearAnonymousIdCookie(cookieName: string): {
|
|
95
|
+
name: string;
|
|
96
|
+
path: string;
|
|
97
|
+
sameSite: "lax";
|
|
98
|
+
secure: true;
|
|
99
|
+
} {
|
|
100
|
+
assertValidAnonymousIdCookieName(cookieName);
|
|
101
|
+
|
|
102
|
+
return { name: cookieName, path: "/", sameSite: "lax", secure: true };
|
|
103
|
+
}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import type { ConsentReceipt } from "#/core/consent-receipt";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Persistence backend for consent receipts — the durable store is the consumer's to supply
|
|
5
|
+
* (a database, an append-only log). The store is **append-only**: `append` never overwrites,
|
|
6
|
+
* and an update/withdrawal is a new receipt referencing the prior one (spec-consent-receipts §3).
|
|
7
|
+
* May be async so a real backend can await its write.
|
|
8
|
+
*
|
|
9
|
+
* @since 1.0.0-canary.7
|
|
10
|
+
*/
|
|
11
|
+
export interface ReceiptStore {
|
|
12
|
+
append: (receipt: ConsentReceipt) => Promise<void> | void;
|
|
13
|
+
get: (receiptId: string) => ConsentReceipt | undefined | Promise<ConsentReceipt | undefined>;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* An in-memory {@link ReceiptStore} for development and tests — **not** durable across a
|
|
18
|
+
* process restart, and not a lawful production store on its own. A real deployment supplies
|
|
19
|
+
* a database-backed implementation; this exists so the endpoint is runnable end-to-end
|
|
20
|
+
* without standing up storage first.
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* Append is idempotent-by-id: re-appending the same `receiptId` is ignored, preserving the
|
|
24
|
+
* append-only guarantee even if a client retries.
|
|
25
|
+
*
|
|
26
|
+
* @since 1.0.0-canary.7
|
|
27
|
+
*/
|
|
28
|
+
export function createInMemoryReceiptStore(): ReceiptStore {
|
|
29
|
+
const receipts = new Map<string, ConsentReceipt>();
|
|
30
|
+
|
|
31
|
+
return {
|
|
32
|
+
append(receipt: ConsentReceipt): void {
|
|
33
|
+
if (!receipts.has(receipt.receiptId)) {
|
|
34
|
+
receipts.set(receipt.receiptId, receipt);
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
get(receiptId: string): ConsentReceipt | undefined {
|
|
38
|
+
return receipts.get(receiptId);
|
|
39
|
+
},
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* The minimal id-keyed primitive a durable backend must expose for {@link createDurableReceiptStore}.
|
|
45
|
+
* Keeping it this small lets an integrator back receipts with any store (Vercel KV, Postgres,
|
|
46
|
+
* an append-only log) by implementing two methods rather than the full {@link ReceiptStore}.
|
|
47
|
+
*
|
|
48
|
+
* @since 1.0.0-canary.7
|
|
49
|
+
*/
|
|
50
|
+
export interface ReceiptStoreBackend {
|
|
51
|
+
get: (receiptId: string) => Promise<ConsentReceipt | undefined>;
|
|
52
|
+
/**
|
|
53
|
+
* Persist one receipt under its id. MUST be idempotent-by-id and never overwrite — a
|
|
54
|
+
* duplicate `receiptId` is a no-op — so the append-only guarantee holds atomically even
|
|
55
|
+
* under a client retry or concurrent write (e.g. KV set-if-absent, Postgres
|
|
56
|
+
* `INSERT … ON CONFLICT DO NOTHING`). The frame delegates rather than doing a racy
|
|
57
|
+
* get-then-put itself.
|
|
58
|
+
*/
|
|
59
|
+
put: (receiptId: string, receipt: ConsentReceipt) => Promise<void>;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* A durable {@link ReceiptStore} over an injected {@link ReceiptStoreBackend} — the package
|
|
64
|
+
* supplies the append-only contract and adaptation, the deployment supplies the backend
|
|
65
|
+
* client (no database dependency is baked in). Pair it with a real backend in production,
|
|
66
|
+
* where {@link createInMemoryReceiptStore} is not a lawful store on its own.
|
|
67
|
+
*
|
|
68
|
+
* @since 1.0.0-canary.7
|
|
69
|
+
*/
|
|
70
|
+
export function createDurableReceiptStore(options: { backend: ReceiptStoreBackend }): ReceiptStore {
|
|
71
|
+
return {
|
|
72
|
+
async append(receipt: ConsentReceipt): Promise<void> {
|
|
73
|
+
await options.backend.put(receipt.receiptId, receipt);
|
|
74
|
+
},
|
|
75
|
+
async get(receiptId: string): Promise<ConsentReceipt | undefined> {
|
|
76
|
+
return options.backend.get(receiptId);
|
|
77
|
+
},
|
|
78
|
+
};
|
|
79
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import type { ConsentReceipt, ConsentReceiptInput } from "#/core/consent-receipt";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* The receipt information-structure version this builder emits (ISO/IEC TS 27560-shaped).
|
|
5
|
+
* Bump when the receipt field set changes; stored receipts carry it so a reader can migrate.
|
|
6
|
+
*
|
|
7
|
+
* @since 1.0.0-canary.7
|
|
8
|
+
*/
|
|
9
|
+
export const RECEIPT_SCHEMA_VERSION = "1.0.0";
|
|
10
|
+
|
|
11
|
+
const IPV4_PATTERN = /^(\d{1,3}\.){3}\d{1,3}$/;
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Coarsens an IP for storage — a full address MUST never be persisted (spec-consent-receipts
|
|
15
|
+
* §4, R5). IPv4 drops the last two octets; IPv6 keeps only the first two hextets. This mirrors
|
|
16
|
+
* the Cookiebot-style anonymization cited in the spec and is the maximally-private default;
|
|
17
|
+
* a controller may widen it under counsel, but the builder never returns a full address.
|
|
18
|
+
* Returns `undefined` for a missing or malformed input rather than storing a bad value.
|
|
19
|
+
*
|
|
20
|
+
* @since 1.0.0-canary.7
|
|
21
|
+
*/
|
|
22
|
+
export function coarsenIp(ip: string | null | undefined): string | undefined {
|
|
23
|
+
if (!ip) {
|
|
24
|
+
return undefined;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const trimmed = ip.trim();
|
|
28
|
+
|
|
29
|
+
if (IPV4_PATTERN.test(trimmed)) {
|
|
30
|
+
const octets = trimmed.split(".");
|
|
31
|
+
|
|
32
|
+
// Reject out-of-range octets (e.g. "999.1.1.1") rather than storing a malformed coarse value.
|
|
33
|
+
if (octets.some((octet) => Number(octet) > 255)) {
|
|
34
|
+
return undefined;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
return `${octets[0]}.${octets[1]}.0.0`;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
if (trimmed.includes(":")) {
|
|
41
|
+
const [first, second] = trimmed.split(":");
|
|
42
|
+
|
|
43
|
+
// Require two explicit leading hextets — a compressed-leading address ("::1", "fe80::1")
|
|
44
|
+
// can't be coarsened without full expansion, so degrade to no stored value.
|
|
45
|
+
if (!first || !second) {
|
|
46
|
+
return undefined;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
return `${first}:${second}::`;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
return undefined;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* @remarks
|
|
57
|
+
* `sign` is optional so the package never bakes a crypto secret: supply an HMAC/signature
|
|
58
|
+
* function to stamp an `integrityKey`, letting a client prove its state matches the stored
|
|
59
|
+
* original (spec-consent-receipts §5). Omit it and receipts carry no integrity key.
|
|
60
|
+
*
|
|
61
|
+
* @since 1.0.0-canary.7
|
|
62
|
+
*/
|
|
63
|
+
export interface BuildConsentReceiptOptions {
|
|
64
|
+
input: ConsentReceiptInput;
|
|
65
|
+
/** The connection IP, read server-side — never accepted from the request body. */
|
|
66
|
+
rawIp?: string | null | undefined;
|
|
67
|
+
sign?: ((receipt: Omit<ConsentReceipt, "integrityKey">) => string) | undefined;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Builds a stored consent receipt from caller input plus server-derived fields
|
|
72
|
+
* (`receiptId`, `timestamp`, coarsened IP, optional `integrityKey`). Pure except for the
|
|
73
|
+
* id/clock it stamps — pass those in via a seam if a deterministic build is needed.
|
|
74
|
+
*
|
|
75
|
+
* @since 1.0.0-canary.7
|
|
76
|
+
*/
|
|
77
|
+
export function buildConsentReceipt(options: BuildConsentReceiptOptions): ConsentReceipt {
|
|
78
|
+
const base: Omit<ConsentReceipt, "integrityKey"> = {
|
|
79
|
+
...options.input,
|
|
80
|
+
ipCoarse: coarsenIp(options.rawIp),
|
|
81
|
+
receiptId: crypto.randomUUID(),
|
|
82
|
+
schemaVersion: RECEIPT_SCHEMA_VERSION,
|
|
83
|
+
timestamp: Date.now(),
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
const integrityKey = options.sign?.(base);
|
|
87
|
+
|
|
88
|
+
return integrityKey === undefined ? base : { ...base, integrityKey };
|
|
89
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { ConsentCategory, InitialConsent } from "#/core/consent";
|
|
2
|
+
import { resolveConsentMode, resolveDefaultConsent, STRICTEST_INITIAL_CONSENT } from "#/core/consent";
|
|
3
|
+
import { resolveRegionFromCountryCode } from "#/server/region";
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* @since 1.0.0-canary.6
|
|
7
|
+
*/
|
|
8
|
+
export interface InitialConsentOptions {
|
|
9
|
+
/** ISO 3166-1 alpha-2 from the geo header; missing → the strictest opt-in default. */
|
|
10
|
+
countryCode: string | undefined;
|
|
11
|
+
/** Honored as an ads-only opt-out on the default decision. */
|
|
12
|
+
hasGlobalPrivacyControlSignal?: boolean | undefined;
|
|
13
|
+
/** Categories the app's prompt asks about — opt-out regions grant exactly these by default. */
|
|
14
|
+
requestedCategories: ReadonlyArray<ConsentCategory>;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Pure region → mode → default-consent resolution for server functions (or a fail-closed
|
|
19
|
+
* bake when country is unknown). Named with the `resolve*` family it composes.
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* A missing country code means an unknown visitor (a prerender crawl, a host without a
|
|
23
|
+
* geo header) — not a known non-EU visitor — so it fails closed to
|
|
24
|
+
* {@link STRICTEST_INITIAL_CONSENT} instead of `"other"`'s opt-out. Conflating the two
|
|
25
|
+
* would grant analytics by default to every visitor, EU included, on a geo-less host.
|
|
26
|
+
*
|
|
27
|
+
* @since 1.0.0-canary.6
|
|
28
|
+
*/
|
|
29
|
+
export function resolveInitialConsent(options: InitialConsentOptions): InitialConsent {
|
|
30
|
+
if (!options.countryCode) {
|
|
31
|
+
return STRICTEST_INITIAL_CONSENT;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const region = resolveRegionFromCountryCode(options.countryCode);
|
|
35
|
+
const mode = resolveConsentMode(region);
|
|
36
|
+
|
|
37
|
+
return {
|
|
38
|
+
defaultConsent: resolveDefaultConsent({
|
|
39
|
+
hasGlobalPrivacyControlSignal: options.hasGlobalPrivacyControlSignal ?? false,
|
|
40
|
+
mode,
|
|
41
|
+
requestedCategories: options.requestedCategories,
|
|
42
|
+
}),
|
|
43
|
+
mode,
|
|
44
|
+
region,
|
|
45
|
+
};
|
|
46
|
+
}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import type { ConsentDecision } from "#/core/consent";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* A GA4 event for the Measurement Protocol. `params` are flat scalars — GA4 rejects nested values and booleans.
|
|
5
|
+
*
|
|
6
|
+
* @since 1.0.0-canary.7
|
|
7
|
+
*/
|
|
8
|
+
export interface MeasurementProtocolEvent {
|
|
9
|
+
name: string;
|
|
10
|
+
params?: Record<string, number | string> | undefined;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* The GA4 MP `consent` object — the two ad-consent signals the payload accepts.
|
|
15
|
+
*
|
|
16
|
+
* @since 1.0.0-canary.7
|
|
17
|
+
*/
|
|
18
|
+
export interface MeasurementProtocolConsent {
|
|
19
|
+
ad_personalization: "DENIED" | "GRANTED";
|
|
20
|
+
ad_user_data: "DENIED" | "GRANTED";
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Maps the package `ConsentDecision` to GA4 MP consent signals — `ads` drives both ad fields.
|
|
25
|
+
*
|
|
26
|
+
* @since 1.0.0-canary.7
|
|
27
|
+
*/
|
|
28
|
+
export function toMeasurementProtocolConsent(decision: ConsentDecision): MeasurementProtocolConsent {
|
|
29
|
+
const state = decision.ads ? "GRANTED" : "DENIED";
|
|
30
|
+
|
|
31
|
+
return { ad_personalization: state, ad_user_data: state };
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Extracts the GA4 `client_id` from a `_ga` cookie value, e.g.
|
|
36
|
+
* `GA1.1.1809596761.1693829043` → `1809596761.1693829043` (everything past the
|
|
37
|
+
* `GA1.<version>.` prefix). The `_ga` layout is community-established, not part of the
|
|
38
|
+
* Measurement Protocol reference, so anything that doesn't parse returns `undefined` rather
|
|
39
|
+
* than sending a malformed id.
|
|
40
|
+
*
|
|
41
|
+
* @since 1.0.0-canary.7
|
|
42
|
+
*/
|
|
43
|
+
export function extractGaClientId(gaCookieValue: string | undefined): string | undefined {
|
|
44
|
+
if (!gaCookieValue) {
|
|
45
|
+
return undefined;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
const segments = gaCookieValue.split(".");
|
|
49
|
+
|
|
50
|
+
if (segments.length < 4 || segments[0] !== "GA1") {
|
|
51
|
+
return undefined;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
return segments.slice(2).join(".");
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* The one network primitive the sender needs — injected so the package ships no HTTP client.
|
|
59
|
+
*
|
|
60
|
+
* @since 1.0.0-canary.7
|
|
61
|
+
*/
|
|
62
|
+
export type MeasurementProtocolTransport = (request: { body: string; url: string }) => Promise<void>;
|
|
63
|
+
|
|
64
|
+
/** Default GA4 collection origin; use `https://region1.google-analytics.com` for EU data residency. */
|
|
65
|
+
const DEFAULT_ENDPOINT_ORIGIN = "https://www.google-analytics.com";
|
|
66
|
+
|
|
67
|
+
async function defaultTransport(request: { body: string; url: string }): Promise<void> {
|
|
68
|
+
const response = await fetch(request.url, {
|
|
69
|
+
body: request.body,
|
|
70
|
+
headers: { "content-type": "application/json" },
|
|
71
|
+
method: "POST",
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
// MP returns 2xx with no useful body; a non-2xx is a config error worth surfacing.
|
|
75
|
+
if (!response.ok) {
|
|
76
|
+
throw new Error(`Measurement Protocol responded ${String(response.status)}`);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* @since 1.0.0-canary.7
|
|
82
|
+
*/
|
|
83
|
+
export interface SendMeasurementProtocolEventsOptions {
|
|
84
|
+
/** GA4 **API Secret** — read server-side from config, never a client-exposed var. */
|
|
85
|
+
apiSecret: string;
|
|
86
|
+
/** The visitor's GA4 client id (see {@link extractGaClientId}). */
|
|
87
|
+
clientId: string;
|
|
88
|
+
consent?: MeasurementProtocolConsent | undefined;
|
|
89
|
+
endpointOrigin?: string | undefined;
|
|
90
|
+
events: ReadonlyArray<MeasurementProtocolEvent>;
|
|
91
|
+
measurementId: string;
|
|
92
|
+
transport?: MeasurementProtocolTransport | undefined;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* POSTs one or more events to the GA4 Measurement Protocol for a known `client_id` — the
|
|
97
|
+
* server-side counterpart to gtag.js. The caller owns credentials (never bake them) and the
|
|
98
|
+
* consent gate: send only for a server-owned event the visitor's consent permits.
|
|
99
|
+
*
|
|
100
|
+
* @see https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events
|
|
101
|
+
*
|
|
102
|
+
* @since 1.0.0-canary.7
|
|
103
|
+
*/
|
|
104
|
+
export async function sendMeasurementProtocolEvents(options: SendMeasurementProtocolEventsOptions): Promise<void> {
|
|
105
|
+
const origin = options.endpointOrigin ?? DEFAULT_ENDPOINT_ORIGIN;
|
|
106
|
+
const url = `${origin}/mp/collect?measurement_id=${encodeURIComponent(options.measurementId)}&api_secret=${encodeURIComponent(options.apiSecret)}`;
|
|
107
|
+
const body = JSON.stringify({
|
|
108
|
+
client_id: options.clientId,
|
|
109
|
+
events: options.events,
|
|
110
|
+
...(options.consent ? { consent: options.consent } : {}),
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
await (options.transport ?? defaultTransport)({ body, url });
|
|
114
|
+
}
|
package/src/server/region.ts
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
import type { ConsentRegion } from "#/core/consent";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
/**
|
|
4
|
+
* EU member states — GDPR opt-in via `resolveConsentMode("eu")`.
|
|
5
|
+
*
|
|
6
|
+
* @since 1.0.0-canary.6
|
|
7
|
+
*/
|
|
8
|
+
export const EU_COUNTRY_CODES: ReadonlySet<string> = new Set([
|
|
4
9
|
"AT",
|
|
5
10
|
"BE",
|
|
6
11
|
"BG",
|
|
@@ -31,9 +36,21 @@ const EU_COUNTRY_CODES = new Set([
|
|
|
31
36
|
]);
|
|
32
37
|
|
|
33
38
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
39
|
+
* UK GDPR (post-Brexit) and EEA/EFTA states that apply GDPR-equivalent rules — mapped to
|
|
40
|
+
* the same `"eu"` consent region so they get opt-in, not the `"other"` opt-out default.
|
|
41
|
+
*
|
|
42
|
+
* Restricted edge runtimes that cannot import this package should duplicate these codes
|
|
43
|
+
* and keep a sync test against this export.
|
|
44
|
+
*
|
|
45
|
+
* @since 1.0.0-canary.6
|
|
46
|
+
*/
|
|
47
|
+
export const OPT_IN_EQUIVALENT_COUNTRY_CODES: ReadonlySet<string> = new Set(["GB", "IS", "LI", "NO"]);
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Unrecognized codes fall back to "other", which `resolveConsentMode` treats as
|
|
51
|
+
* opt-out — safe only because opt-in regions (EU/VN plus UK/EEA/EFTA above) are matched
|
|
52
|
+
* explicitly. A *missing* code also maps to "other" here, but `resolveInitialConsent`
|
|
53
|
+
* intercepts that case first and fails closed — unknown is not known-elsewhere.
|
|
37
54
|
*
|
|
38
55
|
* @since 0.5.0-canary.4
|
|
39
56
|
*/
|
|
@@ -44,7 +61,7 @@ export function resolveRegionFromCountryCode(countryCode: string | undefined): C
|
|
|
44
61
|
|
|
45
62
|
const normalized = countryCode.toUpperCase();
|
|
46
63
|
|
|
47
|
-
if (EU_COUNTRY_CODES.has(normalized)) {
|
|
64
|
+
if (EU_COUNTRY_CODES.has(normalized) || OPT_IN_EQUIVALENT_COUNTRY_CODES.has(normalized)) {
|
|
48
65
|
return "eu";
|
|
49
66
|
}
|
|
50
67
|
|
|
@@ -58,13 +75,3 @@ export function resolveRegionFromCountryCode(countryCode: string | undefined): C
|
|
|
58
75
|
|
|
59
76
|
return "other";
|
|
60
77
|
}
|
|
61
|
-
|
|
62
|
-
/**
|
|
63
|
-
* Reads the hosting platform's geo header (e.g. Vercel's `x-vercel-ip-country`) — pass
|
|
64
|
-
* the incoming request's `Headers` from server-function/middleware context.
|
|
65
|
-
*
|
|
66
|
-
* @since 0.5.0-canary.4
|
|
67
|
-
*/
|
|
68
|
-
export function resolveRegion(headers: Headers, headerName = "x-vercel-ip-country"): ConsentRegion {
|
|
69
|
-
return resolveRegionFromCountryCode(headers.get(headerName) ?? undefined);
|
|
70
|
-
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DSR delegation for GA4 (spec-data-subject-rights §3): the platform ships its own
|
|
3
|
+
* per-visitor deletion, so the system **delegates** rather than reimplementing a deletion
|
|
4
|
+
* store. Targets the current **Analytics Admin API** `properties.submitUserDeletion` — the
|
|
5
|
+
* legacy v3 `userDeletionRequests:upsert` was sunset with Universal Analytics, so the spec's
|
|
6
|
+
* DSR-V3 `{ id: { type: "CLIENT_ID", userId } }` shape is stale; the current request keys the
|
|
7
|
+
* subject with a flat `clientId` (a oneof with `userId`/`appInstanceId`/`userProvidedData`).
|
|
8
|
+
*
|
|
9
|
+
* @see https://developers.google.com/analytics/devguides/config/userdeletion/migration
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
const ADMIN_API_ORIGIN = "https://analyticsadmin.googleapis.com";
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* @since 1.0.0-canary.7
|
|
16
|
+
*/
|
|
17
|
+
export interface Ga4UserDeletionRequest {
|
|
18
|
+
body: { clientId: string };
|
|
19
|
+
url: string;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Builds the Admin API `submitUserDeletion` request that erases one GA4 subject by
|
|
24
|
+
* `clientId` (the `_ga`-cookie id — see `extractGaClientId`). Pure and network-free so the
|
|
25
|
+
* request shape can be snapshotted/verified; pair it with {@link submitGa4UserDeletion} or
|
|
26
|
+
* any authenticated transport.
|
|
27
|
+
*
|
|
28
|
+
* @param options - `propertyId` is the numeric GA4 property (no `properties/` prefix).
|
|
29
|
+
*
|
|
30
|
+
* @since 1.0.0-canary.7
|
|
31
|
+
*/
|
|
32
|
+
export function buildGa4UserDeletionRequest(options: { clientId: string; propertyId: string }): Ga4UserDeletionRequest {
|
|
33
|
+
return {
|
|
34
|
+
body: { clientId: options.clientId },
|
|
35
|
+
url: `${ADMIN_API_ORIGIN}/v1alpha/properties/${options.propertyId}:submitUserDeletion`,
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* The one network primitive the sender needs — injected so the package ships no HTTP client.
|
|
41
|
+
*
|
|
42
|
+
* @since 1.0.0-canary.7
|
|
43
|
+
*/
|
|
44
|
+
export type Ga4UserDeletionTransport = (request: {
|
|
45
|
+
body: string;
|
|
46
|
+
headers: Record<string, string>;
|
|
47
|
+
url: string;
|
|
48
|
+
}) => Promise<void>;
|
|
49
|
+
|
|
50
|
+
async function defaultTransport(request: {
|
|
51
|
+
body: string;
|
|
52
|
+
headers: Record<string, string>;
|
|
53
|
+
url: string;
|
|
54
|
+
}): Promise<void> {
|
|
55
|
+
const response = await fetch(request.url, { body: request.body, headers: request.headers, method: "POST" });
|
|
56
|
+
|
|
57
|
+
if (!response.ok) {
|
|
58
|
+
throw new Error(`GA4 user deletion responded ${String(response.status)}`);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* @since 1.0.0-canary.7
|
|
64
|
+
*/
|
|
65
|
+
export interface SubmitGa4UserDeletionOptions {
|
|
66
|
+
/** A bearer token for the `https://www.googleapis.com/auth/analytics.edit` scope — the caller owns OAuth. */
|
|
67
|
+
accessToken: string;
|
|
68
|
+
clientId: string;
|
|
69
|
+
propertyId: string;
|
|
70
|
+
transport?: Ga4UserDeletionTransport | undefined;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Submits a GA4 user-deletion request for one `clientId`. Authorization is the caller's:
|
|
75
|
+
* pass a bearer token minted from a service account (never baked into the package). The
|
|
76
|
+
* deletion removes the subject from the Individual User report within ~72h and purges at the
|
|
77
|
+
* next run; it does **not** reach previously-aggregated reports or BigQuery exports
|
|
78
|
+
* (spec-data-subject-rights §3).
|
|
79
|
+
*
|
|
80
|
+
* @since 1.0.0-canary.7
|
|
81
|
+
*/
|
|
82
|
+
export async function submitGa4UserDeletion(options: SubmitGa4UserDeletionOptions): Promise<void> {
|
|
83
|
+
const request = buildGa4UserDeletionRequest({ clientId: options.clientId, propertyId: options.propertyId });
|
|
84
|
+
|
|
85
|
+
await (options.transport ?? defaultTransport)({
|
|
86
|
+
body: JSON.stringify(request.body),
|
|
87
|
+
headers: {
|
|
88
|
+
authorization: `Bearer ${options.accessToken}`,
|
|
89
|
+
"content-type": "application/json",
|
|
90
|
+
},
|
|
91
|
+
url: request.url,
|
|
92
|
+
});
|
|
93
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The `@codefast/tracking` subpaths every client bundle must deny (picomatch patterns) —
|
|
3
|
+
* framework-neutral data each build tool maps to its own guard: TanStack Start's
|
|
4
|
+
* `importProtection.client.specifiers`, Next's `server-only`, Remix's `.server` convention.
|
|
5
|
+
* Ships and versions with the package instead of going stale in each consumer's config.
|
|
6
|
+
* Nothing in this package imports it — its consumers are app build configs (see apps/ui
|
|
7
|
+
* vite.config.ts).
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* tanstackStart({
|
|
12
|
+
* importProtection: { client: { specifiers: [...SERVER_ONLY_SUBPATHS] } },
|
|
13
|
+
* });
|
|
14
|
+
* ```
|
|
15
|
+
*
|
|
16
|
+
* @since 1.0.0-canary.6
|
|
17
|
+
*/
|
|
18
|
+
export const SERVER_ONLY_SUBPATHS: ReadonlyArray<string> = [
|
|
19
|
+
"@codefast/tracking/server",
|
|
20
|
+
"@codefast/tracking/server/**",
|
|
21
|
+
"@codefast/tracking/adapters/**",
|
|
22
|
+
];
|