@codefast/tracking 0.7.1 → 0.7.3

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.
Files changed (214) hide show
  1. package/CHANGELOG.md +49 -0
  2. package/LICENSE +1 -1
  3. package/README.md +235 -105
  4. package/dist/adapters/tanstack-start.d.ts +5 -6
  5. package/dist/adapters/tanstack-start.js +5 -6
  6. package/dist/client/ad-framework-consent.d.ts +2 -3
  7. package/dist/client/ad-framework-consent.js +1 -2
  8. package/dist/client/browser-cookie.d.ts +1 -2
  9. package/dist/client/browser-cookie.js +1 -2
  10. package/dist/client/consent-runtime.d.ts +4 -5
  11. package/dist/client/consent-runtime.js +5 -6
  12. package/dist/client/consent-storage.d.ts +2 -3
  13. package/dist/client/consent-storage.js +2 -3
  14. package/dist/client/consent-withdrawal.d.ts +2 -3
  15. package/dist/client/consent-withdrawal.js +1 -2
  16. package/dist/client/cookie-anonymous-id.d.ts +1 -2
  17. package/dist/client/cookie-anonymous-id.js +3 -4
  18. package/dist/client/create-client-tracker.d.ts +4 -5
  19. package/dist/client/create-client-tracker.js +3 -4
  20. package/dist/client/gpc.d.ts +1 -2
  21. package/dist/client/gpc.js +1 -2
  22. package/dist/client/initial-consent-store.d.ts +2 -3
  23. package/dist/client/initial-consent-store.js +2 -3
  24. package/dist/client/is-analytics-allowed.d.ts +3 -4
  25. package/dist/client/is-analytics-allowed.js +2 -3
  26. package/dist/client/server-persisted-anonymous-id.d.ts +2 -3
  27. package/dist/client/server-persisted-anonymous-id.js +3 -4
  28. package/dist/core/consent-config.d.ts +2 -3
  29. package/dist/core/consent-config.js +1 -2
  30. package/dist/core/consent-receipt.d.ts +2 -3
  31. package/dist/core/consent-receipt.js +2 -3
  32. package/dist/core/consent.d.ts +1 -2
  33. package/dist/core/consent.js +1 -2
  34. package/dist/core/cookie.d.ts +1 -2
  35. package/dist/core/cookie.js +1 -2
  36. package/dist/core/destination.d.ts +2 -3
  37. package/dist/core/destination.js +1 -2
  38. package/dist/core/event-catalog.d.ts +1 -2
  39. package/dist/core/event-catalog.js +1 -2
  40. package/dist/core/event-id.d.ts +1 -2
  41. package/dist/core/event-id.js +1 -2
  42. package/dist/core/tracked-event.d.ts +1 -2
  43. package/dist/core/tracked-event.js +1 -2
  44. package/dist/destinations/ad-consent.d.ts +2 -3
  45. package/dist/destinations/ad-consent.js +1 -2
  46. package/dist/destinations/google-analytics.d.ts +6 -7
  47. package/dist/destinations/google-analytics.js +3 -4
  48. package/dist/destinations/google-consent.d.ts +2 -3
  49. package/dist/destinations/google-consent.js +2 -3
  50. package/dist/destinations/meta.d.ts +4 -5
  51. package/dist/destinations/meta.js +3 -4
  52. package/dist/destinations/microsoft-uet.d.ts +4 -5
  53. package/dist/destinations/microsoft-uet.js +3 -4
  54. package/dist/destinations/shared.d.ts +1 -2
  55. package/dist/destinations/shared.js +1 -2
  56. package/dist/destinations/tiktok.d.ts +4 -5
  57. package/dist/destinations/tiktok.js +3 -4
  58. package/dist/destinations/vercel-analytics.d.ts +2 -3
  59. package/dist/destinations/vercel-analytics.js +2 -3
  60. package/dist/index.d.ts +49 -50
  61. package/dist/index.js +26 -27
  62. package/dist/react/consent-banner.d.ts +3 -4
  63. package/dist/react/consent-banner.js +1 -2
  64. package/dist/react/gtag-consent-bootstrap.d.ts +2 -3
  65. package/dist/react/gtag-consent-bootstrap.js +2 -3
  66. package/dist/react/use-consent.d.ts +3 -4
  67. package/dist/react/use-consent.js +2 -3
  68. package/dist/react/use-google-consent-sync.d.ts +2 -3
  69. package/dist/react/use-google-consent-sync.js +2 -3
  70. package/dist/react/use-initial-consent.d.ts +2 -3
  71. package/dist/react/use-initial-consent.js +1 -2
  72. package/dist/server/anonymous-id-cookie.d.ts +1 -2
  73. package/dist/server/anonymous-id-cookie.js +2 -3
  74. package/dist/server/consent-receipt-store.d.ts +2 -3
  75. package/dist/server/consent-receipt-store.js +1 -2
  76. package/dist/server/consent-receipt.d.ts +2 -3
  77. package/dist/server/consent-receipt.js +1 -2
  78. package/dist/server/initial-consent.d.ts +2 -3
  79. package/dist/server/initial-consent.js +3 -4
  80. package/dist/server/measurement-protocol.d.ts +2 -3
  81. package/dist/server/measurement-protocol.js +1 -2
  82. package/dist/server/region.d.ts +2 -3
  83. package/dist/server/region.js +1 -2
  84. package/dist/server/user-deletion.d.ts +1 -2
  85. package/dist/server/user-deletion.js +1 -2
  86. package/dist/tooling/import-protection.d.ts +2 -3
  87. package/dist/tooling/import-protection.js +2 -3
  88. package/package.json +5 -94
  89. package/dist/adapters/tanstack-start.d.ts.map +0 -1
  90. package/dist/adapters/tanstack-start.js.map +0 -1
  91. package/dist/client/ad-framework-consent.d.ts.map +0 -1
  92. package/dist/client/ad-framework-consent.js.map +0 -1
  93. package/dist/client/browser-cookie.d.ts.map +0 -1
  94. package/dist/client/browser-cookie.js.map +0 -1
  95. package/dist/client/consent-runtime.d.ts.map +0 -1
  96. package/dist/client/consent-runtime.js.map +0 -1
  97. package/dist/client/consent-storage.d.ts.map +0 -1
  98. package/dist/client/consent-storage.js.map +0 -1
  99. package/dist/client/consent-withdrawal.d.ts.map +0 -1
  100. package/dist/client/consent-withdrawal.js.map +0 -1
  101. package/dist/client/cookie-anonymous-id.d.ts.map +0 -1
  102. package/dist/client/cookie-anonymous-id.js.map +0 -1
  103. package/dist/client/create-client-tracker.d.ts.map +0 -1
  104. package/dist/client/create-client-tracker.js.map +0 -1
  105. package/dist/client/gpc.d.ts.map +0 -1
  106. package/dist/client/gpc.js.map +0 -1
  107. package/dist/client/initial-consent-store.d.ts.map +0 -1
  108. package/dist/client/initial-consent-store.js.map +0 -1
  109. package/dist/client/is-analytics-allowed.d.ts.map +0 -1
  110. package/dist/client/is-analytics-allowed.js.map +0 -1
  111. package/dist/client/server-persisted-anonymous-id.d.ts.map +0 -1
  112. package/dist/client/server-persisted-anonymous-id.js.map +0 -1
  113. package/dist/core/consent-config.d.ts.map +0 -1
  114. package/dist/core/consent-config.js.map +0 -1
  115. package/dist/core/consent-receipt.d.ts.map +0 -1
  116. package/dist/core/consent-receipt.js.map +0 -1
  117. package/dist/core/consent.d.ts.map +0 -1
  118. package/dist/core/consent.js.map +0 -1
  119. package/dist/core/cookie.d.ts.map +0 -1
  120. package/dist/core/cookie.js.map +0 -1
  121. package/dist/core/destination.d.ts.map +0 -1
  122. package/dist/core/destination.js.map +0 -1
  123. package/dist/core/event-catalog.d.ts.map +0 -1
  124. package/dist/core/event-catalog.js.map +0 -1
  125. package/dist/core/event-id.d.ts.map +0 -1
  126. package/dist/core/event-id.js.map +0 -1
  127. package/dist/core/tracked-event.d.ts.map +0 -1
  128. package/dist/core/tracked-event.js.map +0 -1
  129. package/dist/destinations/ad-consent.d.ts.map +0 -1
  130. package/dist/destinations/ad-consent.js.map +0 -1
  131. package/dist/destinations/google-analytics.d.ts.map +0 -1
  132. package/dist/destinations/google-analytics.js.map +0 -1
  133. package/dist/destinations/google-consent.d.ts.map +0 -1
  134. package/dist/destinations/google-consent.js.map +0 -1
  135. package/dist/destinations/meta.d.ts.map +0 -1
  136. package/dist/destinations/meta.js.map +0 -1
  137. package/dist/destinations/microsoft-uet.d.ts.map +0 -1
  138. package/dist/destinations/microsoft-uet.js.map +0 -1
  139. package/dist/destinations/shared.d.ts.map +0 -1
  140. package/dist/destinations/shared.js.map +0 -1
  141. package/dist/destinations/tiktok.d.ts.map +0 -1
  142. package/dist/destinations/tiktok.js.map +0 -1
  143. package/dist/destinations/vercel-analytics.d.ts.map +0 -1
  144. package/dist/destinations/vercel-analytics.js.map +0 -1
  145. package/dist/index.d.ts.map +0 -1
  146. package/dist/index.js.map +0 -1
  147. package/dist/react/consent-banner.d.ts.map +0 -1
  148. package/dist/react/consent-banner.js.map +0 -1
  149. package/dist/react/gtag-consent-bootstrap.d.ts.map +0 -1
  150. package/dist/react/gtag-consent-bootstrap.js.map +0 -1
  151. package/dist/react/use-consent.d.ts.map +0 -1
  152. package/dist/react/use-consent.js.map +0 -1
  153. package/dist/react/use-google-consent-sync.d.ts.map +0 -1
  154. package/dist/react/use-google-consent-sync.js.map +0 -1
  155. package/dist/react/use-initial-consent.d.ts.map +0 -1
  156. package/dist/react/use-initial-consent.js.map +0 -1
  157. package/dist/server/anonymous-id-cookie.d.ts.map +0 -1
  158. package/dist/server/anonymous-id-cookie.js.map +0 -1
  159. package/dist/server/consent-receipt-store.d.ts.map +0 -1
  160. package/dist/server/consent-receipt-store.js.map +0 -1
  161. package/dist/server/consent-receipt.d.ts.map +0 -1
  162. package/dist/server/consent-receipt.js.map +0 -1
  163. package/dist/server/initial-consent.d.ts.map +0 -1
  164. package/dist/server/initial-consent.js.map +0 -1
  165. package/dist/server/measurement-protocol.d.ts.map +0 -1
  166. package/dist/server/measurement-protocol.js.map +0 -1
  167. package/dist/server/region.d.ts.map +0 -1
  168. package/dist/server/region.js.map +0 -1
  169. package/dist/server/user-deletion.d.ts.map +0 -1
  170. package/dist/server/user-deletion.js.map +0 -1
  171. package/dist/tooling/import-protection.d.ts.map +0 -1
  172. package/dist/tooling/import-protection.js.map +0 -1
  173. package/src/adapters/tanstack-start.ts +0 -139
  174. package/src/client/ad-framework-consent.ts +0 -88
  175. package/src/client/browser-cookie.ts +0 -16
  176. package/src/client/consent-runtime.ts +0 -82
  177. package/src/client/consent-storage.ts +0 -125
  178. package/src/client/consent-withdrawal.ts +0 -34
  179. package/src/client/cookie-anonymous-id.ts +0 -116
  180. package/src/client/create-client-tracker.ts +0 -174
  181. package/src/client/gpc.ts +0 -15
  182. package/src/client/initial-consent-store.ts +0 -220
  183. package/src/client/is-analytics-allowed.ts +0 -45
  184. package/src/client/server-persisted-anonymous-id.ts +0 -104
  185. package/src/core/consent-config.ts +0 -27
  186. package/src/core/consent-receipt.ts +0 -115
  187. package/src/core/consent.ts +0 -298
  188. package/src/core/cookie.ts +0 -29
  189. package/src/core/destination.ts +0 -29
  190. package/src/core/event-catalog.ts +0 -54
  191. package/src/core/event-id.ts +0 -8
  192. package/src/core/tracked-event.ts +0 -14
  193. package/src/destinations/ad-consent.ts +0 -29
  194. package/src/destinations/google-analytics.ts +0 -304
  195. package/src/destinations/google-consent.ts +0 -166
  196. package/src/destinations/meta.ts +0 -98
  197. package/src/destinations/microsoft-uet.ts +0 -88
  198. package/src/destinations/shared.ts +0 -51
  199. package/src/destinations/tiktok.ts +0 -87
  200. package/src/destinations/vercel-analytics.ts +0 -41
  201. package/src/index.ts +0 -171
  202. package/src/react/consent-banner.tsx +0 -386
  203. package/src/react/gtag-consent-bootstrap.tsx +0 -50
  204. package/src/react/use-consent.ts +0 -123
  205. package/src/react/use-google-consent-sync.ts +0 -40
  206. package/src/react/use-initial-consent.ts +0 -22
  207. package/src/server/anonymous-id-cookie.ts +0 -105
  208. package/src/server/consent-receipt-store.ts +0 -79
  209. package/src/server/consent-receipt.ts +0 -89
  210. package/src/server/initial-consent.ts +0 -48
  211. package/src/server/measurement-protocol.ts +0 -116
  212. package/src/server/region.ts +0 -77
  213. package/src/server/user-deletion.ts +0 -97
  214. package/src/tooling/import-protection.ts +0 -22
