c15t 2.0.4 → 2.1.0

package/docs/integrations/crisp.md

@@ -0,0 +1,214 @@
+---
+title: Crisp
+description: Load Crisp live chat with website ID, runtime, cookie, and session options.
+lastModified: 2026-05-11
+icon: crisp
+---
+Crisp adds the Crisp live chat widget and exposes the `$crisp` queue for
+chatbox actions such as opening the chat, setting user details, and resetting
+sessions.
+
+## Official Crisp documentation
+
+* [Web Chat SDK](https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/)
+* [$crisp methods](https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/dollar-crisp/)
+* [Identity verification](https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/identity-verification/)
+* [Cookie policies](https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/cookie-policies/)
+* [Session continuity](https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/session-continuity/)
+* [Language customization](https://docs.crisp.chat/guides/chatbox-sdks/web-sdk/language-customization/)
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { crisp } from '@c15t/scripts/crisp';
+
+const scripts = [crisp({ websiteId: 'crisp-123' })];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: 'https://your-instance.c15t.dev',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**Next.js**
+
+```tsx
+'use client';
+
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/nextjs';
+import { crisp } from '@c15t/scripts/crisp';
+
+const scripts = [crisp({ websiteId: 'crisp-123' })];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { crisp } from '@c15t/scripts/crisp';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [crisp({ websiteId: 'crisp-123' })],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `functionality` (Functional)
+* **Loads when:** functionality consent is granted
+* **Before load:** c15t seeds `window.$crisp`, `CRISP_WEBSITE_ID`, and any
+  optional Crisp runtime globals
+* **On revocation:** c15t follows the default script loader behavior for
+  non-persistent scripts
+
+## Configure the integration
+
+The helper seeds Crisp's documented globals before loading
+`https://client.crisp.chat/l.js`.
+
+```ts
+crisp({
+  websiteId: 'crisp-123',
+  locale: 'fr',
+  cookieDomain: 'app.example.com',
+  cookieExpiry: 3600,
+  tokenId: 'secure-user-token',
+  sessionMerge: true,
+  safeMode: true,
+})
+```
+
+`locale` and `sessionMerge` are written to `CRISP_RUNTIME_CONFIG`.
+`cookieDomain` maps to `CRISP_COOKIE_DOMAIN`, `cookieExpiry` maps to
+`CRISP_COOKIE_EXPIRE`, and `tokenId` maps to `CRISP_TOKEN_ID`. `safeMode`
+queues `['safe', true]` on `window.$crisp` before the loader runs so Crisp
+starts in safe mode.
+
+For session continuity, generate `tokenId` on your backend with a secure random
+value. Do not use emails, hashes of emails, timestamps, or incrementing IDs as
+Crisp session tokens. If you verify user emails, generate the HMAC signature on
+your backend and set it with Crisp's `$crisp` API after the helper loads.
+
+## Types
+
+### CrispOptions
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|websiteId|string|Your Crisp website ID.|-|✅ Required|
+|locale|string \|undefined|Optional locale passed through \`window\.CRISP\_RUNTIME\_CONFIG\`.|-|Optional|
+|cookieDomain|string \|undefined|Optional cookie domain override for Crisp.|-|Optional|
+|cookieExpiry|number \|undefined|Optional cookie expiration in seconds.|-|Optional|
+|tokenId|string \|undefined|Optional Crisp token ID for session continuity.|-|Optional|
+|sessionMerge|boolean \|undefined|Whether to merge anonymous sessions into token-backed sessions.|-|Optional|
+|safeMode|boolean \|undefined|Whether to enable \`$crisp\` safe mode before other queued calls.|-|Optional|
+|scriptSrc|string \|undefined|Crisp 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|

package/docs/integrations/databuddy.md

@@ -2,79 +2,130 @@
 title: Databuddy
 description: Databuddy is a privacy-focused analytics platform that helps you understand user behavior and track events. It supports cookieless tracking and manages consent automatically through c15t's consent state synchronization.
 lastModified: 2025-10-31
-
 icon: databuddy
 ---
 The Databuddy script automatically respects consent preferences by toggling tracking on and off based on the user's consent state.
 
-## Script Implementation
-
-1. **Adding the Databuddy script to c15t**
-
-   > ℹ️ Info:
-   >
-   > See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).
-
-   ```ts
-   import { databuddy } from '@c15t/scripts/databuddy';
-
-   databuddy({
-     clientId: 'your-client-id',
-     scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
-     apiUrl: 'https://basket.databuddy.cc',
-     configWhenGranted: {
-       clientId: 'your-client-id',
-       apiUrl: 'https://basket.databuddy.cc',
-       trackScreenViews: true,
-       trackOutgoingLinks: true,
-       disabled: false,
-     },
-     configWhenDenied: {
-       clientId: 'your-client-id',
-       apiUrl: 'https://basket.databuddy.cc',
-       disabled: true,
-     }
-   })
-   ```
-
-2. **Using Databuddy in your application** Once initialized, Databuddy is available globally via window\.databuddy or window\.db:
-
-   ```ts
-   // Track a custom event
-   window.databuddy?.trackCustomEvent('button_clicked', {
-     button_id: 'signup',
-     page: '/landing'
-   });
-
-   // Or use the shorthand
-   window.db?.track('purchase_completed', {
-     amount: 99.99,
-     currency: 'USD'
-   });
-
-   // Track a screen view manually
-   window.databuddy?.screenView('/dashboard', {
-     user_role: 'admin'
-   });
-
-   // Set global properties for all events
-   window.databuddy?.setGlobalProperties({
-     app_version: '1.2.3',
-     environment: 'production'
-   });
-   ```
-
-## How Consent Management Works
+## Integrate with c15t
 
-The Databuddy integration automatically handles consent management:
+**React**
 
-1. **Before Script Load**: Sets `window.databuddyConfig.disabled` based on initial consent state
-2. **On Consent Grant**: Enables tracking by setting `window.databuddy.options.disabled = false`
-3. **On Consent Revoke**: Disables tracking by setting `window.databuddy.options.disabled = true`
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { databuddy } from '@c15t/scripts/databuddy';
 
-This ensures that no tracking occurs without user consent, keeping your analytics privacy-compliant.
+const scripts = [
+  databuddy({
+    clientId: 'your-client-id',
+    scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
+    apiUrl: 'https://basket.databuddy.cc',
+    configWhenGranted: {
+      clientId: 'your-client-id',
+      apiUrl: 'https://basket.databuddy.cc',
+      disabled: false,
+    },
+    configWhenDenied: {
+      clientId: 'your-client-id',
+      apiUrl: 'https://basket.databuddy.cc',
+      disabled: true,
+    },
+  }),
+];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: 'https://your-instance.c15t.dev',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**Next.js**
 
-## Configuration Options
+```tsx
+'use client';
+
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/nextjs';
+import { databuddy } from '@c15t/scripts/databuddy';
+
+const scripts = [
+  databuddy({
+    clientId: 'your-client-id',
+    scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
+    apiUrl: 'https://basket.databuddy.cc',
+    configWhenGranted: {
+      clientId: 'your-client-id',
+      apiUrl: 'https://basket.databuddy.cc',
+      disabled: false,
+    },
+    configWhenDenied: {
+      clientId: 'your-client-id',
+      apiUrl: 'https://basket.databuddy.cc',
+      disabled: true,
+    },
+  }),
+];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { databuddy } from '@c15t/scripts/databuddy';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [
+    databuddy({
+      clientId: 'your-client-id',
+      scriptUrl: 'https://cdn.databuddy.cc/databuddy.js',
+      apiUrl: 'https://basket.databuddy.cc',
+      configWhenGranted: {
+        clientId: 'your-client-id',
+        apiUrl: 'https://basket.databuddy.cc',
+        disabled: false,
+      },
+      configWhenDenied: {
+        clientId: 'your-client-id',
+        apiUrl: 'https://basket.databuddy.cc',
+        disabled: true,
+      },
+    }),
+  ],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `measurement` (Analytics)
+* **Loads when:** [`alwaysLoad`](/docs/frameworks/react/script-loader#always-load) — runs on page start regardless of consent state
+* **On consent change:** c15t toggles `window.databuddy.options.disabled` so tracking turns on or off without removing the script
+
+## Configure the integration
 
 The Databuddy manifest expects explicit initial config objects for the granted
 and denied consent states:
@@ -111,6 +162,26 @@ databuddy({
 })
 ```
 
+## Tracking events in your app
+
+Databuddy is `alwaysLoad: true`, so the script is in the DOM from page start regardless of consent. `window.databuddy` is therefore always defined and calls to `track`, `screenView`, or `setGlobalProperties` are safe to make at any time — when measurement consent is denied, c15t flips `window.databuddy.options.disabled = true` so the SDK becomes a no-op until consent is granted again.
+
+```ts
+window.databuddy?.track('signup');
+```
+
+You do not need to guard these calls with `useConsentManager().has('measurement')`, but doing so does no harm if you prefer the symmetry with other vendors.
+
+## Consent and privacy
+
+The Databuddy integration automatically handles consent management:
+
+1. **Before Script Load**: Sets `window.databuddyConfig.disabled` based on initial consent state
+2. **On Consent Grant**: Enables tracking by setting `window.databuddy.options.disabled = false`
+3. **On Consent Revoke**: Disables tracking by setting `window.databuddy.options.disabled = true`
+
+This ensures that no tracking occurs without user consent, keeping your analytics privacy-compliant.
+
 ## Types
 
 ### DatabuddyConsentOptions

package/docs/integrations/fathom-analytics.md

@@ -0,0 +1,221 @@
+---
+title: Fathom Analytics
+description: Privacy-friendly cookieless analytics with a prebuilt helper that maps Fathom's data attributes into a c15t-managed script.
+lastModified: 2026-05-10
+icon: fathom-analytics
+---
+Fathom Analytics is a lightweight, cookieless analytics product configured entirely through `data-*` attributes on its loader. The `fathomAnalytics()` helper serializes your site ID and tracking options into those attributes and hands the result to c15t's script loader.
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { fathomAnalytics } from '@c15t/scripts/fathom-analytics';
+
+const scripts = [fathomAnalytics({ site: 'SITE123' })];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: 'https://your-instance.c15t.dev',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**Next.js**
+
+```tsx
+'use client';
+
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/nextjs';
+import { fathomAnalytics } from '@c15t/scripts/fathom-analytics';
+
+const scripts = [fathomAnalytics({ site: 'SITE123' })];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { fathomAnalytics } from '@c15t/scripts/fathom-analytics';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [fathomAnalytics({ site: 'SITE123' })],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `measurement` (Analytics)
+* **Loads when:** measurement consent is granted
+* **On revocation:** unloaded — c15t removes the script element from the DOM. Fathom is cookieless, so no client-side state needs clearing.
+
+If you need to tune SPA tracking, canonical URL tracking, or Do Not Track handling:
+
+```ts
+fathomAnalytics({
+  site: 'SITE123',
+  spa: 'history',
+  canonical: true,
+  honorDnt: true,
+})
+```
+
+Each option is mapped to Fathom's published `data-*` attribute (`data-site`, `data-spa`, `data-auto`, `data-canonical`, `data-honor-dnt`) and the script uses `defer` so it matches Fathom's recommended embed pattern.
+
+## Tracking events in your app
+
+c15t gates the Fathom script from loading until `measurement` consent is granted. Your application code that calls Fathom's runtime API (`window.fathom.trackEvent`, `trackPageview`, `trackGoal`) is **not** automatically gated — `window.fathom` does not exist until the script is loaded, so unguarded calls before consent will throw errors.
+
+Guard event calls by checking consent state. From React:
+
+```tsx
+import { useConsentManager } from '@c15t/react';
+
+function useTrackSignup() {
+  const { has } = useConsentManager();
+
+  return () => {
+    if (has('measurement')) {
+      window.fathom?.trackEvent('signup');
+    }
+  };
+}
+
+function SignupButton() {
+  const trackSignup = useTrackSignup();
+
+  return <button onClick={trackSignup}>Sign up</button>;
+}
+```
+
+From plain JavaScript:
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+
+const { consentStore } = getOrCreateConsentRuntime();
+
+if (consentStore.getState().has('measurement')) {
+  window.fathom?.trackEvent('signup');
+}
+```
+
+## Types
+
+### FathomAnalyticsOptions
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|site|string|Your Fathom Analytics site ID.|-|✅ Required|
+|spa|"auto" \|"history" \|"hash" \|undefined|The SPA tracking mode. When undefined, SPA auto-routing is disabled and the \`data-spa\` attribute is omitted.|-|Optional|
+|auto|boolean \|undefined|Automatically track page views.|-|Optional|
+|canonical|boolean \|undefined|Enable canonical URL tracking.|-|Optional|
+|honorDnt|boolean \|undefined|Honor Do Not Track requests.|-|Optional|
+|scriptUrl|string \|undefined|Custom loader URL.|'https\://cdn.usefathom.com/script.js'|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|