@c15t/react 3.0.0-alpha.0 → 3.0.0-alpha.10

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 (405) hide show
  1. package/AGENTS.md +96 -69
  2. package/README.md +21 -17
  3. package/SKILL.md +34 -0
  4. package/dist/aggregate-components.js +1 -1
  5. package/dist/chunk-warming.js +1 -1
  6. package/dist/component-hooks/use-headless-consent-ui.js +1 -1
  7. package/dist/component-hooks/use-headless-iab-consent-ui.js +1 -1
  8. package/dist/component-hooks/use-panel-trigger.js +1 -1
  9. package/dist/components/consent-gate/atoms.js +1 -0
  10. package/dist/components/consent-gate/consent-gate.js +2 -0
  11. package/dist/components/consent-gate/frame.js +2 -0
  12. package/dist/components/consent-gate/index.js +2 -0
  13. package/dist/components/consent-preferences-link/consent-preferences-link.js +1 -1
  14. package/dist/components/iab-panel/atoms/card.js +1 -1
  15. package/dist/components/iab-panel/atoms/feature-item.js +2 -0
  16. package/dist/components/iab-panel/atoms/header.js +1 -1
  17. package/dist/components/iab-panel/atoms/purpose-item.js +1 -1
  18. package/dist/components/iab-panel/atoms/root.js +1 -1
  19. package/dist/components/iab-panel/atoms/stack-item.js +1 -1
  20. package/dist/components/iab-panel/atoms/vendor-list.js +1 -1
  21. package/dist/components/iab-panel/hooks/use-gvl-data.js +1 -1
  22. package/dist/components/iab-panel/iab-panel.js +1 -1
  23. package/dist/components/iab-panel/index.js +1 -1
  24. package/dist/components/iab-prompt/atoms/overlay.js +1 -1
  25. package/dist/components/iab-prompt/atoms/root.js +1 -1
  26. package/dist/components/panel/atoms/card.js +1 -1
  27. package/dist/components/panel/atoms/overlay.js +1 -1
  28. package/dist/components/panel/atoms/root.js +1 -1
  29. package/dist/components/panel/panel.js +1 -1
  30. package/dist/components/panel-trigger/atoms/button.js +1 -1
  31. package/dist/components/panel-trigger/atoms/icon.js +1 -1
  32. package/dist/components/panel-trigger/atoms/root.js +1 -1
  33. package/dist/components/panel-trigger/atoms/toolbar.js +1 -1
  34. package/dist/components/panel-trigger/atoms/trigger-icons.js +1 -0
  35. package/dist/components/panel-trigger/panel-trigger-toolbar.js +1 -1
  36. package/dist/components/panel-trigger/panel-trigger.js +1 -1
  37. package/dist/components/preferences/atoms/accordion.js +1 -1
  38. package/dist/components/preferences/atoms/root.js +1 -1
  39. package/dist/components/preferences/atoms/vendor-list.js +1 -0
  40. package/dist/components/preferences/index.js +1 -1
  41. package/dist/components/prompt/atoms/early-tap-script.js +2 -0
  42. package/dist/components/prompt/atoms/overlay.js +1 -1
  43. package/dist/components/prompt/atoms/root.js +1 -1
  44. package/dist/components/prompt/components.js +1 -1
  45. package/dist/components/prompt/policy-actions.js +1 -1
  46. package/dist/components/prompt/prompt.js +1 -1
  47. package/dist/components/shared/dialog-sheets.js +1 -0
  48. package/dist/components/shared/first-paint-sheets.js +1 -0
  49. package/dist/components/shared/iab-dialog-sheets.js +1 -0
  50. package/dist/components/shared/iab-first-paint-sheets.js +1 -0
  51. package/dist/components/shared/libs/compose-refs.js +1 -0
  52. package/dist/components/shared/libs/slot.js +1 -1
  53. package/dist/components/shared/primitives/button.js +1 -1
  54. package/dist/components/shared/primitives/legal-links/index.js +1 -1
  55. package/dist/components/shared/streamed-surface.js +2 -0
  56. package/dist/components/shared/surface-styles.js +2 -0
  57. package/dist/components/shared/ui/dialog/dialog.js +1 -1
  58. package/dist/components/shared/ui/icon.js +1 -1
  59. package/dist/components/shared/ui/logo.js +1 -1
  60. package/dist/components/shared/ui/preference-item/preference-item.js +1 -1
  61. package/dist/consent-gate.js +2 -0
  62. package/dist/consent-theme.js +1 -0
  63. package/dist/context/consent-tracking-context.js +1 -1
  64. package/dist/context/index.js +1 -1
  65. package/dist/context.js +1 -1
  66. package/dist/devtools-launcher.js +2 -0
  67. package/dist/devtools.js +1 -1
  68. package/dist/draft-context.js +2 -0
  69. package/dist/draft.js +1 -1
  70. package/dist/external-iab-context.js +1 -1
  71. package/dist/gpp.js +2 -0
  72. package/dist/headless.js +1 -1
  73. package/dist/hooks/use-color-scheme.js +1 -1
  74. package/dist/hooks/use-committed-ref.js +2 -0
  75. package/dist/hooks/use-focus-trap.js +1 -1
  76. package/dist/hooks/use-headless-iab-consent-ui.js +1 -1
  77. package/dist/hooks/use-iab-policy-guard.js +1 -0
  78. package/dist/hooks/use-late-entry.js +2 -0
  79. package/dist/hooks.js +1 -1
  80. package/dist/iab/styles.tw3.css +5 -151
  81. package/dist/iab-context.js +1 -1
  82. package/dist/index-parts/consent-banner.js +1 -0
  83. package/dist/index-parts/consent-dialog-link.js +1 -0
  84. package/dist/index-parts/consent-dialog-trigger.js +1 -0
  85. package/dist/index-parts/consent-dialog.js +1 -0
  86. package/dist/index-parts/consent-gate.js +1 -0
  87. package/dist/index-parts/core.js +1 -0
  88. package/dist/index-parts/draft.js +1 -0
  89. package/dist/index-parts/frame.js +1 -0
  90. package/dist/index-parts/hooks.js +1 -0
  91. package/dist/index-parts/hosted.js +1 -0
  92. package/dist/index-parts/module-hooks.js +1 -0
  93. package/dist/index-parts/offline.js +1 -0
  94. package/dist/index-parts/presets.js +1 -0
  95. package/dist/index-parts/provider.js +1 -0
  96. package/dist/index-parts/theme.js +1 -0
  97. package/dist/index-parts/translations.js +1 -0
  98. package/dist/index.js +1 -1
  99. package/dist/kernel-selector.js +1 -0
  100. package/dist/modes.js +1 -0
  101. package/dist/module-hooks/iframe-blocker.js +1 -1
  102. package/dist/module-hooks/network-blocker.js +1 -1
  103. package/dist/module-hooks/network-hold.js +2 -0
  104. package/dist/module-hooks/persistence.js +1 -1
  105. package/dist/panel-link.js +1 -1
  106. package/dist/panel-trigger.js +1 -1
  107. package/dist/panel.js +1 -1
  108. package/dist/postcss-tailwind3.js +1 -0
  109. package/dist/preferences.js +1 -2
  110. package/dist/provider.js +1 -1
  111. package/dist/server/fetch-ssr-data.js +1 -1
  112. package/dist/server/headers.js +1 -1
  113. package/dist/server/normalize-url.js +1 -1
  114. package/dist/styles.tw3.css +35 -159
  115. package/dist/transports/hosted.js +1 -0
  116. package/dist/transports/manifest.js +1 -0
  117. package/dist/transports/offline.js +1 -1
  118. package/dist/utils/deferred-module.js +2 -0
  119. package/dist/utils/merge-slot-props.js +1 -1
  120. package/dist/utils/theme-utils.js +1 -1
  121. package/dist/version.js +1 -1
  122. package/dist-types/aggregate-components.d.ts +2 -2
  123. package/dist-types/chunk-warming.d.ts +45 -8
  124. package/dist-types/component-hooks/use-headless-consent-ui.d.ts +5 -5
  125. package/dist-types/component-hooks/use-headless-iab-consent-ui.d.ts +2 -2
  126. package/dist-types/components/consent-gate/atoms.d.ts +11 -0
  127. package/dist-types/components/consent-gate/consent-gate.d.ts +2 -0
  128. package/dist-types/components/consent-gate/frame.d.ts +19 -0
  129. package/dist-types/components/consent-gate/index.d.ts +25 -0
  130. package/dist-types/components/{frame → consent-gate}/types.d.ts +7 -7
  131. package/dist-types/components/consent-preferences-link/consent-preferences-link.d.ts +1 -1
  132. package/dist-types/components/consent-preferences-link/index.d.ts +1 -1
  133. package/dist-types/components/iab-panel/atoms/feature-item.d.ts +28 -0
  134. package/dist-types/components/iab-panel/atoms/purpose-item.d.ts +5 -2
  135. package/dist-types/components/iab-panel/atoms/stack-item.d.ts +7 -2
  136. package/dist-types/components/iab-panel/atoms/vendor-list.d.ts +1 -1
  137. package/dist-types/components/iab-panel/iab-panel.d.ts +3 -3
  138. package/dist-types/components/iab-panel/index.d.ts +29 -26
  139. package/dist-types/components/iab-panel/use-iab-translations.d.ts +4 -0
  140. package/dist-types/components/iab-prompt/iab-prompt.d.ts +3 -3
  141. package/dist-types/components/iab-prompt/index.d.ts +19 -19
  142. package/dist-types/components/panel/atoms/card.d.ts +5 -4
  143. package/dist-types/components/panel/atoms/overlay.d.ts +1 -1
  144. package/dist-types/components/panel/index.d.ts +8 -8
  145. package/dist-types/components/panel/panel.d.ts +3 -3
  146. package/dist-types/components/panel-link/index.d.ts +1 -1
  147. package/dist-types/components/panel-trigger/atoms/button.d.ts +1 -1
  148. package/dist-types/components/panel-trigger/atoms/icon.d.ts +1 -1
  149. package/dist-types/components/panel-trigger/atoms/root.d.ts +2 -2
  150. package/dist-types/components/panel-trigger/atoms/toolbar.d.ts +2 -2
  151. package/dist-types/components/panel-trigger/atoms/trigger-icons.d.ts +25 -0
  152. package/dist-types/components/panel-trigger/index.d.ts +4 -4
  153. package/dist-types/components/panel-trigger/panel-trigger-toolbar.d.ts +1 -1
  154. package/dist-types/components/panel-trigger/panel-trigger.d.ts +9 -17
  155. package/dist-types/components/panel-trigger/types.d.ts +1 -1
  156. package/dist-types/components/preferences/atoms/accordion.d.ts +6 -4
  157. package/dist-types/components/preferences/atoms/button.d.ts +1 -1
  158. package/dist-types/components/preferences/atoms/footer.d.ts +1 -1
  159. package/dist-types/components/preferences/atoms/root.d.ts +1 -1
  160. package/dist-types/components/preferences/atoms/vendor-list.d.ts +23 -0
  161. package/dist-types/components/preferences/index.d.ts +14 -12
  162. package/dist-types/components/preferences/policy-actions.d.ts +2 -2
  163. package/dist-types/components/preferences/preferences.d.ts +1 -1
  164. package/dist-types/components/preferences/types.d.ts +1 -1
  165. package/dist-types/components/prompt/atoms/early-tap-script.d.ts +17 -0
  166. package/dist-types/components/prompt/atoms/root.d.ts +4 -0
  167. package/dist-types/components/prompt/components.d.ts +9 -3
  168. package/dist-types/components/prompt/index.d.ts +12 -12
  169. package/dist-types/components/prompt/policy-actions.d.ts +2 -2
  170. package/dist-types/components/prompt/prompt.d.ts +5 -1
  171. package/dist-types/components/shared/dialog-sheets.d.ts +9 -0
  172. package/dist-types/components/shared/first-paint-sheets.d.ts +8 -0
  173. package/dist-types/components/shared/iab-dialog-sheets.d.ts +3 -0
  174. package/dist-types/components/shared/iab-first-paint-sheets.d.ts +3 -0
  175. package/dist-types/components/shared/libs/compose-refs.d.ts +20 -0
  176. package/dist-types/components/shared/policy-actions.d.ts +2 -2
  177. package/dist-types/components/shared/primitives/box.d.ts +1 -1
  178. package/dist-types/components/shared/primitives/button.d.ts +2 -2
  179. package/dist-types/components/shared/primitives/button.types.d.ts +1 -1
  180. package/dist-types/components/shared/streamed-surface.d.ts +23 -0
  181. package/dist-types/components/shared/surface-styles.d.ts +36 -0
  182. package/dist-types/components/shared/ui/accordion/accordion.d.ts +2 -2
  183. package/dist-types/components/shared/ui/accordion/index.d.ts +2 -2
  184. package/dist-types/components/shared/ui/animated-collapse/index.d.ts +2 -2
  185. package/dist-types/components/shared/ui/branding.d.ts +1 -1
  186. package/dist-types/components/shared/ui/button/button.d.ts +1 -1
  187. package/dist-types/components/shared/ui/button/index.d.ts +2 -2
  188. package/dist-types/components/shared/ui/collapsible/index.d.ts +1 -1
  189. package/dist-types/components/shared/ui/dialog/index.d.ts +1 -1
  190. package/dist-types/components/shared/ui/icon.d.ts +2 -1
  191. package/dist-types/components/shared/ui/logo.d.ts +0 -10
  192. package/dist-types/components/shared/ui/preference-item/index.d.ts +1 -1
  193. package/dist-types/components/shared/ui/preference-item/preference-item.d.ts +13 -0
  194. package/dist-types/components/shared/ui/switch/index.d.ts +2 -2
  195. package/dist-types/components/shared/ui/switch/switch.d.ts +1 -1
  196. package/dist-types/components/shared/ui/tabs/index.d.ts +1 -1
  197. package/dist-types/consent-gate.d.ts +1 -0
  198. package/dist-types/consent-theme.d.ts +38 -0
  199. package/dist-types/context/consent-tracking-context.d.ts +10 -0
  200. package/dist-types/context/index.d.ts +3 -3
  201. package/dist-types/context/theme-context.d.ts +3 -3
  202. package/dist-types/context.d.ts +25 -1
  203. package/dist-types/devtools-launcher.d.ts +29 -0
  204. package/dist-types/devtools.d.ts +13 -2
  205. package/dist-types/draft-context.d.ts +31 -0
  206. package/dist-types/draft.d.ts +81 -9
  207. package/dist-types/gpp.d.ts +27 -0
  208. package/dist-types/headless.d.ts +6 -7
  209. package/dist-types/hooks/use-committed-ref.d.ts +24 -0
  210. package/dist-types/hooks/use-focus-trap.d.ts +3 -1
  211. package/dist-types/hooks/use-headless-iab-consent-ui.d.ts +1 -1
  212. package/dist-types/hooks/use-iab-manager.d.ts +5 -5
  213. package/dist-types/hooks/use-iab-policy-guard.d.ts +35 -0
  214. package/dist-types/hooks/use-late-entry.d.ts +14 -0
  215. package/dist-types/hooks/use-theme.d.ts +1 -1
  216. package/dist-types/hooks.d.ts +106 -11
  217. package/dist-types/iab.d.ts +7 -7
  218. package/dist-types/index-parts/consent-banner.d.ts +7 -0
  219. package/dist-types/index-parts/consent-dialog-link.d.ts +7 -0
  220. package/dist-types/index-parts/consent-dialog-trigger.d.ts +7 -0
  221. package/dist-types/index-parts/consent-dialog.d.ts +7 -0
  222. package/dist-types/index-parts/consent-gate.d.ts +7 -0
  223. package/dist-types/index-parts/core.d.ts +7 -0
  224. package/dist-types/index-parts/draft.d.ts +7 -0
  225. package/dist-types/index-parts/frame.d.ts +7 -0
  226. package/dist-types/index-parts/hooks.d.ts +7 -0
  227. package/dist-types/index-parts/hosted.d.ts +7 -0
  228. package/dist-types/index-parts/module-hooks.d.ts +7 -0
  229. package/dist-types/index-parts/offline.d.ts +7 -0
  230. package/dist-types/index-parts/presets.d.ts +7 -0
  231. package/dist-types/index-parts/provider.d.ts +7 -0
  232. package/dist-types/index-parts/theme.d.ts +8 -0
  233. package/dist-types/index-parts/translations.d.ts +7 -0
  234. package/dist-types/index.d.ts +32 -28
  235. package/dist-types/kernel-selector.d.ts +68 -0
  236. package/dist-types/modes.d.ts +26 -0
  237. package/dist-types/module-hooks/iframe-blocker.d.ts +33 -1
  238. package/dist-types/module-hooks/network-blocker.d.ts +23 -0
  239. package/dist-types/module-hooks/network-hold.d.ts +47 -0
  240. package/dist-types/module-hooks.d.ts +4 -4
  241. package/dist-types/panel-link.d.ts +1 -1
  242. package/dist-types/panel-trigger.d.ts +1 -1
  243. package/dist-types/panel.d.ts +13 -1
  244. package/dist-types/postcss-tailwind3.d.ts +21 -0
  245. package/dist-types/preferences.d.ts +12 -1
  246. package/dist-types/primitives/accordion.d.ts +1 -1
  247. package/dist-types/primitives/button.d.ts +1 -1
  248. package/dist-types/primitives/collapsible.d.ts +1 -1
  249. package/dist-types/primitives/dialog.d.ts +1 -1
  250. package/dist-types/primitives/preference-item.d.ts +1 -1
  251. package/dist-types/primitives/switch.d.ts +1 -1
  252. package/dist-types/primitives/tabs.d.ts +1 -1
  253. package/dist-types/primitives.d.ts +7 -7
  254. package/dist-types/prompt.d.ts +1 -1
  255. package/dist-types/provider.d.ts +174 -28
  256. package/dist-types/server/fetch-ssr-data.d.ts +1 -1
  257. package/dist-types/server/headers.d.ts +14 -4
  258. package/dist-types/server/index.d.ts +5 -5
  259. package/dist-types/server/normalize-url.d.ts +14 -7
  260. package/dist-types/server/types.d.ts +12 -1
  261. package/dist-types/theme-provider.d.ts +2 -2
  262. package/dist-types/transports/hosted.d.ts +36 -0
  263. package/dist-types/transports/manifest.d.ts +48 -0
  264. package/dist-types/transports/offline.d.ts +7 -16
  265. package/dist-types/types/index.d.ts +3 -3
  266. package/dist-types/types/manager.d.ts +1 -1
  267. package/dist-types/types/theme/index.d.ts +1 -1
  268. package/dist-types/ui-config-context.d.ts +14 -2
  269. package/dist-types/utils/deferred-module.d.ts +13 -0
  270. package/dist-types/utils/index.d.ts +4 -4
  271. package/dist-types/utils/merge-slot-props.d.ts +17 -3
  272. package/dist-types/utils/merge-styles.d.ts +1 -1
  273. package/dist-types/utils/theme-utils.d.ts +18 -3
  274. package/dist-types/version.d.ts +1 -1
  275. package/docs/README.md +96 -69
  276. package/docs/assets/v3/bottom-bar.png +0 -0
  277. package/docs/assets/v3/brand-card.png +0 -0
  278. package/docs/assets/v3/brand-preferences.png +0 -0
  279. package/docs/assets/v3/choice-wall.png +0 -0
  280. package/docs/assets/v3/headless-bar-html.png +0 -0
  281. package/docs/assets/v3/headless-bar-mobile.png +0 -0
  282. package/docs/assets/v3/headless-bar.png +0 -0
  283. package/docs/assets/v3/slim-bar.png +0 -0
  284. package/docs/concepts/choose-your-setup.md +138 -0
  285. package/docs/concepts/consent-categories.md +84 -0
  286. package/docs/concepts/consent-state.md +421 -0
  287. package/docs/concepts/data-fetching.md +270 -0
  288. package/docs/concepts/how-consent-works.md +123 -0
  289. package/docs/concepts/modes.md +278 -0
  290. package/docs/{frameworks/react/concepts/policy-presets.md → concepts/policies.md} +8 -60
  291. package/docs/customization/class-names.md +202 -0
  292. package/docs/customization/dark-mode.md +157 -0
  293. package/docs/customization/motion.md +128 -0
  294. package/docs/customization/overview.md +68 -33
  295. package/docs/customization/recipes.md +838 -47
  296. package/docs/customization/slots.md +217 -35
  297. package/docs/customization/stylesheets.md +248 -0
  298. package/docs/customization/tailwind.md +863 -0
  299. package/docs/customization/tokens.md +167 -36
  300. package/docs/customization/translations.md +87 -3
  301. package/docs/frameworks/react/callbacks.md +118 -0
  302. package/docs/frameworks/react/clear-on-revocation.md +106 -0
  303. package/docs/frameworks/react/components/consent-banner.md +48 -27
  304. package/docs/frameworks/react/components/consent-dialog-link.md +13 -11
  305. package/docs/frameworks/react/components/consent-dialog-trigger.md +86 -76
  306. package/docs/frameworks/react/components/consent-dialog.md +111 -58
  307. package/docs/frameworks/react/components/{frame.md → consent-gate.md} +70 -49
  308. package/docs/frameworks/react/components/consent-provider.md +140 -0
  309. package/docs/frameworks/react/components/consent-widget.md +69 -24
  310. package/docs/frameworks/react/components/dev-tools.md +76 -85
  311. package/docs/frameworks/react/components.md +113 -0
  312. package/docs/frameworks/react/compose.md +354 -0
  313. package/docs/frameworks/react/content-security-policy.md +143 -0
  314. package/docs/frameworks/react/customize.md +258 -0
  315. package/docs/frameworks/react/embeds.md +89 -0
  316. package/docs/frameworks/react/gpp.md +163 -0
  317. package/docs/frameworks/react/headless.md +4 -4
  318. package/docs/frameworks/react/hooks.md +70 -0
  319. package/docs/frameworks/react/iab.md +259 -0
  320. package/docs/frameworks/react/network-blocker.md +140 -0
  321. package/docs/frameworks/react/quickstart.md +220 -102
  322. package/docs/frameworks/react/rendering.md +263 -0
  323. package/docs/frameworks/react/scripts.md +114 -0
  324. package/docs/frameworks/react/translations.md +155 -0
  325. package/docs/frameworks/react/troubleshooting.md +188 -61
  326. package/docs/frameworks/react/upgrade-v3.md +651 -0
  327. package/docs/frameworks/react/vendor-consent.md +188 -0
  328. package/docs/guides/banner-experiments.md +672 -0
  329. package/docs/guides/troubleshooting.md +192 -54
  330. package/docs/guides/verify-consent.md +96 -49
  331. package/docs/integrations/adobe-analytics.md +177 -183
  332. package/docs/integrations/ahrefs-analytics.md +162 -178
  333. package/docs/integrations/amplitude.md +172 -180
  334. package/docs/integrations/building-integrations.md +137 -33
  335. package/docs/integrations/clearbit.md +164 -178
  336. package/docs/integrations/cloudflare-web-analytics.md +166 -180
  337. package/docs/integrations/cloudflare-zaraz.md +333 -0
  338. package/docs/integrations/crisp.md +174 -182
  339. package/docs/integrations/databuddy.md +167 -197
  340. package/docs/integrations/fathom-analytics.md +168 -180
  341. package/docs/integrations/front-chat.md +308 -0
  342. package/docs/integrations/google-maps.md +142 -108
  343. package/docs/integrations/google-tag-manager.md +258 -185
  344. package/docs/integrations/google-tag.md +226 -182
  345. package/docs/integrations/heap.md +173 -179
  346. package/docs/integrations/hightouch.md +171 -181
  347. package/docs/integrations/hotjar.md +169 -179
  348. package/docs/integrations/intercom.md +193 -177
  349. package/docs/integrations/klaviyo.md +473 -0
  350. package/docs/integrations/linkedin-insights.md +184 -174
  351. package/docs/integrations/logrocket.md +170 -180
  352. package/docs/integrations/matomo-analytics.md +198 -202
  353. package/docs/integrations/meta-pixel.md +198 -174
  354. package/docs/integrations/microsoft-clarity.md +173 -179
  355. package/docs/integrations/microsoft-uet.md +158 -178
  356. package/docs/integrations/mixpanel-analytics.md +165 -184
  357. package/docs/integrations/one-dollar-stats.md +292 -0
  358. package/docs/integrations/openai-pixel.md +214 -325
  359. package/docs/integrations/overview.md +152 -83
  360. package/docs/integrations/pinterest-tag.md +315 -0
  361. package/docs/integrations/pirsch.md +179 -183
  362. package/docs/integrations/plausible-analytics.md +182 -182
  363. package/docs/integrations/posthog.md +323 -264
  364. package/docs/integrations/promptwatch.md +164 -178
  365. package/docs/integrations/reddit-pixel.md +195 -181
  366. package/docs/integrations/rudderstack.md +211 -210
  367. package/docs/integrations/rybbit-analytics.md +181 -184
  368. package/docs/integrations/segment.md +192 -178
  369. package/docs/integrations/sentry.md +402 -0
  370. package/docs/integrations/snapchat-pixel.md +196 -180
  371. package/docs/integrations/tiktok-pixel.md +181 -174
  372. package/docs/integrations/umami-analytics.md +173 -182
  373. package/docs/integrations/vercel-analytics.md +176 -181
  374. package/docs/integrations/x-pixel.md +186 -174
  375. package/docs/integrations/youtube.md +150 -111
  376. package/package.json +48 -17
  377. package/dist/component-hooks/use-manager.js +0 -2
  378. package/dist/components/frame/atoms.js +0 -1
  379. package/dist/components/frame/frame.js +0 -2
  380. package/dist/components/frame/index.js +0 -2
  381. package/dist/frame.js +0 -2
  382. package/dist/ui-save.js +0 -1
  383. package/dist-types/component-hooks/use-manager.d.ts +0 -40
  384. package/dist-types/components/frame/atoms.d.ts +0 -11
  385. package/dist-types/components/frame/frame.d.ts +0 -2
  386. package/dist-types/components/frame/index.d.ts +0 -24
  387. package/dist-types/frame.d.ts +0 -1
  388. package/dist-types/ui-save.d.ts +0 -5
  389. package/docs/assets/v3/brand-bar.png +0 -0
  390. package/docs/assets/v3/mobile-card.png +0 -0
  391. package/docs/assets/v3/preferences.png +0 -0
  392. package/docs/frameworks/react/components/consent-manager-provider.md +0 -62
  393. package/docs/frameworks/react/concepts/consent-categories.md +0 -33
  394. package/docs/frameworks/react/hooks/use-consent-manager/overview.md +0 -58
  395. package/docs/frameworks/react/iab/overview.md +0 -53
  396. package/docs/frameworks/react/script-loader.md +0 -55
  397. package/docs/frameworks/react/styling/overview.md +0 -207
  398. package/docs/guides/consent-state.md +0 -60
  399. package/docs/guides/data-fetching.md +0 -163
  400. package/docs/guides/deployment-modes.md +0 -63
  401. package/docs/upgrade-v3.md +0 -334
  402. package/readme.json +0 -48
  403. package/src/iab/styles.css +0 -11
  404. package/src/styles.css +0 -10
  405. /package/dist/components/{frame → consent-gate}/types.js +0 -0