@@ -1,105 +0,0 @@
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 0.5.0-canary.6
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 0.5.0-canary.6
28
- */
29
- export function isValidAnonymousId(value: string): boolean {
30
- return UUID_PATTERN.test(value);
31
- }
32
-
33
- /**
34
- * Options for persisting a client-minted anonymous id via a server `Set-Cookie`.
35
- *
36
- * @since 0.5.0-canary.6
37
- */
38
- export interface AnonymousIdCookieOptions {
39
- /** Cookie name — must match what the client tracker reads. */
40
- cookieName: string;
41
- /** The client-minted id to persist — throws unless it is exactly UUID-shaped. */
42
- id: string;
43
- /** How long the id survives a return visit. Defaults to one year. */
44
- maxAgeSeconds?: number | undefined;
45
- }
46
-
47
- /**
48
- * The validated name/value plus cookie attributes for persisting a client-minted anonymous
49
- * id from the server — feed straight into the framework's cookie helper (`setCookie`).
50
- *
51
- * @remarks
52
- * Always `Secure` — on a plain-HTTP dev origin a browser may drop it, and the
53
- * client-written cookie (`createServerPersistedAnonymousId`'s optimistic write) still
54
- * covers that session. Not `httpOnly`: the client tracker must read the id to stamp it onto
55
- * events. A server-set cookie escapes Safari ITP's 7-day cap on `document.cookie` writes, so
56
- * the id actually lives its full max-age. The server only ever re-sets an id the client
57
- * hands it — minting stays client-side, after consent, by design.
58
- *
59
- * @throws Error when `id` is not UUID-shaped or `cookieName` is not a valid token.
60
- *
61
- * @since 0.5.0-canary.6
62
- */
63
- export function resolveAnonymousIdCookie(options: AnonymousIdCookieOptions): {
64
- maxAge: number;
65
- name: string;
66
- path: string;
67
- sameSite: "lax";
68
- secure: true;
69
- value: string;
70
- } {
71
- assertValidAnonymousIdCookieName(options.cookieName);
72
-
73
- if (!isValidAnonymousId(options.id)) {
74
- throw new Error("Invalid anonymous id: expected a UUID-shaped value");
75
- }
76
-
77
- return {
78
- maxAge: options.maxAgeSeconds ?? ONE_YEAR_IN_SECONDS,
79
- name: options.cookieName,
80
- path: "/",
81
- sameSite: "lax",
82
- secure: true,
83
- value: options.id,
84
- };
85
- }
86
-
87
- /**
88
- * Name plus attributes for expiring the anonymous-id cookie — the server half of a consent
89
- * withdrawal. Attributes must match {@link resolveAnonymousIdCookie} so the browser targets
90
- * the same cookie. Feed into the framework's `deleteCookie`.
91
- *
92
- * @throws Error when `cookieName` is not a valid token.
93
- *
94
- * @since 0.5.0-canary.6
95
- */
96
- export function resolveClearAnonymousIdCookie(cookieName: string): {
97
- name: string;
98
- path: string;
99
- sameSite: "lax";
100
- secure: true;
101
- } {
102
- assertValidAnonymousIdCookieName(cookieName);
103
-
104
- return { name: cookieName, path: "/", sameSite: "lax", secure: true };
105
- }
@@ -1,79 +0,0 @@
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 0.5.0-canary.6
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 0.5.0-canary.6
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 0.5.0-canary.6
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 0.5.0-canary.6
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
- }
@@ -1,89 +0,0 @@
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 0.5.0-canary.6
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 0.5.0-canary.6
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 0.5.0-canary.6
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 0.5.0-canary.6
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
- }
@@ -1,48 +0,0 @@
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
- * Options for `resolveInitialConsent`.
7
- *
8
- * @since 0.5.0-canary.6
9
- */
10
- export interface InitialConsentOptions {
11
- /** ISO 3166-1 alpha-2 from the geo header; missing → the strictest opt-in default. */
12
- countryCode: string | undefined;
13
- /** Honored as an ads-only opt-out on the default decision. */
14
- hasGlobalPrivacyControlSignal?: boolean | undefined;
15
- /** Categories the app's prompt asks about — opt-out regions grant exactly these by default. */
16
- requestedCategories: ReadonlyArray<ConsentCategory>;
17
- }
18
-
19
- /**
20
- * Pure region → mode → default-consent resolution for server functions (or a fail-closed
21
- * bake when country is unknown). Named with the `resolve*` family it composes.
22
- *
23
- * @remarks
24
- * A missing country code means an unknown visitor (a prerender crawl, a host without a
25
- * geo header) — not a known non-EU visitor — so it fails closed to
26
- * {@link STRICTEST_INITIAL_CONSENT} instead of `"other"`'s opt-out. Conflating the two
27
- * would grant analytics by default to every visitor, EU included, on a geo-less host.
28
- *
29
- * @since 0.5.0-canary.6
30
- */
31
- export function resolveInitialConsent(options: InitialConsentOptions): InitialConsent {
32
- if (!options.countryCode) {
33
- return STRICTEST_INITIAL_CONSENT;
34
- }
35
-
36
- const region = resolveRegionFromCountryCode(options.countryCode);
37
- const mode = resolveConsentMode(region);
38
-
39
- return {
40
- defaultConsent: resolveDefaultConsent({
41
- hasGlobalPrivacyControlSignal: options.hasGlobalPrivacyControlSignal ?? false,
42
- mode,
43
- requestedCategories: options.requestedCategories,
44
- }),
45
- mode,
46
- region,
47
- };
48
- }
@@ -1,116 +0,0 @@
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 0.5.0-canary.6
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 0.5.0-canary.6
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 0.5.0-canary.6
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 0.5.0-canary.6
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 0.5.0-canary.6
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
- * Options for `sendMeasurementProtocolEvents`.
82
- *
83
- * @since 0.5.0-canary.6
84
- */
85
- export interface SendMeasurementProtocolEventsOptions {
86
- /** GA4 **API Secret** — read server-side from config, never a client-exposed var. */
87
- apiSecret: string;
88
- /** The visitor's GA4 client id (see {@link extractGaClientId}). */
89
- clientId: string;
90
- consent?: MeasurementProtocolConsent | undefined;
91
- endpointOrigin?: string | undefined;
92
- events: ReadonlyArray<MeasurementProtocolEvent>;
93
- measurementId: string;
94
- transport?: MeasurementProtocolTransport | undefined;
95
- }
96
-
97
- /**
98
- * POSTs one or more events to the GA4 Measurement Protocol for a known `client_id` — the
99
- * server-side counterpart to gtag.js. The caller owns credentials (never bake them) and the
100
- * consent gate: send only for a server-owned event the visitor's consent permits.
101
- *
102
- * @see https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events
103
- *
104
- * @since 0.5.0-canary.6
105
- */
106
- export async function sendMeasurementProtocolEvents(options: SendMeasurementProtocolEventsOptions): Promise<void> {
107
- const origin = options.endpointOrigin ?? DEFAULT_ENDPOINT_ORIGIN;
108
- const url = `${origin}/mp/collect?measurement_id=${encodeURIComponent(options.measurementId)}&api_secret=${encodeURIComponent(options.apiSecret)}`;
109
- const body = JSON.stringify({
110
- client_id: options.clientId,
111
- events: options.events,
112
- ...(options.consent ? { consent: options.consent } : {}),
113
- });
114
-
115
- await (options.transport ?? defaultTransport)({ body, url });
116
- }
@@ -1,77 +0,0 @@
1
- import type { ConsentRegion } from "#/core/consent";
2
-
3
- /**
4
- * EU member states — GDPR opt-in via `resolveConsentMode("eu")`.
5
- *
6
- * @since 0.5.0-canary.6
7
- */
8
- export const EU_COUNTRY_CODES: ReadonlySet<string> = new Set([
9
- "AT",
10
- "BE",
11
- "BG",
12
- "HR",
13
- "CY",
14
- "CZ",
15
- "DK",
16
- "EE",
17
- "FI",
18
- "FR",
19
- "DE",
20
- "GR",
21
- "HU",
22
- "IE",
23
- "IT",
24
- "LV",
25
- "LT",
26
- "LU",
27
- "MT",
28
- "NL",
29
- "PL",
30
- "PT",
31
- "RO",
32
- "SK",
33
- "SI",
34
- "ES",
35
- "SE",
36
- ]);
37
-
38
- /**
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 0.5.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.
54
- *
55
- * @since 0.5.0-canary.4
56
- */
57
- export function resolveRegionFromCountryCode(countryCode: string | undefined): ConsentRegion {
58
- if (!countryCode) {
59
- return "other";
60
- }
61
-
62
- const normalized = countryCode.toUpperCase();
63
-
64
- if (EU_COUNTRY_CODES.has(normalized) || OPT_IN_EQUIVALENT_COUNTRY_CODES.has(normalized)) {
65
- return "eu";
66
- }
67
-
68
- if (normalized === "VN") {
69
- return "vn";
70
- }
71
-
72
- if (normalized === "US") {
73
- return "us";
74
- }
75
-
76
- return "other";
77
- }
@@ -1,97 +0,0 @@
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
- * The URL and body of an Admin API `submitUserDeletion` call, ready for an authenticated transport.
16
- *
17
- * @since 0.5.0-canary.6
18
- */
19
- export interface Ga4UserDeletionRequest {
20
- body: { clientId: string };
21
- url: string;
22
- }
23
-
24
- /**
25
- * Builds the Admin API `submitUserDeletion` request that erases one GA4 subject by
26
- * `clientId` (the `_ga`-cookie id — see `extractGaClientId`). Pure and network-free so the
27
- * request shape can be snapshotted/verified; pair it with {@link submitGa4UserDeletion} or
28
- * any authenticated transport.
29
- *
30
- * @param options - `propertyId` is the numeric GA4 property (no `properties/` prefix).
31
- *
32
- * @since 0.5.0-canary.6
33
- */
34
- export function buildGa4UserDeletionRequest(options: { clientId: string; propertyId: string }): Ga4UserDeletionRequest {
35
- return {
36
- body: { clientId: options.clientId },
37
- url: `${ADMIN_API_ORIGIN}/v1alpha/properties/${options.propertyId}:submitUserDeletion`,
38
- };
39
- }
40
-
41
- /**
42
- * The one network primitive the sender needs — injected so the package ships no HTTP client.
43
- *
44
- * @since 0.5.0-canary.6
45
- */
46
- export type Ga4UserDeletionTransport = (request: {
47
- body: string;
48
- headers: Record<string, string>;
49
- url: string;
50
- }) => Promise<void>;
51
-
52
- async function defaultTransport(request: {
53
- body: string;
54
- headers: Record<string, string>;
55
- url: string;
56
- }): Promise<void> {
57
- const response = await fetch(request.url, { body: request.body, headers: request.headers, method: "POST" });
58
-
59
- if (!response.ok) {
60
- throw new Error(`GA4 user deletion responded ${String(response.status)}`);
61
- }
62
- }
63
-
64
- /**
65
- * Options for `submitGa4UserDeletion`.
66
- *
67
- * @since 0.5.0-canary.6
68
- */
69
- export interface SubmitGa4UserDeletionOptions {
70
- /** A bearer token for the `https://www.googleapis.com/auth/analytics.edit` scope — the caller owns OAuth. */
71
- accessToken: string;
72
- clientId: string;
73
- propertyId: string;
74
- transport?: Ga4UserDeletionTransport | undefined;
75
- }
76
-
77
- /**
78
- * Submits a GA4 user-deletion request for one `clientId`. Authorization is the caller's:
79
- * pass a bearer token minted from a service account (never baked into the package). The
80
- * deletion removes the subject from the Individual User report within ~72h and purges at the
81
- * next run; it does **not** reach previously-aggregated reports or BigQuery exports
82
- * (spec-data-subject-rights §3).
83
- *
84
- * @since 0.5.0-canary.6
85
- */
86
- export async function submitGa4UserDeletion(options: SubmitGa4UserDeletionOptions): Promise<void> {
87
- const request = buildGa4UserDeletionRequest({ clientId: options.clientId, propertyId: options.propertyId });
88
-
89
- await (options.transport ?? defaultTransport)({
90
- body: JSON.stringify(request.body),
91
- headers: {
92
- authorization: `Bearer ${options.accessToken}`,
93
- "content-type": "application/json",
94
- },
95
- url: request.url,
96
- });
97
- }
@@ -1,22 +0,0 @@
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 0.5.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
- ];