@c15t/nextjs 2.0.0-rc.0 → 2.0.0-rc.10

package/docs/integrations/posthog.md

@@ -0,0 +1,199 @@
+---
+title: PostHog
+description: PostHog is an open-source product analytics platform for tracking user behavior, session replays, feature flags, and A/B testing. It supports cookieless tracking, allowing analytics to continue even without cookie consent.
+lastModified: 2026-04-08
+
+icon: posthog
+---
+PostHog is an open-source product analytics platform that helps you understand user behavior, track events, and analyze product usage. Unlike traditional analytics tools, PostHog supports both cookieless and cookie-based tracking. This means you can sync c15t with PostHog and continue collecting analytics even when users haven't given consent—PostHog simply operates in cookieless mode until consent is granted.
+
+## PostHog SDK Implementation
+
+This is the recommended approach if you're using the Posthog JS SDK, this is commonly used in React projects.
+
+### Adding the PostHog SDK to c15t
+
+1. **Initialize Posthog** When you initialize posthog make sure to set cookieless\_mode to on\_reject.
+
+   ```ts
+   posthog.init("phc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", {
+     api_host: "https://eu.i.posthog.com",
+     defaults: "2025-05-24",
+     cookieless_mode: 'on_reject'
+   })
+
+   posthog.opt_out_capturing() // Avoids accidental tracking without consent till c15t has loaded
+   ```
+
+2. **Sync settled consent once, then subscribe to real changes** The recommended PostHog SDK approach uses two phases: run one initial sync after c15t has finished resolving consent, then subscribe to future real preference changes with subscribeToConsentChanges().
+
+   > ℹ️ Info:
+   >
+   > See the integration overview for how to wrap this in your framework (React or Next.js). Pass the callbacks option to your ConsentManagerProvider the same way you would pass scripts.
+
+   ```ts
+   import { getOrCreateConsentRuntime } from 'c15t';
+   import { posthog } from 'posthog-js';
+
+   function syncPostHogMeasurementConsent(hasMeasurementConsent: boolean) {
+     if (hasMeasurementConsent) {
+       posthog.opt_in_capturing();
+     } else {
+       posthog.opt_out_capturing();
+     }
+   }
+
+   const runtime = getOrCreateConsentRuntime({
+     mode: 'hosted',
+     callbacks: {
+       onBannerFetched() {
+         syncPostHogMeasurementConsent(
+           runtime.consentStore.getState().has('measurement')
+         );
+       },
+     },
+   });
+
+   runtime.consentStore
+     .getState()
+     .subscribeToConsentChanges(({ allowedCategories }) => {
+       syncPostHogMeasurementConsent(
+         allowedCategories.includes('measurement')
+       );
+     });
+   ```
+
+   > ℹ️ Info:
+   >
+   > Avoid using onConsentSet plus manual deduplication for PostHog. subscribeToConsentChanges() already gives you the exact change-only semantics most analytics SDKs need.
+
+## PostHog Script Implementation
+
+If you want to load posthog via a script tag it's recommended to use this approach.
+
+By default c15t will always load the script regardless of consent. This is because the script has built-in functionality to opt into and out of tracking based on consent.
+
+1. **Initialize Posthog** This script does not load the Posthog script, it only syncs the consent state with Posthog via the Posthog JS SDK.
+
+   This is due to Posthog's use of cookieless tracking. However, you need to set cookieless\_mode to on\_reject when initializing Posthog.
+
+   ```ts
+   posthog.init("phc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", {
+     api_host: "https://eu.i.posthog.com",
+     defaults: "2025-05-24",
+     // PostHog will not set any cookies until the user has given consent
+     cookieless_mode: 'on_reject'
+   })
+   ```
+
+2. **Adding the script to c15t**
+
+   > ℹ️ Info:
+   >
+   > See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).
+
+   ```ts
+   import { posthog } from '@c15t/scripts/posthog';
+
+   posthog({
+     id: 'phc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+     apiHost: 'https://eu.i.posthog.com',
+     scriptUrl: 'https://eu-assets.i.posthog.com/static/array.js',
+     initOptions: {
+       api_host: 'https://eu.i.posthog.com',
+       ui_host: 'https://eu.i.posthog.com',
+       autocapture: false,
+       person_profiles: 'identified_only',
+     }
+   })
+   ```
+
+## Types
+
+### PosthogConsentOptions
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|Your posthog id, begins with 'phc\_'.|-|✅ Required|
+|apiHost|string \|undefined|Your posthog api host.|'https\://eu.i.posthog.com'|Optional|
+|scriptUrl|string \|undefined|The PostHog array loader URL.|-|Optional|
+|initOptions|Record\<string, unknown> \|undefined|PostHog init options passed to \`posthog.init(...)\`.|-|Optional|
+
+### Script
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|Unique identifier for the script|-|✅ Required|
+|src|string \|undefined|URL of the script to load|-|Optional|
+|textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
+|category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
+|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|
+|persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
+|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|
+|fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
+|attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
+|async|boolean \|undefined|Whether to use async loading|-|Optional|
+|defer|boolean \|undefined|Whether to defer script loading|-|Optional|
+|nonce|string \|undefined|Content Security Policy nonce|-|Optional|
+|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|
+|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|
+|onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
+|onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
+|onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
+|onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
+|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|
+|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|
+|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|
+|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|
+
+#### `onBeforeLoad`
+
+Callback executed before the script is loaded
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onLoad`
+
+Callback executed when the script loads successfully
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onError`
+
+Callback executed if the script fails to load
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onConsentChange`
+
+Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|