@@ -1,212 +1,153 @@
1
1
  ---
2
2
  title: OpenAI Pixel
3
- description: Configure the OpenAI Measurement Pixel for ChatGPT Ads with c15t
4
- v3, manage marketing permission and verify conversion delivery.
3
+ description: Load the ChatGPT Ads Measurement Pixel only after marketing consent
4
+ with the c15t openaiPixel helper, guard oaiq conversion calls, and check it in
5
+ DevTools.
6
+ icon: chatgpt
5
7
  group: integrations
6
8
  ---
7
9
 
8
- ## Configure OpenAI Pixel
10
+ ## Configure the OpenAI Pixel
9
11
 
10
- Copy your Pixel ID from the conversions tab in OpenAI Ads Manager. The helper
11
- initializes `oaiq` and loads the SDK when marketing permission allows it.
12
+ Copy the pixel ID from the conversions tab in OpenAI Ads Manager. Remove the
13
+ standalone OpenAI installation snippet, because the helper creates the `oaiq`
14
+ queue and initializes the pixel itself.
12
15
 
13
- | Package manager | Command |
14
- | :-------------- | :-------------------------- |
15
- | npm | `npm install @c15t/scripts` |
16
- | pnpm | `pnpm add @c15t/scripts` |
17
- | yarn | `yarn add @c15t/scripts` |
18
- | bun | `bun add @c15t/scripts` |
16
+ | Package manager | Command |
17
+ | :-------------- | :------------------------------------- |
18
+ | npm | `npm install @c15t/integrations@alpha` |
19
+ | pnpm | `pnpm add @c15t/integrations@alpha` |
20
+ | yarn | `yarn add @c15t/integrations@alpha` |
21
+ | bun | `bun add @c15t/integrations@alpha` |
19
22
 
