npm - @c15t/nextjs - Versions diffs - 2.0.0-rc.4 → 2.0.0-rc.6 - Mend

@c15t/nextjs 2.0.0-rc.4 → 2.0.0-rc.6

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 (87) hide show

package/dist/headless.cjs +1 -1
package/dist/iab/styles.css +1 -0
package/dist/index.cjs +1 -1
package/dist/index.js +1 -1
package/dist/libs/browser-initial-data.cjs +1 -0
package/dist/libs/browser-initial-data.js +1 -0
package/dist/libs/initial-data.cjs +1 -1
package/dist/libs/initial-data.js +1 -1
package/dist/styles.css +1 -0
package/dist/types.cjs +1 -1
package/dist/version.cjs +1 -1
package/dist/version.js +1 -1
package/dist-types/headless.d.ts +1 -0
package/{dist → dist-types}/index.d.ts +4 -3
package/dist-types/libs/browser-initial-data.d.ts +9 -0
package/{dist → dist-types}/libs/initial-data.d.ts +1 -2
package/dist-types/types.d.ts +38 -0
package/dist-types/version.d.ts +1 -0
package/docs/README.md +73 -0
package/docs/building-headless-components.md +250 -0
package/docs/callbacks.md +117 -0
package/docs/components/consent-banner.md +174 -0
package/docs/components/consent-dialog-link.md +59 -0
package/docs/components/consent-dialog-trigger.md +103 -0
package/docs/components/consent-dialog.md +137 -0
package/docs/components/consent-manager-provider.md +423 -0
package/docs/components/consent-widget.md +78 -0
package/docs/components/dev-tools.md +63 -0
package/docs/components/frame.md +73 -0
package/docs/concepts/client-modes.md +163 -0
package/docs/concepts/consent-categories.md +97 -0
package/docs/concepts/consent-models.md +116 -0
package/docs/concepts/cookie-management.md +122 -0
package/docs/concepts/glossary.md +23 -0
package/docs/concepts/initialization-flow.md +141 -0
package/docs/concepts/policy-packs.md +229 -0
package/docs/headless.md +184 -0
package/docs/hooks/use-color-scheme.md +40 -0
package/docs/hooks/use-consent-manager/checking-consent.md +94 -0
package/docs/hooks/use-consent-manager/location-info.md +95 -0
package/docs/hooks/use-consent-manager/overview.md +390 -0
package/docs/hooks/use-consent-manager/setting-consent.md +92 -0
package/docs/hooks/use-draggable.md +57 -0
package/docs/hooks/use-focus-trap.md +41 -0
package/docs/hooks/use-reduced-motion.md +35 -0
package/docs/hooks/use-ssr-status.md +31 -0
package/docs/hooks/use-text-direction.md +49 -0
package/docs/hooks/use-translations.md +117 -0
package/docs/iab/consent-banner.md +95 -0
package/docs/iab/consent-dialog.md +135 -0
package/docs/iab/overview.md +119 -0
package/docs/iab/use-gvl-data.md +208 -0
package/docs/iframe-blocking.md +107 -0
package/docs/integrations/databuddy.md +186 -0
package/docs/integrations/google-tag-manager.md +153 -0
package/docs/integrations/google-tag.md +149 -0
package/docs/integrations/linkedin-insights.md +109 -0
package/docs/integrations/meta-pixel.md +342 -0
package/docs/integrations/microsoft-uet.md +112 -0
package/docs/integrations/overview.md +89 -0
package/docs/integrations/posthog.md +177 -0
package/docs/integrations/tiktok-pixel.md +113 -0
package/docs/integrations/x-pixel.md +143 -0
package/docs/internationalization.md +197 -0
package/docs/network-blocker.md +178 -0
package/docs/optimization.md +156 -0
package/docs/policy-packs.md +246 -0
package/docs/quickstart.md +155 -0
package/docs/script-loader.md +300 -0
package/docs/server-side.md +171 -0
package/docs/styling/classnames.md +84 -0
package/docs/styling/color-scheme.md +82 -0
package/docs/styling/css-variables.md +92 -0
package/docs/styling/overview.md +312 -0
package/docs/styling/slots.md +93 -0
package/docs/styling/tailwind.md +115 -0
package/docs/styling/tokens.md +214 -0
package/docs/troubleshooting.md +146 -0
package/package.json +20 -13
package/dist/headless.d.ts +0 -2
package/dist/headless.d.ts.map +0 -1
package/dist/index.d.ts.map +0 -1
package/dist/libs/initial-data.d.ts.map +0 -1
package/dist/types.d.ts +0 -16
package/dist/types.d.ts.map +0 -1
package/dist/version.d.ts +0 -2
package/dist/version.d.ts.map +0 -1

package/docs/integrations/microsoft-uet.md ADDED Viewed