package/docs/integrations/tiktok-pixel.md

@@ -0,0 +1,113 @@
+---
+title: TikTok Pixel
+description: Measure ad performance and build audiences for TikTok advertising campaigns.
+lastModified: 2025-09-24
+
+icon: tiktok
+---
+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. By default, c15t loads this script based on `marketing` consent.
+
+This script persists after consent is revoked because it has built-in consent management. When consent changes, c15t updates TikTok's internal consent state rather than removing the script entirely.
+
+## Implementation
+
+### Adding the script to c15t
+
+> ℹ️ **Info:**
+> See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).
+
+```ts
+import { tiktokPixel } from '@c15t/scripts/tiktok-pixel';
+
+tiktokPixel({
+  pixelId: '123456789012345',
+})
+```
+
+## Types
+
+### TikTokPixelOptions
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|pixelId|string|Your TikTok Pixel ID|-|✅ Required|
+|scriptSrc|string \|undefined|TikTok Pixel loader base URL.|-|Optional|
+
+### Script
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|Unique identifier for the script|-|✅ Required|
+|src|string \|undefined|URL of the script to load|-|Optional|
+|textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
+|category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
+|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|
+|persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
+|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|
+|fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
+|attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
+|async|boolean \|undefined|Whether to use async loading|-|Optional|
+|defer|boolean \|undefined|Whether to defer script loading|-|Optional|
+|nonce|string \|undefined|Content Security Policy nonce|-|Optional|
+|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|
+|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|
+|onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
+|onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
+|onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
+|onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
+|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|
+|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|
+|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|
+|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|
+
+#### `onBeforeLoad`
+
+Callback executed before the script is loaded
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onLoad`
+
+Callback executed when the script loads successfully
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onError`
+
+Callback executed if the script fails to load
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onConsentChange`
+
+Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|

package/docs/integrations/x-pixel.md

@@ -0,0 +1,143 @@
+---
+title: X Pixel (Twitter Pixel)
+description: Track conversions and build audiences for advertising campaigns on X (formerly Twitter).
+lastModified: 2025-09-24
+
+icon: x
+---
+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. By default, c15t loads this script based on `marketing` consent.
+
+## Implementation
+
+> ℹ️ **Info:**
+> See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).
+
+```ts
+import { xPixel } from '@c15t/scripts/x-pixel';
+
+xPixel({
+  id: '123456789012345',
+})
+```
+
+## xPixelEvent
+
+You can use the `xPixelEvent` function to track events. This is a wrapper around the `twq` function that the X Pixel script uses.
+
+```ts
+import { xPixelEvent } from '@c15t/scripts/x-pixel';
+
+xPixelEvent('tw-xxxx-xxxx', { value: 10.00, currency: 'USD' });
+```
+
+## Types
+
+### XPixelOptions
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|pixelId|string|Your X Pixel ID|-|✅ Required|
+|scriptSrc|string \|undefined|X Pixel loader URL.|-|Optional|
+
+### Script
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|Unique identifier for the script|-|✅ Required|
+|src|string \|undefined|URL of the script to load|-|Optional|
+|textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
+|category|HasCondition\<AllConsentNames>|Consent category or condition required to load this script|-|✅ Required|
+|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|
+|persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
+|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|
+|fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
+|attributes|Record\<string, string> \|undefined|Additional attributes to add to the script element|-|Optional|
+|async|boolean \|undefined|Whether to use async loading|-|Optional|
+|defer|boolean \|undefined|Whether to defer script loading|-|Optional|
+|nonce|string \|undefined|Content Security Policy nonce|-|Optional|
+|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|
+|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|
+|onBeforeLoad|Object \|undefined|Callback executed before the script is loaded|-|Optional|
+|onLoad|Object \|undefined|Callback executed when the script loads successfully|-|Optional|
+|onError|Object \|undefined|Callback executed if the script fails to load|-|Optional|
+|onConsentChange|Object \|undefined|Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.|-|Optional|
+|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|
+|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|
+|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|
+|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|
+
+#### `onBeforeLoad`
+
+Callback executed before the script is loaded
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onLoad`
+
+Callback executed when the script loads successfully
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onError`
+
+Callback executed if the script fails to load
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+#### `onConsentChange`
+
+Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|The original script ID|-|✅ Required|
+|elementId|string|The actual DOM element ID used (anonymized if enabled)|-|✅ Required|
+|hasConsent|boolean|Has consent|-|✅ Required|
+|consents|ConsentState|The current consent state|-|✅ Required|
+|element|HTMLScriptElement \|undefined|The script element (for load/error callbacks) Will be undefined for callback-only scripts|-|Optional|
+|error|Error \|undefined|Error information (for error callbacks)|-|Optional|
+
+### XPixelEvent
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|value|number \|undefined|Total value of the conversion event (ex: $ value of the transaction in case of a purchase, etc.)|-|Optional|
+|currency|string \|undefined|Currency of the conversion event ISO 4217 code (ex: USD, EUR, JPY, etc.)|-|Optional|
+|conversion\_id|string \|undefined|Unique identifier for the event that can be used for deduplication purposes|-|Optional|
+|search\_string|string \|undefined|Search string of the conversion event|-|Optional|
+|description|string \|undefined|Description of the conversion event|-|Optional|
+|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|
+|status|boolean \|undefined|Status of the conversion event|-|Optional|
+|contents|XPixelContent \|undefined|Content/products associated with the conversion event|-|Optional|
+
+### XPixelContent
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|content\_type|[string \|undefined](https://www.google.com/basepages/producttype/taxonomy.en-US.txt)|Type of the content|-|Optional|
+|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|
+|content\_name|string \|undefined|Name of a product or service|-|Optional|
+|content\_price|number \|undefined|Price of a product or service|-|Optional|
+|num\_items|number \|undefined|Quantity of the content|-|Optional|
+|content\_group\_id|string \|undefined|ID associated with a group of product variants|-|Optional|

package/docs/internationalization.md

@@ -0,0 +1,197 @@
+---
+title: Internationalization
+description: Translate consent UI into 30+ languages with built-in translations, custom overrides, and automatic browser language detection.
+---
+c15t ships with built-in translations for 30+ languages via the `@c15t/translations` package. Language detection happens automatically based on the browser's language preference, and you can override or extend translations for any language.
+
+In c15t v2, the preferred config shape is `i18n` with `locale`, `detectBrowserLanguage`, and `messages`.
+
+There are two ways c15t can load translations: client-side or server-side.
+
+|Server-side|Client-side|
+|--|--|
+|The best way to reduce bundle size and improve performance. We can detect the user's language based on the browser's language settings, allowing for the most accurate translations. By default, when using a [inth.com](https://inth.com) hosted instance, [these languages](https://github.com/c15t/c15t/tree/main/packages/translations/src/translations) are supported.|Bundled with the application allowing for multiple languages to be supported without the need for a backend. The more translations you have, the larger the bundle size will be, which may impact the performance of your application.|
+
+## Basic Configuration
+
+Pass custom translations via the `i18n` option:
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/nextjs';
+
+export default function ConsentManager({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        i18n: {
+          locale: 'en',
+          messages: {
+            de: {
+              cookieBanner: {
+                title: 'Datenschutzeinstellungen',
+                description: 'Wir verwenden Cookies, um Ihnen das beste Erlebnis zu bieten.',
+              },
+              common: {
+                acceptAll: 'Alle akzeptieren',
+                rejectAll: 'Alle ablehnen',
+                customize: 'Anpassen',
+                save: 'Speichern',
+              },
+            },
+          },
+        },
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+Custom translations are deep-merged with built-in defaults - you only need to override the keys you want to change.
+
+## Translation Package Imports
+
+Use the import path that matches your use case:
+
+* `@c15t/translations`: types, utilities, and `enTranslations` only (smallest client bundle)
+* `@c15t/translations/en`: English-only translation object
+* `@c15t/translations/all`: full `baseTranslations` map for all bundled locales
+
+If you bundle translations client-side and need multiple languages, import from `@c15t/translations/all` explicitly:
+
+```tsx
+import { baseTranslations } from '@c15t/translations/all';
+
+const translations = {
+  en: baseTranslations.en,
+  de: baseTranslations.de,
+  fr: baseTranslations.fr,
+};
+```
+
+## Translation Sections
+
+The `Translations` object is organized into sections:
+
+|Section|Controls|
+|--|--|
+|`common`|Shared button labels: acceptAll, rejectAll, customize, save|
+|`cookieBanner`|Banner title and description|
+|`consentManagerDialog`|Dialog title and description|
+|`consentTypes`|Per-category title and description (keyed by AllConsentNames)|
+|`frame`|Frame placeholder title and button text (supports `{category}` placeholder)|
+|`legalLinks`|Privacy policy, cookie policy, terms of service link text|
+|`iab`|IAB TCF banner, preference center, vendor list translations|
+
+## Reading Translations
+
+Use the `useTranslations()` hook to access the current language's translations:
+
+```tsx
+import { useTranslations } from '@c15t/nextjs';
+
+function CustomBanner() {
+  const translations = useTranslations();
+
+  return (
+    <div>
+      <h2>{translations.cookieBanner.title}</h2>
+      <p>{translations.cookieBanner.description}</p>
+    </div>
+  );
+}
+```
+
+## Changing Language
+
+Switch the active language at runtime with `setLanguage()`:
+
+```tsx
+import { useConsentManager } from '@c15t/nextjs';
+
+function LanguageSwitcher() {
+  const { setLanguage } = useConsentManager();
+
+  return (
+    <select onChange={(e) => setLanguage(e.target.value)}>
+      <option value="en">English</option>
+      <option value="de">Deutsch</option>
+      <option value="fr">Fran&ccedil;ais</option>
+      <option value="es">Espa&ntilde;ol</option>
+    </select>
+  );
+}
+```
+
+`setLanguage()` re-fetches the consent banner to get server-resolved translations for the new language.
+
+## Automatic Language Detection
+
+By default, c15t detects the browser's language (`navigator.language`) and selects the closest matching translation. If custom `messages` are configured, fallback stays within your configured languages before using `locale` (or `'en'`) as the preferred fallback language.
+
+When backend policy packs use `i18n.messageProfile`, the active language pool comes only from that resolved profile.
+
+Example: if your Europe profile defines `en`, `fr`, and `de`, and your default profile defines `en`, `es`, and `pt`, a Europe visitor can resolve to `en`, `fr`, or `de`, but not `es`, `pt`, or `zh`.
+
+Use profile-local `fallbackLanguage` inside backend `i18n.messages` to choose which configured language a policy profile should fall back to when the browser asks for an unsupported locale.
+
+Disable auto-detection to always use `locale`:
+
+```tsx
+i18n: {
+  locale: 'de',
+  detectBrowserLanguage: false,
+  messages: { ... },
+}
+```
+
+If you need a policy to always use one specific language regardless of browser preference, set `policy.i18n.language` on the backend policy pack.
+
+## Custom Consent Type Labels
+
+Override the title and description for individual consent categories:
+
+```tsx
+i18n: {
+  messages: {
+    en: {
+      consentTypes: {
+        measurement: {
+          title: 'Analytics & Performance',
+          description: 'Help us understand how visitors interact with our site.',
+        },
+        marketing: {
+          title: 'Advertising',
+          description: 'Used to deliver relevant ads and measure campaign effectiveness.',
+        },
+      },
+    },
+  },
+}
+```
+
+## Legacy `translations` Compatibility
+
+The legacy syntax is still supported in 2.0 for RC compatibility:
+
+```tsx
+// Legacy (still supported)
+translations: {
+  defaultLanguage: 'en',
+  disableAutoLanguageSwitch: true,
+  translations: { ... },
+}
+
+// Preferred in v2
+i18n: {
+  locale: 'en',
+  detectBrowserLanguage: false,
+  messages: { ... },
+}
+```
+
+If both are provided, `i18n` takes precedence.