@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
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: Intercom
3
3
  description: Bootstrap Intercom settings and load the messenger widget bundle.
4
- lastModified: 2026-05-12
4
+ group: integrations
5
5
  icon: intercom
6
6
  ---
7
7
  Intercom adds the Intercom messenger widget and queues early `Intercom(...)`
@@ -127,88 +127,18 @@ only pass client-safe values through `settings`.
127
127
 
128
128
  ### IntercomOptions
129
129
 
130
- |Property|Type|Description|Default|Required|
131
- |:--|:--|:--|:--|:--:|
132
- |appId|string|Your Intercom app ID.|-|✅ Required|
133
- |apiBase|IntercomApiBase \|undefined|Regional Intercom API base.|'https\://api-iam.intercom.io'|Optional|
134
- |settings|IntercomCustomSettings \|undefined|Additional serializable Intercom settings merged into \`window\.intercomSettings\`.|-|Optional|
135
- |scriptSrc|string \|undefined|Intercom loader URL.|-|Optional|
130
+ |Property|Value|
131
+ |:--|:--|
132
+ |Type Name|\`IntercomOptions\`|
133
+ |Source Path|\`./packages/scripts/src/vendors/functional/intercom.ts\`|
134
+
135
+ \*ExtractedTypeTable: Could not extract "IntercomOptions" from "./packages/scripts/src/vendors/functional/intercom.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
136
136
 
137
137
  ### Script
138
138
 
139
- |Property|Type|Description|Default|Required|
140
- |:--|:--|:--|:--|:--:|
141
- |id|string|Unique identifier for the script|-|✅ Required|
142
- |src|string \|undefined|URL of the script to load|-|Optional|
143
- |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
144
- |category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
145
- |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|
146
- |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
147
- |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|
148
- |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
149
- |attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
150
- |async|boolean \|undefined|Whether to use async loading|-|Optional|
151
- |defer|boolean \|undefined|Whether to defer script loading|-|Optional|
152
- |nonce|string \|undefined|Content Security Policy nonce|-|Optional|
153
- |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|
154
- |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|
155
- |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
156
- |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
157
- |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
158
- |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
159
- |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|
160
- |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|
161
- |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|
162
- |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|
163
-
164
- #### `onBeforeLoad`
165
-
166
- Callback executed before the script is loaded
167
-
168
- |Property|Type|Description|Default|Required|
169
- |:--|:--|:--|:--|:--:|
170
- |id|string|The original script ID|-|✅ Required|
171
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
172
- |hasConsent|boolean|Has consent|-|✅ Required|
173
- |consents|ConsentState|The current consent state|-|✅ Required|
174
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
175
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
176
-
177
- #### `onLoad`
178
-
179
- Callback executed when the script loads successfully
180
-
181
- |Property|Type|Description|Default|Required|
182
- |:--|:--|:--|:--|:--:|
183
- |id|string|The original script ID|-|✅ Required|
184
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
185
- |hasConsent|boolean|Has consent|-|✅ Required|
186
- |consents|ConsentState|The current consent state|-|✅ Required|
187
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
188
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
189
-
190
- #### `onError`
191
-
192
- Callback executed if the script fails to load
193
-
194
- |Property|Type|Description|Default|Required|
195
- |:--|:--|:--|:--|:--:|
196
- |id|string|The original script ID|-|✅ Required|
197
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
198
- |hasConsent|boolean|Has consent|-|✅ Required|
199
- |consents|ConsentState|The current consent state|-|✅ Required|
200
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
201
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
202
-
203
- #### `onConsentChange`
204
-
205
- Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
206
-
207
- |Property|Type|Description|Default|Required|
208
- |:--|:--|:--|:--|:--:|
209
- |id|string|The original script ID|-|✅ Required|
210
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
211
- |hasConsent|boolean|Has consent|-|✅ Required|
212
- |consents|ConsentState|The current consent state|-|✅ Required|
213
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
214
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
139
+ |Property|Value|
140
+ |:--|:--|
141
+ |Type Name|\`Script\`|
142
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
143
+
144
+ \*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.\*
@@ -1,8 +1,9 @@
1
1
  ---
2
2
  title: LinkedIn Insights
3
- description: Track conversions and build matched audiences for LinkedIn advertising campaigns.
4
- lastModified: 2026-05-11
3
+ description: Track conversions and build matched audiences for LinkedIn
4
+ advertising campaigns.
5
5
  icon: linkedin
6
+ group: integrations
6
7
  ---
7
8
  LinkedIn Insight Tag is LinkedIn's conversion tracking and audience matching tool for LinkedIn advertising campaigns. It tracks website actions, measures ad performance, builds website retargeting audiences, and provides aggregate audience insights about visitors from LinkedIn member accounts.
8
9
 
@@ -143,86 +144,18 @@ LinkedIn validates the tag after an associated domain or URL receives traffic. S
143
144
 
144
145
  ### LinkedInInsightsOptions
145
146
 
146
- |Property|Type|Description|Default|Required|
147
- |:--|:--|:--|:--|:--:|
148
- |id|string|Your LinkedIn Insight Tag partner ID. LinkedIn shows this in Campaign Manager under Data -> Signals manager -> Insight Tag.|-|✅ Required|
149
- |scriptSrc|string \|undefined|LinkedIn Insight Tag loader URL.|-|Optional|
147
+ |Property|Value|
148
+ |:--|:--|
149
+ |Type Name|\`LinkedInInsightsOptions\`|
150
+ |Source Path|\`./packages/scripts/src/vendors/ads-and-pixels/linkedin-insights.ts\`|
151
+
152
+ \*ExtractedTypeTable: Could not extract "LinkedInInsightsOptions" from "./packages/scripts/src/vendors/ads-and-pixels/linkedin-insights.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
150
153
 
151
154
  ### Script
152
155
 
153
- |Property|Type|Description|Default|Required|
154
- |:--|:--|:--|:--|:--:|
155
- |id|string|Unique identifier for the script|-|✅ Required|
156
- |src|string \|undefined|URL of the script to load|-|Optional|
157
- |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
158
- |category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
159
- |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|
160
- |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
161
- |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|
162
- |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
163
- |attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
164
- |async|boolean \|undefined|Whether to use async loading|-|Optional|
165
- |defer|boolean \|undefined|Whether to defer script loading|-|Optional|
166
- |nonce|string \|undefined|Content Security Policy nonce|-|Optional|
167
- |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|
168
- |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|
169
- |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
170
- |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
171
- |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
172
- |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
173
- |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|
174
- |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|
175
- |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|
176
- |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|
177
-
178
- #### `onBeforeLoad`
179
-
180
- Callback executed before the script is loaded
181
-
182
- |Property|Type|Description|Default|Required|
183
- |:--|:--|:--|:--|:--:|
184
- |id|string|The original script ID|-|✅ Required|
185
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
186
- |hasConsent|boolean|Has consent|-|✅ Required|
187
- |consents|ConsentState|The current consent state|-|✅ Required|
188
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
189
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
190
-
191
- #### `onLoad`
192
-
193
- Callback executed when the script loads successfully
194
-
195
- |Property|Type|Description|Default|Required|
196
- |:--|:--|:--|:--|:--:|
197
- |id|string|The original script ID|-|✅ Required|
198
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
199
- |hasConsent|boolean|Has consent|-|✅ Required|
200
- |consents|ConsentState|The current consent state|-|✅ Required|
201
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
202
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
203
-
204
- #### `onError`
205
-
206
- Callback executed if the script fails to load
207
-
208
- |Property|Type|Description|Default|Required|
209
- |:--|:--|:--|:--|:--:|
210
- |id|string|The original script ID|-|✅ Required|
211
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
212
- |hasConsent|boolean|Has consent|-|✅ Required|
213
- |consents|ConsentState|The current consent state|-|✅ Required|
214
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
215
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
216
-
217
- #### `onConsentChange`
218
-
219
- Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
220
-
221
- |Property|Type|Description|Default|Required|
222
- |:--|:--|:--|:--|:--:|
223
- |id|string|The original script ID|-|✅ Required|
224
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
225
- |hasConsent|boolean|Has consent|-|✅ Required|
226
- |consents|ConsentState|The current consent state|-|✅ Required|
227
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
228
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
156
+ |Property|Value|
157
+ |:--|:--|
158
+ |Type Name|\`Script\`|
159
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
160
+
161
+ \*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.\*
@@ -0,0 +1,175 @@
1
+ ---
2
+ title: LogRocket
3
+ description: Session replay and monitoring loaded after measurement consent with
4
+ LogRocket's browser SDK.
5
+ group: integrations
6
+ icon: logrocket
7
+ ---
8
+ [LogRocket](https://logrocket.com) records session replay, frontend errors, network activity, console logs, and user behavior so product and engineering teams can debug production sessions. c15t loads `LogRocket.min.js` with `crossorigin="anonymous"` and then calls `window.LogRocket.init('org-slug/app-slug')`.
9
+
10
+ ## Integrate with c15t
11
+
12
+ **React**
13
+
14
+ ```tsx
15
+ import { type ReactNode } from 'react';
16
+ import { ConsentManagerProvider } from '@c15t/react';
17
+ import { logRocket } from '@c15t/scripts/logrocket';
18
+
19
+ const scripts = [
20
+ logRocket({
21
+ appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
22
+ initOptions: {
23
+ dom: {
24
+ inputSanitizer: true,
25
+ },
26
+ },
27
+ }),
28
+ ];
29
+
30
+ export function ConsentProvider({ children }: { children: ReactNode }) {
31
+ return (
32
+ <ConsentManagerProvider
33
+ options={{
34
+ mode: 'hosted',
35
+ backendURL: 'https://your-instance.c15t.dev',
36
+ scripts,
37
+ }}
38
+ >
39
+ {children}
40
+ </ConsentManagerProvider>
41
+ );
42
+ }
43
+ ```
44
+
45
+ **Next.js**
46
+
47
+ ```tsx
48
+ 'use client';
49
+
50
+ import { type ReactNode } from 'react';
51
+ import { ConsentManagerProvider } from '@c15t/nextjs';
52
+ import { logRocket } from '@c15t/scripts/logrocket';
53
+
54
+ const scripts = [
55
+ logRocket({
56
+ appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
57
+ initOptions: {
58
+ dom: {
59
+ inputSanitizer: true,
60
+ },
61
+ },
62
+ }),
63
+ ];
64
+
65
+ export function ConsentProvider({ children }: { children: ReactNode }) {
66
+ return (
67
+ <ConsentManagerProvider
68
+ options={{
69
+ mode: 'hosted',
70
+ backendURL: '/api/c15t',
71
+ scripts,
72
+ }}
73
+ >
74
+ {children}
75
+ </ConsentManagerProvider>
76
+ );
77
+ }
78
+ ```
79
+
80
+ **JavaScript**
81
+
82
+ ```ts
83
+ import { getOrCreateConsentRuntime } from 'c15t';
84
+ import { logRocket } from '@c15t/scripts/logrocket';
85
+
86
+ getOrCreateConsentRuntime({
87
+ mode: 'hosted',
88
+ backendURL: 'https://your-instance.c15t.dev',
89
+ scripts: [
90
+ logRocket({
91
+ appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
92
+ initOptions: {
93
+ dom: {
94
+ inputSanitizer: true,
95
+ },
96
+ },
97
+ }),
98
+ ],
99
+ });
100
+ ```
101
+
102
+ ## How c15t loads it
103
+
104
+ * **Category:** `measurement` (Analytics)
105
+ * **Loads when:** measurement consent is granted
106
+ * **On revocation:** unloaded - c15t removes the script element from the DOM. LogRocket does not document a web SDK consent opt-out or stop-recording API equivalent to Clarity or Mixpanel consent methods, and removing the loader does not stop an already-initialized recorder in the current page view. Revocation fully takes effect on the next page load.
107
+
108
+ The helper maps the script-tag snippet into the manifest engine:
109
+
110
+ ```ts
111
+ logRocket({
112
+ appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
113
+ })
114
+ ```
115
+
116
+ It loads `https://cdn.logrocket.io/LogRocket.min.js` with `crossorigin="anonymous"` and calls:
117
+
118
+ ```ts
119
+ window.LogRocket?.init('YOUR_ORG_SLUG/YOUR_APP_SLUG', initOptions)
120
+ ```
121
+
122
+ after the script load event. `appId` is required and must be in `org/app` format.
123
+
124
+ ## Privacy and sanitization
125
+
126
+ LogRocket captures user behavior for replay, so configure sanitization before deploying it. LogRocket documents DOM redaction with `data-private`, automatic text/input/image sanitization, and network request/response sanitizers. Password fields are never recorded, but other sensitive inputs, DOM nodes, network payloads, Redux state, and Redux actions should be explicitly excluded.
127
+
128
+ Pass JSON-serializable LogRocket init options as `initOptions`:
129
+
130
+ ```ts
131
+ logRocket({
132
+ appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
133
+ initOptions: {
134
+ dom: {
135
+ inputSanitizer: true,
136
+ textSanitizer: true,
137
+ imageSanitizer: true,
138
+ privateClassNameBlocklist: ['private-profile'],
139
+ privateAttributeBlocklist: ['data-hide-from-replay'],
140
+ },
141
+ },
142
+ })
143
+ ```
144
+
145
+ Only pass values that can safely cross the manifest boundary. Avoid functions, class instances, prototypes, `Map`, `Set`, or other non-JSON types unless you are constructing a manual `Script` outside the manifest helper. LogRocket also supports function-based network sanitizers; use a manual `Script` if you need those callbacks.
146
+
147
+ To proxy or self-host the loader, pass a custom URL. LogRocket's proxy setup also chain-loads a logger bundle, so set `asyncScriptUrl` as well — otherwise the async bundle is still fetched from LogRocket's CDN:
148
+
149
+ ```ts
150
+ logRocket({
151
+ appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
152
+ scriptUrl: 'https://analytics.example.com/LogRocket.min.js',
153
+ asyncScriptUrl: 'https://analytics.example.com/logger.min.js',
154
+ })
155
+ ```
156
+
157
+ ## Types
158
+
159
+ ### LogRocketOptions
160
+
161
+ |Property|Value|
162
+ |:--|:--|
163
+ |Type Name|\`LogRocketOptions\`|
164
+ |Source Path|\`./packages/scripts/src/vendors/analytics/logrocket.ts\`|
165
+
166
+ \*ExtractedTypeTable: Could not extract "LogRocketOptions" from "./packages/scripts/src/vendors/analytics/logrocket.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
167
+
168
+ ### Script
169
+
170
+ |Property|Value|
171
+ |:--|:--|
172
+ |Type Name|\`Script\`|
173
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
174
+
175
+ \*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.\*
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: Matomo Analytics
3
3
  description: Load Matomo with c15t and keep Matomo's queue aligned with measurement consent.
4
- lastModified: 2026-05-10
4
+ group: integrations
5
5
  icon: matomo
6
6
  ---
7
7
  Matomo gives you privacy-focused web analytics with self-hosted and cloud deployment options. The `matomoAnalytics()` helper sets up Matomo's `_paq` queue, points it at your tracker, and can queue consent-aware commands before the vendor bundle loads.
@@ -154,93 +154,18 @@ if (consentStore.getState().has('measurement')) {
154
154
 
155
155
  ### MatomoAnalyticsOptions
156
156
 
157
- |Property|Type|Description|Default|Required|
158
- |:--|:--|:--|:--|:--:|
159
- |siteId|string \|number \|undefined|Your Matomo site ID.|-|Optional|
160
- |matomoUrl|string \|undefined|Your Matomo base URL, for example \`https\://analytics.example.com\`.|-|Optional|
161
- |cloudId|string \|undefined|Your Matomo Cloud identifier, for example \`my-site.matomo.cloud\`.|-|Optional|
162
- |trackerUrl|string \|undefined|Optional explicit tracker endpoint override.|-|Optional|
163
- |scriptUrl|string \|undefined|Optional explicit script URL override.|-|Optional|
164
- |enableLinkTracking|boolean \|undefined|Queue \`enableLinkTracking\`.|-|Optional|
165
- |disableCookies|boolean \|undefined|Queue \`disableCookies\`.|-|Optional|
166
- |trackPageView|boolean \|undefined|Queue an initial \`trackPageView\`.|-|Optional|
167
- |defaultConsent|"required" \|"given" \|undefined|Default Matomo consent state (\`required\` blocks, \`given\` starts enabled).|-|Optional|
157
+ |Property|Value|
158
+ |:--|:--|
159
+ |Type Name|\`MatomoAnalyticsOptions\`|
160
+ |Source Path|\`./packages/scripts/src/vendors/analytics/matomo-analytics.ts\`|
161
+
162
+ \*ExtractedTypeTable: Could not extract "MatomoAnalyticsOptions" from "./packages/scripts/src/vendors/analytics/matomo-analytics.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
168
163
 
169
164
  ### Script
170
165
 
171
- |Property|Type|Description|Default|Required|
172
- |:--|:--|:--|:--|:--:|
173
- |id|string|Unique identifier for the script|-|✅ Required|
174
- |src|string \|undefined|URL of the script to load|-|Optional|
175
- |textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
176
- |category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
177
- |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|
178
- |persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
179
- |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|
180
- |fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
181
- |attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
182
- |async|boolean \|undefined|Whether to use async loading|-|Optional|
183
- |defer|boolean \|undefined|Whether to defer script loading|-|Optional|
184
- |nonce|string \|undefined|Content Security Policy nonce|-|Optional|
185
- |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|
186
- |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|
187
- |onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
188
- |onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
189
- |onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
190
- |onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
191
- |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|
192
- |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|
193
- |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|
194
- |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|
195
-
196
- #### `onBeforeLoad`
197
-
198
- Callback executed before the script is loaded
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
- #### `onLoad`
210
-
211
- Callback executed when the script loads successfully
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|
221
-
222
- #### `onError`
223
-
224
- Callback executed if the script fails to load
225
-
226
- |Property|Type|Description|Default|Required|
227
- |:--|:--|:--|:--|:--:|
228
- |id|string|The original script ID|-|✅ Required|
229
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
230
- |hasConsent|boolean|Has consent|-|✅ Required|
231
- |consents|ConsentState|The current consent state|-|✅ Required|
232
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
233
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
234
-
235
- #### `onConsentChange`
236
-
237
- Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
238
-
239
- |Property|Type|Description|Default|Required|
240
- |:--|:--|:--|:--|:--:|
241
- |id|string|The original script ID|-|✅ Required|
242
- |elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
243
- |hasConsent|boolean|Has consent|-|✅ Required|
244
- |consents|ConsentState|The current consent state|-|✅ Required|
245
- |element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
246
- |error|Error \|undefined|Error information (for error callbacks)|-|Optional|
166
+ |Property|Value|
167
+ |:--|:--|
168
+ |Type Name|\`Script\`|
169
+ |Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
170
+
171
+ \*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.\*