@@ -0,0 +1,112 @@
+---
+title: Microsoft UET
+description: Track conversions and measure performance for Microsoft Advertising and Bing Ads.
+lastModified: 2025-09-24
+icon: microsoft
+---
+Microsoft UET (Universal Event Tracking) is Microsoft's conversion tracking tag for Microsoft Advertising. It tracks user actions, measures campaign effectiveness, and enables remarketing campaigns. By default, c15t loads this script based on `marketing` consent.
+> ℹ️ **Info:**
+> UET can also load Microsoft Clarity (if enabled in your UET tag settings). Since Clarity is an analytics tool, we recommend loading it separately with measurement consent instead.
+## Adding Microsoft UET to c15t
+> ℹ️ **Info:**
+> See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).
+```ts
+import { microsoftUet } from '@c15t/scripts/microsoft-uet';
+microsoftUet({
+  id: '123456789012345',
+})
+```
+## Types
+### MicrosoftUetOptions
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|Your Microsoft UET ID|-|✅ Required|
+|script|Script \|undefined|Override or extend the default script values. Options: \`id\`: 'microsoft-uet'; \`src\`: \`//bat.bing.com/bat.js\`; \`category\`: 'marketing'|-|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/overview.md ADDED Viewed

@@ -0,0 +1,89 @@
+---
+title: Integrations
+description: "Many of your tools may require consent to be given before they can be used. This is especially true for analytics and marketing tools. \nc15t has various ways to integrate with your tools, depending on the tool you are using."
+lastModified: 2025-10-02
+---
+## General Pattern
+Every integration provides a script configuration function. Pass it to your framework's setup:
+**JavaScript**
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { yourScript } from '@c15t/scripts/your-script';
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  scripts: [
+    yourScript({ /* options */ }),
+  ],
+});
+```
+**React**
+```tsx
+import { yourScript } from '@c15t/scripts/your-script';
+import { ConsentManagerProvider } from '@c15t/react';
+export function App({ children }: { children: React.ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        scripts: [
+          yourScript({ /* options */ }),
+        ],
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+**Next.js**
+```tsx
+import { yourScript } from '@c15t/scripts/your-script';
+import { ConsentManagerProvider } from '@c15t/nextjs';
+export function App({ children }: { children: React.ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        scripts: [
+          yourScript({ /* options */ }),
+        ],
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+## Script Loader
+Many marketing and analytics tools are commonly loaded using a script tag, such as Google Tag Manager (GTM), Google Tag (gtag.js), Meta Pixel and TikTok Pixel.
+c15t's script loader allows you to easily integrate your tools that require consent with c15t, to make this even easier we have provided a set of prebuilt scripts for you to use.
+* [JavaScript](/docs/frameworks/javascript/script-loader)
+* [React](/docs/frameworks/react/script-loader)
+* [Next.js](/docs/frameworks/next/script-loader)
+## has() method
+The `has()` method allows you to check if the user has given consent for a specific purpose. You can learn more about the `has()` method [here](/docs/frameworks/javascript/store/checking-consent).
+```ts
+const hasAnalytics = has('measurement');
+if (hasAnalytics) {
+  myAnalyticsLibrary.track('checkout_completed');
+}
+```

package/docs/integrations/posthog.md ADDED Viewed

@@ -0,0 +1,177 @@
+---
+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: 2025-09-19
+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. **Adding the SDK callback to c15t** The PostHog SDK approach uses callbacks.onConsentSet instead of scripts. This lets you toggle PostHog's opt-in/opt-out based on the user's consent choice.
+   > ℹ️ 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';
+   getOrCreateConsentRuntime({
+     mode: 'hosted',
+     callbacks: {
+       onConsentSet({ preferences }) {
+         if (preferences.measurement) {
+           posthog.opt_in_capturing();
+         } else {
+           posthog.opt_out_capturing();
+         }
+       }
+     }
+   });
+   ```
+## 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',
+     defaults: '2025-05-24',
+     options: { person_profiles: 'identified_only' }
+   })
+   ```
+## Types
+### PosthogConsentOptions
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|id|string|Your posthog id, begins with 'phc\_'.|-|✅ Required|
+|apiHost|string|Your posthog api host.|'https\://eu.i.posthog.com'|✅ Required|
+|defaults|string|The defaults for the posthog script.|-|✅ Required|
+|options|Record\<string, unknown>|Other optional options for the posthog script.|-|✅ Required|
+|script|Script \|undefined|Override or extend the default script values. Options: \`id\`: 'posthog-consent'; \`category\`: 'measurement'|-|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 ADDED Viewed

@@ -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|
+|script|Script \|undefined|Override or extend the default script values. Options: \`id\`: 'tiktok-pixel'; \`src\`: \`https\://analytics.tiktok.com/i18n/pixel/events.js\`; \`category\`: 'marketing'|-|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 ADDED Viewed

@@ -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|
+|script|Script \|undefined|Override or extend the default script values. Options: \`id\`: 'x-pixel'; \`src\`: \`https\://static.ads-twitter.com/uwt.js\`; \`category\`: 'marketing'|-|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|