20
23
  ```ts title="src/consent-scripts.ts"
21
- import { openaiPixel } from '@c15t/scripts/openai-pixel';
24
+ import { openaiPixel } from '@c15t/integrations/openai-pixel';
22
25
 
23
26
  export const scripts = [openaiPixel({ pixelId: 'YOUR_PIXEL_ID' })];
24
27
  ```
25
28
 
26
- Remove the standalone OpenAI installation snippet when using this integration.
27
- c15t creates the `oaiq` queue, initializes the pixel, and loads the SDK.
28
-
29
29
  ## Register the scripts
30
30
 
31
- Complete your [framework quickstart](https://c15t.com/docs/frameworks) first. Keep its Inth
31
+ Complete your [framework quickstart](https://v3.c15t.com/docs/frameworks) first. Keep its Inth
32
32
  endpoint, policy, styles and consent UI. Remove the vendor's original script,
33
- SDK initializer or tag-manager entry so c15t owns loading once.
33
+ SDK initializer or tag-manager entry, so the vendor loads only through c15t.
34
34
 
35
- The `scripts` export in `src/consent-scripts.ts` is a configuration, not an
36
- initializer. Add it to your existing consent owner using the registration point
37
- below. These are partial edits to that owner, not additional providers.
35
+ The vendor pages put the helper in `src/consent-scripts.ts`. If your framework
36
+ quickstart already has a `scripts` array, such as the one in `c15t.config.ts`
37
+ in the Next.js guide, add the helper to that array instead of creating a
38
+ second file.
39
+ The `scripts` export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration
40
+ point for your framework below. These are edits to that provider, not a second
41
+ provider.
38
42
 
39
43
  **Next.js**
40
44
 
41
- Import the configuration into the client boundary from your router guide:
42
-
43
- ```ts
44
- import { ConsentRoot } from 'c15t/next';
45
- import { scripts } from './consent-scripts';
46
- ```
45
+ Add the configuration to `scripts` in `c15t.config.ts`, next to
46
+ `next.config.ts`:
47
47
 
48
- Keep the server-resolved `state` and shared `consentConfig` from your
49
- router guide. Its manifest, init and save URLs stay in effect. Add
50
- `scripts` as a top-level prop on the existing root:
48
+ ```ts title="c15t.config.ts"
49
+ import { defineConsentConfig } from 'c15t/next';
50
+ import { scripts } from './src/consent-scripts';
51
51
 
52
- ```tsx
53
- <ConsentRoot state={state} config={consentConfig} scripts={scripts}>
54
- {children}
55
- </ConsentRoot>
52
+ export default defineConsentConfig({ scripts });
56
53
  ```
57
54
 
58
- For a Pages Router or static-export setup using `ConsentProvider`, add
59
- `scripts` to its existing `options` instead. Keep the router-specific setup
60
- from [Next.js script loading](https://c15t.com/docs/frameworks/next/script-loader).
55
+ Keep the rest of your config, such as `mode` and `routePrefix`, in the
56
+ same call. `ConsentRoot` reads the config in the browser, so the layout
57
+ keeps passing only `state`. App Router, Pages Router and static export all
58
+ read the same file. See
59
+ [Next.js scripts and embeds](https://v3.c15t.com/docs/frameworks/next/scripts).
61
60
 
62
61
  **TanStack Start**
63
62
 
64
- In your existing root route component, import the scripts alongside
65
- `ConsentRoot`. Keep the server loader from the [TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart).
63
+ Import the configuration into your root route and pass it to the existing
64
+ `ConsentRoot` as a top-level prop. Keep the loader from the
65
+ [TanStack Start quickstart](https://v3.c15t.com/docs/frameworks/tanstack-start/quickstart):
66
66
 
67
- ```tsx
68
- import { Outlet } from '@tanstack/react-router';
69
- import { ConsentRoot } from 'c15t/tanstack-start';
67
+ ```tsx title="src/routes/__root.tsx"
70
68
  import { scripts } from '../consent-scripts';
71
69
 
72
- function Root() {
73
- const state = Route.useLoaderData();
74
- return (
75
- <ConsentRoot state={state} backendURL={backendURL} initRoute={false} scripts={scripts}>
76
- <Outlet />
77
- {/* Keep your consent banner, dialog and preferences link here. */}
78
- </ConsentRoot>
79
- );
80
- }
70
+ <ConsentRoot state={consent} scripts={scripts}>
81
71
  ```
82
72
 
83
- This edits the existing route. `Route` and `backendURL` come from its setup;
84
- keep the document shell and head components if they are part of your root.
85
- `initRoute={false}` keeps the quickstart's direct-backend initialization.
86
- If your app mounts a consent server route, retain its existing `initRoute`
87
- instead. Do not return script callbacks from a server function or route loader.
73
+ Import vendor helpers in the root route module, not in a server function.
74
+ A server function's return value must be serializable, and script
75
+ configurations carry callbacks. See
76
+ [TanStack Start scripts](https://v3.c15t.com/docs/frameworks/tanstack-start/scripts).
88
77
 
89
78
  **React**
90
79
 
91
- Import the scripts into your existing provider component:
80
+ Add the configuration to the existing `ConsentProvider` options, next to
81
+ `mode`:
92
82
 
93
- ```ts
94
- import { ConsentProvider } from 'c15t/react';
83
+ ```tsx title="src/consent.tsx"
95
84
  import { scripts } from './consent-scripts';
96
- ```
97
-
98
- Keep the existing options and add `scripts`:
99
85
 
100
- ```tsx
101
- <ConsentProvider options={{ ...consentOptions, scripts }}>
102
- {children}
103
- </ConsentProvider>
86
+ <ConsentProvider options={{ mode, scripts }}>
104
87
  ```
105
88
 
106
- Here `consentOptions` is your existing configuration, including
107
- `mode: hosted({ url: backendURL })`. Keep the banner, dialog and preferences
108
- link inside the provider. See [React script loading](../frameworks/react/script-loader.md).
89
+ `mode` is the `manifest()` value from the
90
+ [React quickstart](../frameworks/react/quickstart.md). Keep the banner,
91
+ dialog and preferences link inside the provider. See
92
+ [React scripts and embeds](../frameworks/react/scripts.md).
109
93
 
110
94
  **Nuxt**
111
95
 
112
- Attach one loader from the root `app.vue`, after the Nuxt module has
113
- started its browser runtime. This keeps vendor callbacks in application code rather
114
- than serialized `nuxt.config.ts` runtime configuration.
96
+ Register the scripts under the `c15t` key in `app/app.config.ts`. Adjust the
97
+ relative import to where you created `consent-scripts.ts`:
115
98
 
116
- ```vue title="app/app.vue"
117
- <script setup lang="ts">
118
- import { onUnmounted } from 'vue';
119
- import { createScriptLoader } from 'c15t/modules/script-loader';
99
+ ```ts title="app/app.config.ts"
120
100
  import { scripts } from '../src/consent-scripts';
121
101
 
122
- const nuxtApp = useNuxtApp();
123
- const kernel = useConsentKernel();
124
- let loader: ReturnType<typeof createScriptLoader> | undefined;
125
-
126
- const removeMountedHook = nuxtApp.hook('app:mounted', () => {
127
- loader = createScriptLoader({ kernel, scripts });
128
- });
129
- onUnmounted(() => {
130
- removeMountedHook();
131
- loader?.dispose();
102
+ export default defineAppConfig({
103
+ c15t: { scripts },
132
104
  });
133
- </script>
134
-
135
- <template>
136
- <ConsentRoot />
137
- <NuxtPage />
138
- </template>
139
105
  ```
140
106
 
141
- Merge the setup code into your root and retain its footer and preferences
142
- link. `useConsentKernel` is auto-imported by the c15t Nuxt module. Adjust the
143
- relative script import if your `app.vue` is at the project root. This loader
144
- waits until the module has applied browser persistence and privacy signals,
145
- then reads the current snapshot and observes future changes. Do not also register these scripts
146
- in another loader. See the [Nuxt quickstart](https://c15t.com/docs/frameworks/nuxt/quickstart).
107
+ The Nuxt module merges this over its options in `nuxt.config.ts` and starts
108
+ one script loader in the browser after hydration, once it has applied the
109
+ visitor's stored choice and privacy signals. Keep `scripts` out of
110
+ `nuxt.config.ts`, which reaches the browser as JSON and drops the vendor
111
+ callbacks. Write the vendor IDs into `consent-scripts.ts`. See
112
+ [Nuxt scripts and embeds](https://v3.c15t.com/docs/frameworks/nuxt/scripts).
147
113
 
148
114
  **Vue**
149
115
 
150
- Use the kernel already provided by the Vue plugin. Merge this setup into
151
- `App.vue`, whose lifetime covers the application:
116
+ Pass the scripts to the existing `c15tVue` plugin call in `src/main.ts`:
152
117
 
153
- ```vue title="src/App.vue"
154
- <script setup lang="ts">
155
- import { onMounted, onUnmounted } from 'vue';
156
- import { createScriptLoader } from 'c15t/modules/script-loader';
157
- import { useConsentKernel } from 'c15t/vue/vue-plugin';
158
- import ConsentRoot from 'c15t/vue/consent-root';
118
+ ```ts title="src/main.ts"
119
+ import { c15tVue, manifest } from 'c15t/vue/vue-plugin';
159
120
  import { scripts } from './consent-scripts';
160
121
 
161
- const kernel = useConsentKernel();
162
- let loader: ReturnType<typeof createScriptLoader> | undefined;
163
-
164
- onMounted(() => {
165
- loader = createScriptLoader({ kernel, scripts });
122
+ app.use(c15tVue, {
123
+ mode: manifest(),
124
+ scripts,
166
125
  });
167
- onUnmounted(() => loader?.dispose());
168
- </script>
169
-
170
- <template>
171
- <ConsentRoot />
172
- <main>Your application</main>
173
- </template>
174
126
  ```
175
127
 
176
- Keep your existing page content and preferences link. The plugin still owns
177
- the kernel and persistence; this component owns only the vendor loader.
178
- Do not register the same scripts in plugin configuration as well. See the
179
- [Vue quickstart](https://c15t.com/docs/frameworks/vue/quickstart).
128
+ Keep your existing `mode` and other options. The plugin starts one
129
+ script loader when the app mounts, after it has applied the visitor's stored
130
+ choice. Do not also call `createScriptLoader` from a component. See
131
+ [Vue scripts and embeds](https://v3.c15t.com/docs/frameworks/vue/scripts).
180
132
 
181
133
  **Astro**
182
134
 
183
- Point the existing Astro integration at a client module. Keep its `mode`,
184
- `ui` and framework integration from the [Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart).
185
- Import `fileURLToPath` in your Astro configuration:
186
-
187
- ```js title="astro.config.mjs"
188
- import { fileURLToPath } from 'node:url';
189
- ```
190
-
191
- Add this option to the existing `c15t({ ... })` call. Resolve the path from
192
- the configuration file because Astro injects the import into a virtual module:
193
-
194
- ```js
195
- clientEntrypoint: fileURLToPath(new URL('./src/c15t.client.ts', import.meta.url)),
196
- ```
197
-
198
- Export the scripts from that module:
135
+ Add the scripts to the client entrypoint from the
136
+ [Astro quickstart](https://v3.c15t.com/docs/frameworks/astro/quickstart), `src/c15t.client.ts`,
137
+ which the integration finds on its own. Keep `astro.config.mjs` as it is.
138
+ If the module already exports scripts, combine the two arrays.
199
139
 
200
140
  ```ts title="src/c15t.client.ts"
201
- import type { C15tClientOptionsExtension } from '@c15t/astro';
141
+ import type { C15tClientOptionsExtension } from 'c15t/astro';
202
142
  import { scripts } from './consent-scripts';
203
143
 
204
144
  export default { scripts } satisfies C15tClientOptionsExtension;
205
145
  ```
206
146
 
207
- The integration passes this extension to its shared browser runtime. Vendor
208
- helpers contain callbacks, so do not put them in the serialized `scripts`
209
- option in `astro.config.mjs`. Keep one runtime across consent islands and
147
+ Vendor helpers contain callbacks, and the integration options in
148
+ `astro.config.mjs` are serialized into the page, so do not put helpers in
149
+ the integration's `scripts` option. The integration passes the client
150
+ entrypoint to the one runtime every page shares, including across
210
151
  `ClientRouter` navigation.
211
152
 
212
153
  **Svelte**
@@ -216,226 +157,174 @@ pass them as a top-level prop:
216
157
 
217
158
  ```svelte title="src/App.svelte"
218
159
  <script lang="ts">
219
- import { ConsentManagerProvider, hosted } from '@c15t/svelte';
160
+ import { ConsentProvider, manifest } from '@c15t/svelte';
220
161
  import { scripts } from './consent-scripts';
221
-
222
- const backendURL = import.meta.env.VITE_C15T_BACKEND_URL;
223
- if (!backendURL) throw new Error('Set VITE_C15T_BACKEND_URL');
224
- const mode = hosted({ url: backendURL });
225
162
  </script>
226
163
 
227
- <ConsentManagerProvider {mode} {scripts}>
164
+ <ConsentProvider mode={manifest()} {scripts}>
228
165
  <!-- Keep your application, consent UI and preferences link here. -->
229
- </ConsentManagerProvider>
166
+ </ConsentProvider>
230
167
  ```
231
168
 
232
- Retain the styles and consent UI from the [Svelte quickstart](https://c15t.com/docs/frameworks/svelte/quickstart).
169
+ Retain the styles and consent UI from the [Svelte quickstart](https://v3.c15t.com/docs/frameworks/svelte/quickstart).
233
170
  The provider owns the loader and disposes it on unmount.
234
171
 
235
172
  **SvelteKit**
236
173
 
237
- Add the scripts to the existing root layout provider. Keep the server load
238
- and its serializable prefetch data from the [SvelteKit quickstart](https://c15t.com/docs/frameworks/sveltekit/quickstart).
174
+ Add the scripts to the existing `ConsentRoot` in the root layout. Keep the
175
+ handle and the layout load from the [SvelteKit quickstart](https://v3.c15t.com/docs/frameworks/sveltekit/quickstart).
239
176
 
240
177
  ```svelte title="src/routes/+layout.svelte"
241
178
  <script lang="ts">
242
- import { ConsentManagerProvider, hosted } from '@c15t/svelte';
179
+ import { ConsentRoot } from '@c15t/svelte';
243
180
  import { scripts } from '../consent-scripts';
244
181
 
245
182
  let { children, data } = $props();
246
- const mode = hosted({ url: data.backendURL });
247
183
  </script>
248
184
 
249
- <ConsentManagerProvider {mode} {scripts} prefetch={data.prefetch}>
185
+ <ConsentRoot state={data.consent} {scripts}>
250
186
  {@render children()}
251
187
  <!-- Keep your consent UI and preferences link here. -->
252
- </ConsentManagerProvider>
188
+ </ConsentRoot>
253
189
  ```
254
190
 
255
- Import vendor helpers in the layout component, not in `+layout.server.ts`.
256
- For static hosting, keep your browser-only `mode` setup and omit request
257
- prefetch; the `scripts` prop stays the same. If you pass an externally owned
191
+ Import vendor helpers in the layout component, not in `+layout.server.ts`:
192
+ a server load cannot send functions to the browser. Prerendered, static and
193
+ SPA-mode pages use the same `scripts` prop. If you pass an externally owned
258
194
  `runtime` to the provider, register scripts when creating that runtime instead.
259
195
 
260
- **JavaScript**
261
-
262
- Attach the loader to your existing kernel before calling
263
- `kernel.commands.init()`:
264
-
265
- ```ts
266
- import { createScriptLoader } from 'c15t/modules/script-loader';
267
- import { scripts } from './consent-scripts';
268
-
269
- const loader = createScriptLoader({ kernel, scripts });
270
- ```
271
-
272
- Call `loader.dispose()` when that application instance is destroyed.
273
- `kernel` is the hosted kernel from your quickstart. A provider-owned kernel
274
- already has a loader; do not attach a second one. See
275
- [JavaScript script loading](https://c15t.com/docs/frameworks/javascript/script-loader).
276
-
277
- ## Options
196
+ **HTML**
278
197
 
279
- | Option | Type | Default | Description |
280
- | ----------- | ----------------- | ------------------------------------------- | -------------------------------------------------- |
281
- | `pixelId` | `string` | Required | Your OpenAI Ads Manager Pixel ID. |
282
- | `debug` | `boolean` | `false` | Log SDK activity to the browser console. |
283
- | `user` | `OpenAIPixelUser` | Omitted | User matching fields passed to SDK initialization. |
284
- | `scriptSrc` | `string` | `https://bzrcdn.openai.com/sdk/oaiq.min.js` | Override the SDK URL. |
198
+ The helpers in `@c15t/integrations` are ES modules that need a bundler. On a
199
+ page that loads the c15t script tag, paste the vendor's own snippet instead
200
+ and keep it inert until its category is allowed:
285
201
 
286
- ## Consent behavior
287
-
288
- The first SDK request waits for effective `marketing` permission. Under an
289
- opt-in policy, that means waiting for the visitor to grant consent.
290
- `measurement` permission alone does not enable this advertising pixel.
291
-
292
- Before the SDK loads, c15t queues these commands in order:
293
-
294
- ```js
295
- oaiq('consent', false);
296
- oaiq('init', { pixelId: 'YOUR_PIXEL_ID', debug: false });
297
- oaiq('consent', true);
298
- ```
299
-
300
- The initial denial overrides the SDK's default consent of `true`. Once loaded,
301
- the SDK stays on the page. c15t calls `oaiq('consent', false)` when marketing
302
- permission is denied and `oaiq('consent', true)` when it is granted again.
303
- Granting permission again does not reload or reinitialize the pixel.
304
-
305
- OpenAI documents that denied measurement events are dropped and are not replayed
306
- when consent returns. Consent denial does not unload the SDK or promise to erase
307
- existing attribution cookies. The SDK can still send diagnostic pings while
308
- measurement consent is denied.
309
-
310
- ## User matching
311
-
312
- Add `user` to the existing `openaiPixel` configuration in
313
- `src/consent-scripts.ts` to include customer matching data at initialization.
314
- All fields are optional:
315
-
316
- * `email_sha256`, `phone_number_sha256`, `external_id_sha256`,
317
- `first_name_sha256`, and `last_name_sha256` accept normalized SHA-256 hashes.
318
- * `country`, `city`, `region`, and `postal_code` accept location strings.
319
-
320
- ```ts
321
- openaiPixel({
322
- pixelId: 'YOUR_PIXEL_ID',
323
- user: { country: 'US', region: 'California', postal_code: '94107' },
324
- });
202
+ ```html
203
+ <script type="text/plain" data-c15t-category="measurement">
204
+ // The vendor's snippet, unchanged
205
+ </script>
325
206
  ```
326
207
 
327
- Normalize identifiers according to OpenAI's
328
- [user data rules](https://developers.openai.com/ads/measurement-pixel#send-user-data),
329
- then hash them as lowercase, 64-character SHA-256 hex strings. c15t forwards these
330
- values unchanged. It does not collect customer location or identifiers, or
331
- normalize or hash identifiers for you.
332
-
333
- If user data becomes available after initialization, pass the complete updated
334
- object through `window.oaiq?.('init', { pixelId: 'YOUR_PIXEL_ID', user })`.
335
- User data belongs on `init`, not on individual conversion events. Automatic
336
- advanced matching is configured by OpenAI; it is not an additional SDK init option.
208
+ Use the category this guide names for the vendor. c15t runs the snippet
209
+ once that category is allowed, and reloads the page when the visitor
210
+ withdraws it. Helper options on this page, such as `loadMode`, do not apply
211
+ to a pasted snippet. See [HTML scripts](https://v3.c15t.com/docs/frameworks/html/scripts).
337
212
 
338
- ## Send conversions
339
-
340
- Installing the pixel does not send a conversion or page view. Check effective
341
- marketing permission using your framework
342
- [consent API](https://c15t.com/docs/frameworks) before calling `openaiPixelEvent` from an
343
- application event handler. The helper checks API availability, not permission;
344
- the loaded SDK applies the consent signal supplied by c15t.
213
+ **JavaScript**
345
214
 
346
- This partial example belongs in an order-completion handler after that
347
- permission check. It sends an order value of $25.99:
215
+ Pass the scripts to `init()` from `@c15t/browser`, next to your mode:
348
216
 
349
217
  ```ts
350
- import { openaiPixelEvent } from '@c15t/scripts/openai-pixel';
351
-
352
- openaiPixelEvent(
353
- 'order_created',
354
- { type: 'contents', amount: 2599, currency: 'USD' },
355
- { event_id: 'order_123', opt_out: true },
356
- );
357
- ```
358
-
359
- The helper supports every documented browser event and its corresponding data
360
- shape. The optional fourth argument to the SDK, passed as the helper's third
361
- argument, supports `event_id` for browser/server deduplication and `opt_out` for
362
- opting an event out of future user-level personalization.
363
-
364
- Calls made before the queue exists are dropped. A callable `window.oaiq` does
365
- not mean marketing permission is still granted. Stop application event calls
366
- when permission is denied, even though the SDK remains loaded.
367
-
368
- `window.oaiq` is also typed for `init`, `consent`, `measure`, and `measureSingle`.
369
- The event helper uses `measure`, which sends to every initialized pixel. To target
370
- one initialized pixel, use:
218
+ import { init, manifest } from '@c15t/browser';
219
+ import { scripts } from './consent-scripts';
371
220
 
372
- ```ts
373
- window.oaiq?.(
374
- 'measureSingle',
375
- 'YOUR_PIXEL_ID',
376
- 'page_viewed',
377
- { type: 'contents' },
378
- );
221
+ const consent = init({
222
+ mode: manifest(),
223
+ scripts,
224
+ });
379
225
  ```
380
226
 
381
- See OpenAI's [supported events](https://developers.openai.com/ads/supported-events)
382
- for payload fields. `app_installed` and `app_opened` require the Conversions API
383
- and are not supported by the browser pixel.
384
-
385
- ### Custom events
227
+ Keep the mode from your quickstart. With
228
+ `createConsentRuntime` from `c15t/runtime`, pass `scripts` to it instead.
229
+ A kernel you create yourself needs a loader from
230
+ `c15t/modules/script-loader`. Attach one loader per kernel. See
231
+ [JavaScript scripts](https://v3.c15t.com/docs/frameworks/javascript/scripts).
386
232
 
387
- Custom events require `custom_event_name`. After checking marketing permission,
388
- you can verify a custom event with a clearly named payload:
233
+ ## Options
389
234
 
390
- ```ts
391
- import { openaiPixelEvent } from '@c15t/scripts/openai-pixel';
392
-
393
- openaiPixelEvent(
394
- 'custom',
395
- { type: 'custom' },
396
- {
397
- custom_event_name: 'c15t_integration_test',
398
- event_id: crypto.randomUUID(),
399
- opt_out: true,
400
- },
401
- );
235
+ | Option | Default | Behavior |
236
+ | ----------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
237
+ | `pixelId` | Required | Pixel ID passed to `oaiq('init', ...)`. The helper trims it. Empty or whitespace-only values log an error and the script does not load. |
238
+ | `debug` | `false` | Logs SDK activity, including queued and dropped events, to the browser console. |
239
+ | `user` | None | User matching fields passed to `init`: `email_sha256`, `phone_number_sha256`, `external_id_sha256`, `first_name_sha256`, `last_name_sha256`, `country`, `city`, `region` and `postal_code`. |
240
+ | `scriptSrc` | `https://bzrcdn.openai.com/sdk/oaiq.min.js` | SDK URL override. A blank value falls back to the default. |
241
+
242
+ c15t forwards `user` unchanged. Normalize and hash identifiers yourself as
243
+ OpenAI's
244
+ [user data rules](https://developers.openai.com/ads/measurement-pixel#send-user-data)
245
+ describe. If user data arrives after initialization, call
246
+ `window.oaiq('init', { pixelId, user })` again with the complete object.
247
+
248
+ ## Loading and revocation
249
+
250
+ `openaiPixel` uses the `marketing` category. Before marketing is allowed, c15t
251
+ defines no `oaiq` function and loads nothing from OpenAI. Measurement
252
+ permission alone does not load the pixel. When marketing becomes allowed, the
253
+ helper queues `oaiq('consent', false)`, `init` and `oaiq('consent', true)`,
254
+ then loads `oaiq.min.js`. The first call overrides the SDK's default consent of
255
+ `true`.
256
+
257
+ On revocation the helper keeps the SDK and calls `oaiq('consent', false)`. If
258
+ the visitor allows marketing again before the page reloads, it calls
259
+ `oaiq('consent', true)` without reinitializing the pixel. OpenAI drops events
260
+ sent while consent is denied and does not replay them later. The SDK can still
261
+ send diagnostic pings while consent is denied.
262
+
263
+ ## Guard your own oaiq calls
264
+
265
+ The helper sends no page view or conversion, so every event comes from your
266
+ code. After revocation `window.oaiq` still exists, so its presence does not
267
+ mean marketing is allowed. Check the permission first, then that the queue
268
+ exists:
269
+
270
+ ```ts title="src/track-order.ts"
271
+ export function trackOrder(marketingAllowed: boolean, orderId: string) {
272
+ if (!marketingAllowed || typeof window.oaiq !== 'function') return;
273
+ window.oaiq(
274
+ 'measure',
275
+ 'order_created',
276
+ { type: 'contents', amount: 2599, currency: 'USD' },
277
+ { event_id: orderId }
278
+ );
279
+ }
402
280
  ```
403
281
 
404
- ## Verify the integration
405
-
406
- Use a fresh session with an opt-in policy and set `debug: true` in your existing
407
- `openaiPixel` configuration while testing.
408
-
409
- 1. Before granting `marketing`, verify that the OpenAI SDK does not load and no
410
- measurement request is sent. Granting only `measurement` should not load it.
411
- 2. Grant `marketing` and perform an action that calls your event handler. For a
412
- page view, send `page_viewed` with `{ type: 'contents' }`.
413
- 3. Open Event Stream in Ads Manager and find the event. Inspect requests to
414
- `https://bzr.openai.com/v1/sdk/events` in the Network panel and check the
415
- response status. An accepted request confirms transport, not attribution to
416
- a ChatGPT ad.
417
- 4. Revoke `marketing` and verify that future application event calls stop. The
418
- SDK remains loaded and may still send diagnostic pings. Grant permission
419
- again and check that the SDK is not loaded twice.
420
- 5. Reload and repeat with the saved choice. Turn off `debug` after testing.
421
-
422
- The browser console reports whether the SDK queued or dropped an event. Follow
423
- the [consent verification guide](../guides/verify-consent.md) for policy and
424
- privacy-signal checks.
425
-
426
- The c15t live vendor monitor checks consent gating, the queue, the real SDK
427
- response, and runtime initialization. It uses a placeholder Pixel ID and blocks
428
- measurement requests, so monitor runs do not populate your Ads Manager events.
429
-
430
- ## Content Security Policy
431
-
432
- If your site uses a Content Security Policy, allow these sources in the
433
- corresponding directives:
434
-
435
- | Directive | Sources |
436
- | ------------- | -------------------------------------------------------- |
437
- | `script-src` | `https://bzrcdn.openai.com` |
438
- | `connect-src` | `https://bzr.openai.com` and `https://bzrcdn.openai.com` |
439
- | `img-src` | `https://bzr.openai.com` |
440
-
441
- Also allow the CDN in `script-src-elem` if your policy defines that directive.
282
+ Pass the current marketing permission from your framework, for example
283
+ `useConsent('marketing')` in React. `amount` is an integer in the currency's
284
+ minor unit, so `2599` is $25.99. Reuse `event_id` on the server event to
285
+ deduplicate it.
286
+
287
+ `@c15t/integrations/openai-pixel` also exports `openaiPixelEvent`, a typed wrapper
288
+ around `oaiq('measure', ...)`. It drops calls made before the queue exists and
289
+ does not check permission, so apply the same guard before calling it. A
290
+ `custom` event needs `custom_event_name` in its options. To send to one pixel
291
+ when you run several, call `window.oaiq('measureSingle', pixelId, ...)`.
292
+
293
+ ## Verify the OpenAI Pixel
294
+
295
+ Set `debug: true` while you test. After you allow marketing, `oaiq.min.js`
296
+ loads from `bzrcdn.openai.com`. Trigger one guarded event and check that a
297
+ request to `https://bzr.openai.com/v1/sdk/events` succeeds and the event
298
+ appears in Event Stream in Ads Manager. An accepted request confirms delivery,
299
+ not attribution to a ChatGPT ad. Then revoke marketing. Until the page
300
+ reloads, calling `trackOrder` sends nothing. Turn off `debug` when you finish.
301
+
302
+ If your site sets a Content Security Policy, allow `https://bzrcdn.openai.com`
303
+ in `script-src`, both `https://bzr.openai.com` and `https://bzrcdn.openai.com`
304
+ in `connect-src`, and `https://bzr.openai.com` in `img-src`.
305
+
306
+ Test in a private window with an opt-in policy. Open DevTools Network, disable
307
+ the cache and filter by the vendor's domain:
308
+
309
+ 1. Load the page. No request goes to the vendor before you choose.
310
+ 2. Click Reject, then reload. There is still no vendor request.
311
+ 3. Open Privacy settings and allow the helper's category. The vendor script
312
+ loads without a page reload.
313
+ 4. Turn the category off again and save. c15t reloads the page, and the new
314
+ page makes no vendor request.
315
+
316
+ c15t reloads on revocation because removing a script element does not stop
317
+ code that already ran. The vendor's listeners, timers and queued events stay
318
+ alive until the page unloads. If you set `reloadOnConsentRevoked: false`, stop
319
+ the vendor yourself. Register a callback-only script whose `onConsentChange`
320
+ calls the vendor's opt-out API, as shown in
321
+ [custom integrations](./building-integrations.md), and check the
322
+ permission before each of your own event calls. The reload does not delete
323
+ cookies the vendor already set; see
324
+ [clear on revocation for your framework](./overview.md#vendor-switches-and-cookie-cleanup).
325
+
326
+ The helper sets `vendor` to its script ID, so once you declare that vendor a
327
+ visitor can turn it off inside an allowed category. See
328
+ [vendor consent for your framework](./overview.md#vendor-switches-and-cookie-cleanup). The
329
+ [consent verification guide](../guides/verify-consent.md) covers navigation,
330
+ expiry and hosting checks.