@c15t/nextjs 2.1.0 → 2.2.1

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 (162) hide show
  1. package/AGENTS.md +155 -0
  2. package/README.md +31 -15
  3. package/client/components/integrations.js +3 -0
  4. package/dist/components/integrations/index.cjs +1 -0
  5. package/dist/components/integrations/index.js +1 -0
  6. package/dist/headless.cjs +1 -1
  7. package/dist/index.cjs +1 -1
  8. package/dist/libs/browser-initial-data.cjs +1 -1
  9. package/dist/libs/initial-data.cjs +1 -1
  10. package/dist/styles.tw3.css +1 -1
  11. package/dist/version.cjs +1 -1
  12. package/dist/version.js +1 -1
  13. package/dist-types/components/integrations/index.d.ts +1 -0
  14. package/dist-types/libs/browser-initial-data.d.ts +1 -1
  15. package/dist-types/version.d.ts +1 -1
  16. package/docs/README.md +155 -73
  17. package/docs/{building-headless-components.md → frameworks/next/building-headless-components.md} +3 -1
  18. package/docs/{callbacks.md → frameworks/next/callbacks.md} +3 -1
  19. package/docs/{components → frameworks/next/components}/consent-banner.md +10 -21
  20. package/docs/{components → frameworks/next/components}/consent-dialog-link.md +8 -5
  21. package/docs/frameworks/next/components/consent-dialog-trigger.md +202 -0
  22. package/docs/{components → frameworks/next/components}/consent-dialog.md +7 -15
  23. package/docs/frameworks/next/components/consent-manager-provider.md +327 -0
  24. package/docs/{components → frameworks/next/components}/consent-widget.md +8 -6
  25. package/docs/{components → frameworks/next/components}/dev-tools.md +9 -6
  26. package/docs/{components → frameworks/next/components}/frame.md +8 -9
  27. package/docs/{concepts → frameworks/next/concepts}/client-modes.md +4 -2
  28. package/docs/{concepts → frameworks/next/concepts}/consent-categories.md +1 -0
  29. package/docs/{concepts → frameworks/next/concepts}/consent-models.md +1 -0
  30. package/docs/{concepts → frameworks/next/concepts}/cookie-management.md +3 -3
  31. package/docs/{concepts → frameworks/next/concepts}/glossary.md +1 -0
  32. package/docs/{concepts → frameworks/next/concepts}/initialization-flow.md +1 -0
  33. package/docs/{concepts → frameworks/next/concepts}/policy-packs.md +1 -0
  34. package/docs/{headless.md → frameworks/next/headless.md} +3 -1
  35. package/docs/{hooks → frameworks/next/hooks}/use-color-scheme.md +1 -0
  36. package/docs/{hooks → frameworks/next/hooks}/use-consent-manager/checking-consent.md +3 -1
  37. package/docs/{hooks → frameworks/next/hooks}/use-consent-manager/location-info.md +3 -1
  38. package/docs/frameworks/next/hooks/use-consent-manager/overview.md +185 -0
  39. package/docs/{hooks → frameworks/next/hooks}/use-consent-manager/setting-consent.md +3 -1
  40. package/docs/{hooks → frameworks/next/hooks}/use-draggable.md +3 -1
  41. package/docs/{hooks → frameworks/next/hooks}/use-focus-trap.md +1 -0
  42. package/docs/{hooks → frameworks/next/hooks}/use-reduced-motion.md +3 -1
  43. package/docs/{hooks → frameworks/next/hooks}/use-ssr-status.md +6 -5
  44. package/docs/{hooks → frameworks/next/hooks}/use-text-direction.md +1 -0
  45. package/docs/frameworks/next/hooks/use-translations.md +55 -0
  46. package/docs/{iab → frameworks/next/iab}/consent-banner.md +9 -12
  47. package/docs/{iab → frameworks/next/iab}/consent-dialog.md +9 -14
  48. package/docs/{iab → frameworks/next/iab}/overview.md +4 -2
  49. package/docs/{iab → frameworks/next/iab}/use-gvl-data.md +3 -2
  50. package/docs/{iframe-blocking.md → frameworks/next/iframe-blocking.md} +8 -9
  51. package/docs/{internationalization.md → frameworks/next/internationalization.md} +13 -3
  52. package/docs/{network-blocker.md → frameworks/next/network-blocker.md} +13 -51
  53. package/docs/{optimization.md → frameworks/next/optimization.md} +5 -4
  54. package/docs/{policy-packs.md → frameworks/next/policy-packs.md} +3 -1
  55. package/docs/{quickstart.md → frameworks/next/quickstart.md} +26 -42
  56. package/docs/{script-loader.md → frameworks/next/script-loader.md} +72 -90
  57. package/docs/{server-side.md → frameworks/next/server-side.md} +12 -15
  58. package/docs/{styling → frameworks/next/styling}/classnames.md +3 -1
  59. package/docs/{styling → frameworks/next/styling}/color-scheme.md +3 -1
  60. package/docs/frameworks/next/styling/css-variables.md +53 -0
  61. package/docs/frameworks/next/styling/overview.md +299 -0
  62. package/docs/frameworks/next/styling/slots.md +94 -0
  63. package/docs/{styling → frameworks/next/styling}/tailwind.md +3 -1
  64. package/docs/frameworks/next/styling/tokens.md +156 -0
  65. package/docs/{troubleshooting.md → frameworks/next/troubleshooting.md} +3 -1
  66. package/docs/integrations/adobe-analytics.md +160 -0
  67. package/docs/integrations/ahrefs-analytics.md +15 -82
  68. package/docs/integrations/amplitude.md +230 -0
  69. package/docs/integrations/building-integrations.md +15 -181
  70. package/docs/integrations/clearbit.md +130 -0
  71. package/docs/integrations/cloudflare-web-analytics.md +15 -83
  72. package/docs/integrations/crisp.md +13 -87
  73. package/docs/integrations/databuddy.md +16 -85
  74. package/docs/integrations/fathom-analytics.md +15 -86
  75. package/docs/integrations/google-maps.md +263 -0
  76. package/docs/integrations/google-tag-manager.md +18 -86
  77. package/docs/integrations/google-tag.md +15 -84
  78. package/docs/integrations/heap.md +219 -0
  79. package/docs/integrations/hightouch.md +199 -0
  80. package/docs/integrations/hotjar.md +15 -83
  81. package/docs/integrations/intercom.md +13 -83
  82. package/docs/integrations/linkedin-insights.md +15 -82
  83. package/docs/integrations/logrocket.md +175 -0
  84. package/docs/integrations/matomo-analytics.md +13 -88
  85. package/docs/integrations/meta-pixel.md +33 -316
  86. package/docs/integrations/microsoft-clarity.md +15 -83
  87. package/docs/integrations/microsoft-uet.md +16 -83
  88. package/docs/integrations/mixpanel-analytics.md +15 -83
  89. package/docs/integrations/overview.md +55 -6
  90. package/docs/integrations/pirsch.md +142 -0
  91. package/docs/integrations/plausible-analytics.md +14 -97
  92. package/docs/integrations/posthog.md +26 -98
  93. package/docs/integrations/promptwatch.md +16 -82
  94. package/docs/integrations/reddit-pixel.md +27 -122
  95. package/docs/integrations/rudderstack.md +271 -0
  96. package/docs/integrations/rybbit-analytics.md +15 -94
  97. package/docs/integrations/segment.md +15 -82
  98. package/docs/integrations/snapchat-pixel.md +21 -102
  99. package/docs/integrations/tiktok-pixel.md +13 -81
  100. package/docs/integrations/umami-analytics.md +16 -88
  101. package/docs/integrations/vercel-analytics.md +13 -85
  102. package/docs/integrations/x-pixel.md +27 -102
  103. package/docs/integrations/youtube.md +193 -0
  104. package/docs/shared/concepts/client-modes.md +103 -0
  105. package/docs/shared/concepts/consent-categories.md +41 -0
  106. package/docs/shared/concepts/consent-models.md +72 -0
  107. package/docs/shared/concepts/cookie-management.md +88 -0
  108. package/docs/shared/concepts/glossary.md +24 -0
  109. package/docs/shared/concepts/initialization-flow.md +105 -0
  110. package/docs/shared/concepts/policy-packs.md +225 -0
  111. package/docs/shared/react/components/consent-banner.md +242 -0
  112. package/docs/shared/react/components/consent-dialog-link.md +45 -0
  113. package/docs/shared/react/components/consent-dialog-trigger.md +185 -0
  114. package/docs/shared/react/components/consent-dialog.md +119 -0
  115. package/docs/shared/react/components/consent-manager-provider.md +225 -0
  116. package/docs/shared/react/components/consent-widget.md +121 -0
  117. package/docs/shared/react/components/dev-tools.md +81 -0
  118. package/docs/shared/react/components/frame.md +52 -0
  119. package/docs/shared/react/guides/building-headless-components.md +110 -0
  120. package/docs/shared/react/guides/callbacks.md +89 -0
  121. package/docs/shared/react/guides/headless.md +31 -0
  122. package/docs/shared/react/guides/iframe-blocking.md +65 -0
  123. package/docs/shared/react/guides/internationalization.md +123 -0
  124. package/docs/shared/react/guides/network-blocker.md +72 -0
  125. package/docs/shared/react/guides/optimization.md +44 -0
  126. package/docs/shared/react/guides/policy-packs.md +173 -0
  127. package/docs/shared/react/guides/script-loader.md +311 -0
  128. package/docs/shared/react/hooks/use-color-scheme.md +31 -0
  129. package/docs/shared/react/hooks/use-consent-manager/checking-consent.md +95 -0
  130. package/docs/shared/react/hooks/use-consent-manager/location-info.md +96 -0
  131. package/docs/shared/react/hooks/use-consent-manager/overview.md +74 -0
  132. package/docs/shared/react/hooks/use-consent-manager/setting-consent.md +93 -0
  133. package/docs/shared/react/hooks/use-draggable.md +30 -0
  134. package/docs/shared/react/hooks/use-focus-trap.md +20 -0
  135. package/docs/shared/react/hooks/use-reduced-motion.md +33 -0
  136. package/docs/shared/react/hooks/use-ssr-status.md +16 -0
  137. package/docs/shared/react/hooks/use-text-direction.md +38 -0
  138. package/docs/shared/react/hooks/use-translations.md +15 -0
  139. package/docs/shared/react/iab/consent-banner.md +60 -0
  140. package/docs/shared/react/iab/consent-dialog.md +76 -0
  141. package/docs/shared/react/iab/overview.md +80 -0
  142. package/docs/shared/react/iab/use-gvl-data.md +21 -0
  143. package/docs/shared/react/styling/classnames.md +93 -0
  144. package/docs/shared/react/styling/color-scheme.md +35 -0
  145. package/docs/shared/react/styling/css-variables.md +53 -0
  146. package/docs/shared/react/styling/overview.md +261 -0
  147. package/docs/shared/react/styling/slots.md +93 -0
  148. package/docs/shared/react/styling/stylesheet-entrypoint.md +8 -0
  149. package/docs/shared/react/styling/tailwind.md +88 -0
  150. package/docs/shared/react/styling/tokens.md +155 -0
  151. package/docs/shared/troubleshooting.md +82 -0
  152. package/package.json +19 -10
  153. package/readme.json +14 -8
  154. package/docs/ai-agents.md +0 -111
  155. package/docs/components/consent-dialog-trigger.md +0 -103
  156. package/docs/components/consent-manager-provider.md +0 -425
  157. package/docs/hooks/use-consent-manager/overview.md +0 -420
  158. package/docs/hooks/use-translations.md +0 -118
  159. package/docs/styling/css-variables.md +0 -92
  160. package/docs/styling/overview.md +0 -457
  161. package/docs/styling/slots.md +0 -128
  162. package/docs/styling/tokens.md +0 -216
package/docs/integrations/tiktok-pixel.md CHANGED
@@ -1,8 +1,8 @@
1
1
  ---
2
2
  title: TikTok Pixel
3
3
  description: Measure ad performance and build audiences for TikTok advertising campaigns.
4
- lastModified: 2025-09-24
5
4
  icon: tiktok
5
+ group: integrations
6
6
  ---
7
7
  TikTok Pixel is TikTok's conversion tracking and audience targeting tool. It measures ad effectiveness, tracks user actions, and helps optimize your TikTok advertising campaigns.
8
8
 
@@ -106,86 +106,18 @@ function PurchaseButton() {
106
106
 
107
107
  ### TikTokPixelOptions
108
108
 
109
- |Property|Type|Description|Default|Required|
110
- |:--|:--|:--|:--|:--:|
111
- |pixelId|string|Your TikTok Pixel ID|-|✅ Required|
112
- |scriptSrc|string \|undefined|TikTok Pixel loader base URL.|-|Optional|
109
+ |Property|Value|
110
+ |:--|:--|
111
+ |Type Name|\`TikTokPixelOptions\`|
112
+ |Source Path|\`./packages/scripts/src/vendors/ads-and-pixels/tiktok-pixel.ts\`|
113
+
114
+ \*ExtractedTypeTable: Could not extract "TikTokPixelOptions" from "./packages/scripts/src/vendors/ads-and-pixels/tiktok-pixel.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
113
115
 
114
116
  ### Script
115
117
 
116
- |Property|Type|Description|Default|Required|
117
- |:--|:--|:--|:--|:--:|
118
- |id|string|Unique identifier for the script|-|✅ Required|
119
- |src|string \|undefined|URL of the script to load|-|Optional|
120
- |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
121
- |category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
122
- |callbackOnly|boolean \|undefined|Whether this is a callback-only script that doesn't need to load an external resource. When true, no script tag will be added to the DOM, only callbacks will be executed.|false|Optional|
123
- |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
124
- |alwaysLoad|boolean \|undefined|Whether the script should always load regardless of consent state. This is useful for scripts like Google Tag Manager or PostHog that manage their own consent state internally. The script will load immediately and never be unloaded based on consent changes. Note: When using this option, you are responsible for ensuring the script itself respects user consent preferences through its own consent management.|false|Optional|
125
- |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
126
- |attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
127
- |async|boolean \|undefined|Whether to use async loading|-|Optional|
128
- |defer|boolean \|undefined|Whether to defer script loading|-|Optional|
129
- |nonce|string \|undefined|Content Security Policy nonce|-|Optional|
130
- |anonymizeId|boolean \|undefined|Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockers|true|Optional|
131
- |target|"head" \|"body" \|undefined|Where to inject the script element in the DOM. Options: \`'head'\`: Scripts are appended to \`\<head>\` (default); \`'body'\`: Scripts are appended to \`\<body>\`|'head'|Optional|
132
- |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
133
- |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
134
- |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
135
- |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
136
- |vendorId|string \|number \|undefined|IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over \`category\` when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.|-|Optional|
137
- |iabPurposes|number\[] \|undefined|IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.|-|Optional|
138
- |iabLegIntPurposes|number\[] \|undefined|IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.|-|Optional|
139
- |iabSpecialFeatures|number\[] \|undefined|IAB TCF special feature IDs this script requires. Options: 1: Use precise geolocation data; 2: Actively scan device characteristics for identification|-|Optional|
140
-
141
- #### `onBeforeLoad`
142
-
143
- Callback executed before the script is loaded
144
-
145
- |Property|Type|Description|Default|Required|
146
- |:--|:--|:--|:--|:--:|
147
- |id|string|The original script ID|-|✅ Required|
148
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
149
- |hasConsent|boolean|Has consent|-|✅ Required|
150
- |consents|ConsentState|The current consent state|-|✅ Required|
151
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
152
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
153
-
154
- #### `onLoad`
155
-
156
- Callback executed when the script loads successfully
157
-
158
- |Property|Type|Description|Default|Required|
159
- |:--|:--|:--|:--|:--:|
160
- |id|string|The original script ID|-|✅ Required|
161
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
162
- |hasConsent|boolean|Has consent|-|✅ Required|
163
- |consents|ConsentState|The current consent state|-|✅ Required|
164
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
165
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
166
-
167
- #### `onError`
168
-
169
- Callback executed if the script fails to load
170
-
171
- |Property|Type|Description|Default|Required|
172
- |:--|:--|:--|:--|:--:|
173
- |id|string|The original script ID|-|✅ Required|
174
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
175
- |hasConsent|boolean|Has consent|-|✅ Required|
176
- |consents|ConsentState|The current consent state|-|✅ Required|
177
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
178
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
179
-
180
- #### `onConsentChange`
181
-
182
- Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
183
-
184
- |Property|Type|Description|Default|Required|
185
- |:--|:--|:--|:--|:--:|
186
- |id|string|The original script ID|-|✅ Required|
187
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
188
- |hasConsent|boolean|Has consent|-|✅ Required|
189
- |consents|ConsentState|The current consent state|-|✅ Required|
190
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
191
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
118
+ |Property|Value|
119
+ |:--|:--|
120
+ |Type Name|\`Script\`|
121
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
122
+
123
+ \*ExtractedTypeTable: Could not extract "Script" from "./packages/core/src/libs/script-loader/types.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
package/docs/integrations/umami-analytics.md CHANGED
@@ -1,7 +1,8 @@
1
1
  ---
2
2
  title: Umami Analytics
3
- description: Open-source, cookieless analytics with a prebuilt helper that maps Umami's data attributes into a c15t-managed script.
4
- lastModified: 2026-05-10
3
+ description: Open-source, cookieless analytics with a prebuilt helper that maps
4
+ Umami's data attributes into a c15t-managed script.
5
+ group: integrations
5
6
  icon: umami-analytics
6
7
  ---
7
8
  Umami is an open-source, cookieless analytics product configured entirely through `data-*` attributes on its loader. The `umamiAnalytics()` helper serializes your website ID, host override, and tracking options into those attributes and hands the result to c15t's script loader.
@@ -91,7 +92,7 @@ umamiAnalytics({
91
92
 
92
93
  Each option is mapped to Umami's published `data-*` attribute (`data-website-id`, `data-host-url`, `data-auto-track`, `data-domains`, `data-tag`, `data-before-send`) and the script uses `defer` so it matches Umami's recommended embed pattern.
93
94
 
94
- > ℹ️ **Info:**
95
+ > 📝 **Note:**
95
96
  > beforeSend accepts a string referencing a global hook (e.g. 'window\.umamiBeforeSend'), not a function value. The c15t manifest runtime serializes script configuration, so inline callbacks cannot be passed through it.
96
97
 
97
98
  ## Tracking events in your app
@@ -130,91 +131,18 @@ if (consentStore.getState().has('measurement')) {
130
131
 
131
132
  ### UmamiAnalyticsOptions
132
133
 
133
- |Property|Type|Description|Default|Required|
134
- |:--|:--|:--|:--|:--:|
135
- |websiteId|string|Your Umami website ID.|-|✅ Required|
136
- |hostUrl|string \|undefined|Override the host that receives analytics events.|-|Optional|
137
- |autoTrack|boolean \|undefined|Disable automatic tracking when set to \`false\`.|-|Optional|
138
- |domains|string \|string\[] \|undefined|Restrict tracking to specific domains.|-|Optional|
139
- |tag|string \|undefined|Attach a tag to tracked events.|-|Optional|
140
- |beforeSend|string \|undefined|Optional global hook name used for Umami's \`data-before-send\` attribute. Callback functions are intentionally not supported here because the c15t manifest runtime cannot serialize custom JavaScript functions.|-|Optional|
141
- |scriptUrl|string \|undefined|Custom loader URL.|'https\://cloud.umami.is/script.js'|Optional|
134
+ |Property|Value|
135
+ |:--|:--|
136
+ |Type Name|\`UmamiAnalyticsOptions\`|
137
+ |Source Path|\`./packages/scripts/src/vendors/analytics/umami-analytics.ts\`|
138
+
139
+ \*ExtractedTypeTable: Could not extract "UmamiAnalyticsOptions" from "./packages/scripts/src/vendors/analytics/umami-analytics.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
142
140
 
143
141
  ### Script
144
142
 
145
- |Property|Type|Description|Default|Required|
146
- |:--|:--|:--|:--|:--:|
147
- |id|string|Unique identifier for the script|-|✅ Required|
148
- |src|string \|undefined|URL of the script to load|-|Optional|
149
- |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
150
- |category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
151
- |callbackOnly|boolean \|undefined|Whether this is a callback-only script that doesn't need to load an external resource. When true, no script tag will be added to the DOM, only callbacks will be executed.|false|Optional|
152
- |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
153
- |alwaysLoad|boolean \|undefined|Whether the script should always load regardless of consent state. This is useful for scripts like Google Tag Manager or PostHog that manage their own consent state internally. The script will load immediately and never be unloaded based on consent changes. Note: When using this option, you are responsible for ensuring the script itself respects user consent preferences through its own consent management.|false|Optional|
154
- |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
155
- |attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
156
- |async|boolean \|undefined|Whether to use async loading|-|Optional|
157
- |defer|boolean \|undefined|Whether to defer script loading|-|Optional|
158
- |nonce|string \|undefined|Content Security Policy nonce|-|Optional|
159
- |anonymizeId|boolean \|undefined|Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockers|true|Optional|
160
- |target|"head" \|"body" \|undefined|Where to inject the script element in the DOM. Options: \`'head'\`: Scripts are appended to \`\<head>\` (default); \`'body'\`: Scripts are appended to \`\<body>\`|'head'|Optional|
161
- |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
162
- |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
163
- |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
164
- |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
165
- |vendorId|string \|number \|undefined|IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over \`category\` when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.|-|Optional|
166
- |iabPurposes|number\[] \|undefined|IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.|-|Optional|
167
- |iabLegIntPurposes|number\[] \|undefined|IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.|-|Optional|
168
- |iabSpecialFeatures|number\[] \|undefined|IAB TCF special feature IDs this script requires. Options: 1: Use precise geolocation data; 2: Actively scan device characteristics for identification|-|Optional|
169
-
170
- #### `onBeforeLoad`
171
-
172
- Callback executed before the script is loaded
173
-
174
- |Property|Type|Description|Default|Required|
175
- |:--|:--|:--|:--|:--:|
176
- |id|string|The original script ID|-|✅ Required|
177
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
178
- |hasConsent|boolean|Has consent|-|✅ Required|
179
- |consents|ConsentState|The current consent state|-|✅ Required|
180
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
181
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
182
-
183
- #### `onLoad`
184
-
185
- Callback executed when the script loads successfully
186
-
187
- |Property|Type|Description|Default|Required|
188
- |:--|:--|:--|:--|:--:|
189
- |id|string|The original script ID|-|✅ Required|
190
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
191
- |hasConsent|boolean|Has consent|-|✅ Required|
192
- |consents|ConsentState|The current consent state|-|✅ Required|
193
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
194
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
195
-
196
- #### `onError`
197
-
198
- Callback executed if the script fails to load
199
-
200
- |Property|Type|Description|Default|Required|
201
- |:--|:--|:--|:--|:--:|
202
- |id|string|The original script ID|-|✅ Required|
203
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
204
- |hasConsent|boolean|Has consent|-|✅ Required|
205
- |consents|ConsentState|The current consent state|-|✅ Required|
206
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
207
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
208
-
209
- #### `onConsentChange`
210
-
211
- Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
212
-
213
- |Property|Type|Description|Default|Required|
214
- |:--|:--|:--|:--|:--:|
215
- |id|string|The original script ID|-|✅ Required|
216
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
217
- |hasConsent|boolean|Has consent|-|✅ Required|
218
- |consents|ConsentState|The current consent state|-|✅ Required|
219
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
220
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
143
+ |Property|Value|
144
+ |:--|:--|
145
+ |Type Name|\`Script\`|
146
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
147
+
148
+ \*ExtractedTypeTable: Could not extract "Script" from "./packages/core/src/libs/script-loader/types.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
package/docs/integrations/vercel-analytics.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: Vercel Analytics
3
3
  description: Bootstrap Vercel Analytics with a declarative queue and script attributes.
4
- lastModified: 2026-05-10
4
+ group: integrations
5
5
  icon: vercel-analytics
6
6
  ---
7
7
  Vercel Analytics loads through `@c15t/scripts` using a declarative queue bootstrap (`vaq` + `va`) and script attributes for DSN/endpoint options.
@@ -124,90 +124,18 @@ if (consentStore.getState().has('measurement')) {
124
124
 
125
125
  ### VercelAnalyticsOptions
126
126
 
127
- |Property|Type|Description|Default|Required|
128
- |:--|:--|:--|:--|:--:|
129
- |dsn|string \|undefined|Project DSN for self-hosted or non-Vercel deployments.|-|Optional|
130
- |disableAutoTrack|boolean \|undefined|Disable automatic pageview tracking.|-|Optional|
131
- |mode|VercelAnalyticsMode \|undefined|Preferred script mode.|-|Optional|
132
- |debug|boolean \|undefined|Load Vercel's debug bundle when set to \`true\`.|-|Optional|
133
- |endpoint|string \|undefined|Custom ingestion endpoint.|-|Optional|
134
- |scriptUrl|string \|undefined|Custom loader URL.|-|Optional|
127
+ |Property|Value|
128
+ |:--|:--|
129
+ |Type Name|\`VercelAnalyticsOptions\`|
130
+ |Source Path|\`./packages/scripts/src/vendors/analytics/vercel-analytics.ts\`|
131
+
132
+ \*ExtractedTypeTable: Could not extract "VercelAnalyticsOptions" from "./packages/scripts/src/vendors/analytics/vercel-analytics.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
135
133
 
136
134
  ### Script
137
135
 
138
- |Property|Type|Description|Default|Required|
139
- |:--|:--|:--|:--|:--:|
140
- |id|string|Unique identifier for the script|-|✅ Required|
141
- |src|string \|undefined|URL of the script to load|-|Optional|
142
- |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
143
- |category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
144
- |callbackOnly|boolean \|undefined|Whether this is a callback-only script that doesn't need to load an external resource. When true, no script tag will be added to the DOM, only callbacks will be executed.|false|Optional|
145
- |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
146
- |alwaysLoad|boolean \|undefined|Whether the script should always load regardless of consent state. This is useful for scripts like Google Tag Manager or PostHog that manage their own consent state internally. The script will load immediately and never be unloaded based on consent changes. Note: When using this option, you are responsible for ensuring the script itself respects user consent preferences through its own consent management.|false|Optional|
147
- |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
148
- |attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
149
- |async|boolean \|undefined|Whether to use async loading|-|Optional|
150
- |defer|boolean \|undefined|Whether to defer script loading|-|Optional|
151
- |nonce|string \|undefined|Content Security Policy nonce|-|Optional|
152
- |anonymizeId|boolean \|undefined|Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockers|true|Optional|
153
- |target|"head" \|"body" \|undefined|Where to inject the script element in the DOM. Options: \`'head'\`: Scripts are appended to \`\<head>\` (default); \`'body'\`: Scripts are appended to \`\<body>\`|'head'|Optional|
154
- |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
155
- |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
156
- |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
157
- |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
158
- |vendorId|string \|number \|undefined|IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over \`category\` when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.|-|Optional|
159
- |iabPurposes|number\[] \|undefined|IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.|-|Optional|
160
- |iabLegIntPurposes|number\[] \|undefined|IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.|-|Optional|
161
- |iabSpecialFeatures|number\[] \|undefined|IAB TCF special feature IDs this script requires. Options: 1: Use precise geolocation data; 2: Actively scan device characteristics for identification|-|Optional|
162
-
163
- #### `onBeforeLoad`
164
-
165
- Callback executed before the script is loaded
166
-
167
- |Property|Type|Description|Default|Required|
168
- |:--|:--|:--|:--|:--:|
169
- |id|string|The original script ID|-|✅ Required|
170
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
171
- |hasConsent|boolean|Has consent|-|✅ Required|
172
- |consents|ConsentState|The current consent state|-|✅ Required|
173
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
174
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
175
-
176
- #### `onLoad`
177
-
178
- Callback executed when the script loads successfully
179
-
180
- |Property|Type|Description|Default|Required|
181
- |:--|:--|:--|:--|:--:|
182
- |id|string|The original script ID|-|✅ Required|
183
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
184
- |hasConsent|boolean|Has consent|-|✅ Required|
185
- |consents|ConsentState|The current consent state|-|✅ Required|
186
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
187
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
188
-
189
- #### `onError`
190
-
191
- Callback executed if the script fails to load
192
-
193
- |Property|Type|Description|Default|Required|
194
- |:--|:--|:--|:--|:--:|
195
- |id|string|The original script ID|-|✅ Required|
196
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
197
- |hasConsent|boolean|Has consent|-|✅ Required|
198
- |consents|ConsentState|The current consent state|-|✅ Required|
199
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
200
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
201
-
202
- #### `onConsentChange`
203
-
204
- Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
205
-
206
- |Property|Type|Description|Default|Required|
207
- |:--|:--|:--|:--|:--:|
208
- |id|string|The original script ID|-|✅ Required|
209
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
210
- |hasConsent|boolean|Has consent|-|✅ Required|
211
- |consents|ConsentState|The current consent state|-|✅ Required|
212
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
213
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
136
+ |Property|Value|
137
+ |:--|:--|
138
+ |Type Name|\`Script\`|
139
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
140
+
141
+ \*ExtractedTypeTable: Could not extract "Script" from "./packages/core/src/libs/script-loader/types.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
package/docs/integrations/x-pixel.md CHANGED
@@ -1,8 +1,9 @@
1
1
  ---
2
2
  title: X Pixel (Twitter Pixel)
3
- description: Track conversions and build audiences for advertising campaigns on X (formerly Twitter).
4
- lastModified: 2025-09-24
3
+ description: Track conversions and build audiences for advertising campaigns on
4
+ X (formerly Twitter).
5
5
  icon: x
6
+ group: integrations
6
7
  ---
7
8
  X Pixel (formerly Twitter Pixel) is X's conversion tracking and audience building tool. It helps you measure ad performance, retarget website visitors, and optimize campaigns on the X platform.
8
9
 
@@ -121,112 +122,36 @@ function PurchaseButton() {
121
122
 
122
123
  ### XPixelOptions
123
124
 
124
- |Property|Type|Description|Default|Required|
125
- |:--|:--|:--|:--|:--:|
126
- |pixelId|string|Your X Pixel ID|-|✅ Required|
127
- |scriptSrc|string \|undefined|X Pixel loader URL.|-|Optional|
125
+ |Property|Value|
126
+ |:--|:--|
127
+ |Type Name|\`XPixelOptions\`|
128
+ |Source Path|\`./packages/scripts/src/vendors/ads-and-pixels/x-pixel.ts\`|
129
+
130
+ \*ExtractedTypeTable: Could not extract "XPixelOptions" from "./packages/scripts/src/vendors/ads-and-pixels/x-pixel.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
128
131
 
129
132
  ### Script
130
133
 
131
- |Property|Type|Description|Default|Required|
132
- |:--|:--|:--|:--|:--:|
133
- |id|string|Unique identifier for the script|-|✅ Required|
134
- |src|string \|undefined|URL of the script to load|-|Optional|
135
- |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
136
- |category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
137
- |callbackOnly|boolean \|undefined|Whether this is a callback-only script that doesn't need to load an external resource. When true, no script tag will be added to the DOM, only callbacks will be executed.|false|Optional|
138
- |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
139
- |alwaysLoad|boolean \|undefined|Whether the script should always load regardless of consent state. This is useful for scripts like Google Tag Manager or PostHog that manage their own consent state internally. The script will load immediately and never be unloaded based on consent changes. Note: When using this option, you are responsible for ensuring the script itself respects user consent preferences through its own consent management.|false|Optional|
140
- |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
141
- |attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
142
- |async|boolean \|undefined|Whether to use async loading|-|Optional|
143
- |defer|boolean \|undefined|Whether to defer script loading|-|Optional|
144
- |nonce|string \|undefined|Content Security Policy nonce|-|Optional|
145
- |anonymizeId|boolean \|undefined|Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockers|true|Optional|
146
- |target|"head" \|"body" \|undefined|Where to inject the script element in the DOM. Options: \`'head'\`: Scripts are appended to \`\<head>\` (default); \`'body'\`: Scripts are appended to \`\<body>\`|'head'|Optional|
147
- |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
148
- |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
149
- |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
150
- |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
151
- |vendorId|string \|number \|undefined|IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over \`category\` when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.|-|Optional|
152
- |iabPurposes|number\[] \|undefined|IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.|-|Optional|
153
- |iabLegIntPurposes|number\[] \|undefined|IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.|-|Optional|
154
- |iabSpecialFeatures|number\[] \|undefined|IAB TCF special feature IDs this script requires. Options: 1: Use precise geolocation data; 2: Actively scan device characteristics for identification|-|Optional|
155
-
156
- #### `onBeforeLoad`
157
-
158
- Callback executed before the script is loaded
159
-
160
- |Property|Type|Description|Default|Required|
161
- |:--|:--|:--|:--|:--:|
162
- |id|string|The original script ID|-|✅ Required|
163
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
164
- |hasConsent|boolean|Has consent|-|✅ Required|
165
- |consents|ConsentState|The current consent state|-|✅ Required|
166
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
167
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
168
-
169
- #### `onLoad`
170
-
171
- Callback executed when the script loads successfully
172
-
173
- |Property|Type|Description|Default|Required|
174
- |:--|:--|:--|:--|:--:|
175
- |id|string|The original script ID|-|✅ Required|
176
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
177
- |hasConsent|boolean|Has consent|-|✅ Required|
178
- |consents|ConsentState|The current consent state|-|✅ Required|
179
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
180
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
181
-
182
- #### `onError`
183
-
184
- Callback executed if the script fails to load
185
-
186
- |Property|Type|Description|Default|Required|
187
- |:--|:--|:--|:--|:--:|
188
- |id|string|The original script ID|-|✅ Required|
189
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
190
- |hasConsent|boolean|Has consent|-|✅ Required|
191
- |consents|ConsentState|The current consent state|-|✅ Required|
192
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
193
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
194
-
195
- #### `onConsentChange`
196
-
197
- Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
198
-
199
- |Property|Type|Description|Default|Required|
200
- |:--|:--|:--|:--|:--:|
201
- |id|string|The original script ID|-|✅ Required|
202
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
203
- |hasConsent|boolean|Has consent|-|✅ Required|
204
- |consents|ConsentState|The current consent state|-|✅ Required|
205
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
206
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
134
+ |Property|Value|
135
+ |:--|:--|
136
+ |Type Name|\`Script\`|
137
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
138
+
139
+ \*ExtractedTypeTable: Could not extract "Script" from "./packages/core/src/libs/script-loader/types.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
207
140
 
208
141
  ### XPixelEvent
209
142
 
210
- |Property|Type|Description|Default|Required|
211
- |:--|:--|:--|:--|:--:|
212
- |value|number \|undefined|Total value of the conversion event (ex: $ value of the transaction in case of a purchase, etc.)|-|Optional|
213
- |currency|string \|undefined|Currency of the conversion event ISO 4217 code (ex: USD, EUR, JPY, etc.)|-|Optional|
214
- |conversion\_id|string \|undefined|Unique identifier for the event that can be used for deduplication purposes|-|Optional|
215
- |search\_string|string \|undefined|Search string of the conversion event|-|Optional|
216
- |description|string \|undefined|Description of the conversion event|-|Optional|
217
- |twclid|string \|undefined|twclid of the conversion event The X Pixel already automatically passes twclid from URL or first-party cookie. This parameter can be optionally used to force attribution to a certain ad click.|-|Optional|
218
- |status|"started" \|"completed" \|undefined|Status of the conversion event Should be set to values like "started" or "completed".|-|Optional|
219
- |email\_address|string \|undefined|Email address used for user matching. The X Pixel hashes this value before transmission.|-|Optional|
220
- |phone\_number|string \|undefined|Phone number used for user matching. Include country code in E.164 format (for example, +11234567890). The X Pixel hashes this value before transmission.|-|Optional|
221
- |contents|XPixelContent \|undefined|Content/products associated with the conversion event|-|Optional|
143
+ |Property|Value|
144
+ |:--|:--|
145
+ |Type Name|\`XPixelEvent\`|
146
+ |Source Path|\`./packages/scripts/src/vendors/ads-and-pixels/x-pixel.ts\`|
147
+
148
+ \*ExtractedTypeTable: Could not extract "XPixelEvent" from "./packages/scripts/src/vendors/ads-and-pixels/x-pixel.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
222
149
 
223
150
  ### XPixelContent
224
151
 
225
- |Property|Type|Description|Default|Required|
226
- |:--|:--|:--|:--|:--:|
227
- |content\_type|[string \|undefined](https://www.google.com/basepages/producttype/taxonomy.en-US.txt)|Type of the content|-|Optional|
228
- |content\_id|string|ID of the content For product catalog users: please pass SKU For all other users: Please pass Global Trade Item Number (GTIN) if available, otherwise pass SKU|-|✅ Required|
229
- |content\_name|string \|undefined|Name of a product or service|-|Optional|
230
- |content\_price|number \|undefined|Price of a product or service|-|Optional|
231
- |num\_items|number \|undefined|Quantity of the content|-|Optional|
232
- |content\_group\_id|string \|undefined|ID associated with a group of product variants|-|Optional|
152
+ |Property|Value|
153
+ |:--|:--|
154
+ |Type Name|\`XPixelContent\`|
155
+ |Source Path|\`./packages/scripts/src/vendors/ads-and-pixels/x-pixel.ts\`|
156
+
157
+ \*ExtractedTypeTable: Could not extract "XPixelContent" from "./packages/scripts/src/vendors/ads-and-pixels/x-pixel.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*