@c15t/react 2.0.4 → 2.2.0-canary-20260727202135

package/docs/integrations/overview.md

@@ -1,105 +1,149 @@
 ---
 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: 2026-04-10
-
+description: Load analytics, pixels, tag managers, and widgets through c15t so
+  consent state controls when they run, update, and appear in your consent UI.
+group: integrations
 ---
-c15t supports two integration styles:
+Third-party tools are easy to paste into app code, but consent makes them part
+of your privacy runtime. Analytics SDKs, ad pixels, tag managers, and chat
+widgets can load remote code, store identifiers, send events, and keep running
+after the first page view.
+
+> ℹ️ **Info:**
+> Put consent-sensitive vendor tools in c15t instead of scattering script tags across your codebase. c15t becomes the place that decides when they can load, when they must stop, and which consent categories your UI needs to show.
+
+## Why Manage Tools In c15t
+
+When you install a vendor directly in your app, your consent logic has to chase
+that vendor everywhere it appears: page layouts, route handlers, event helpers,
+tag-manager snippets, and cleanup code.
+
+Register the vendor with c15t instead. The integration becomes a declarative
+`Script` that the consent runtime can reason about:
+
+* c15t registers the tool with the runtime and evaluates it against the current
+  consent state;
+* c15t automatically adds the tool's consent category to the active categories,
+  so GDPR-style consent UIs include `measurement`, `marketing`, or
+  `functionality` when an enabled integration needs them;
+* c15t blocks the script until consent is granted, or loads it with denied
+  defaults when the vendor has its own consent mode;
+* c15t handles revocation by unloading the script or calling the vendor's
+  consent API;
+* c15t runs vendor setup in the right order, including queue stubs, global
+  functions, data attributes, default page-view events, and consent updates.
+
+That gives your app one consent lifecycle instead of many scattered vendor
+lifecycles.
+
+## Built-In Helpers
+
+c15t ships prebuilt script helpers in
+[`@c15t/scripts`](https://www.npmjs.com/package/@c15t/scripts) for the
+third-party tools developers integrate most often. Prefer them over copied
+vendor snippets whenever c15t already supports the vendor.
+
+Every helper returns a regular `Script` object, so it works anywhere the c15t
+[script loader](/docs/frameworks/javascript/script-loader) accepts scripts. You
+usually choose the helper, provide the vendor ID, and pass the result to your
+provider's `scripts` option. The vendor page explains anything else that still
+matters, such as custom events, region settings, privacy modes, or ecommerce
+payloads.
 
-* use a prebuilt helper from `@c15t/scripts`
-* build your own script or manifest-backed helper
+## Choose An Integration Style
 
-If you are building something reusable or contributing to `@c15t/scripts`, start with the [custom integration guide](/docs/integrations/building-integrations).
+Most apps mix more than one style. Pick the smallest one that keeps consent behavior obvious.
 
-## General Pattern
+|Style|Use when|
+|--|--|
+|**Built-in helper** from `@c15t/scripts`|The vendor is listed below — start here.|
+|**Plain `Script`**|One-off app code with simple load and callback behavior.|
+|**Manifest-backed helper**|Reusable vendor integration with structured setup phases, queues, stubs, or a vendor consent API.|
+|**Iframe / renderable integration**|Vendor exposes an iframe or React component, not just a script tag.|
 
-Every integration provides a script configuration function. Pass it to your framework's setup:
+Setup is the same shape in every framework: import the helper, call it with vendor options, and pass the result to the consent runtime through your provider's `scripts` option. See the framework guides for end-to-end snippets — [JavaScript](/docs/frameworks/javascript/script-loader), [React](/docs/frameworks/react/script-loader), [Next.js](/docs/frameworks/next/script-loader).
 
-**JavaScript**
+## Renderable Integrations
 
-```ts
-import { getOrCreateConsentRuntime } from 'c15t';
-import { yourScript } from '@c15t/scripts/your-script';
+Maps and video embeds need a visible component as well as consent-aware loading.
+The React and Next.js packages include components that own the placeholder,
+vendor loading, and rendered surface. They are imported from the framework
+package rather than `@c15t/scripts`.
 
-getOrCreateConsentRuntime({
-  mode: 'hosted',
-  scripts: [
-    yourScript({ /* options */ }),
-  ],
-});
-```
+* [Google Maps](/docs/integrations/google-maps)
+* [YouTube](/docs/integrations/youtube)
 
-**React**
+## Analytics
 
-```tsx
-import { yourScript } from '@c15t/scripts/your-script';
-import { ConsentManagerProvider } from '@c15t/react';
+Analytics integrations usually require `measurement` consent. Some vendors can run in a consent-aware or cookieless mode; others should stay fully blocked until measurement consent is granted.
 
-export function App({ children }: { children: React.ReactNode }) {
-  return (
-    <ConsentManagerProvider
-      options={{
-        scripts: [
-          yourScript({ /* options */ }),
-        ],
-      }}
-    >
-      {children}
-    </ConsentManagerProvider>
-  );
-}
-```
+* [Google Tag (gtag.js)](/docs/integrations/google-tag)
+* [Ahrefs Analytics](/docs/integrations/ahrefs-analytics)
+* [Adobe Analytics](/docs/integrations/adobe-analytics)
+* [Amplitude](/docs/integrations/amplitude)
+* [Cloudflare Web Analytics](/docs/integrations/cloudflare-web-analytics)
+* [Clearbit](/docs/integrations/clearbit)
+* [Microsoft Clarity](/docs/integrations/microsoft-clarity)
+* [Databuddy](/docs/integrations/databuddy)
+* [Rybbit Analytics](/docs/integrations/rybbit-analytics)
+* [Fathom Analytics](/docs/integrations/fathom-analytics)
+* [Heap](/docs/integrations/heap)
+* [Mixpanel Analytics](/docs/integrations/mixpanel-analytics)
+* [Hotjar](/docs/integrations/hotjar)
+* [Hightouch](/docs/integrations/hightouch)
+* [LogRocket](/docs/integrations/logrocket)
+* [Matomo Analytics](/docs/integrations/matomo-analytics)
+* [PostHog](/docs/integrations/posthog)
+* [Promptwatch](/docs/integrations/promptwatch)
+* [Pirsch](/docs/integrations/pirsch)
+* [RudderStack](/docs/integrations/rudderstack)
+* [Segment](/docs/integrations/segment)
+* [Plausible Analytics](/docs/integrations/plausible-analytics)
+* [Umami Analytics](/docs/integrations/umami-analytics)
+* [Vercel Analytics](/docs/integrations/vercel-analytics)
 
-**Next.js**
+## Functional
 
-```tsx
-import { yourScript } from '@c15t/scripts/your-script';
-import { ConsentManagerProvider } from '@c15t/nextjs';
+Functional integrations usually require `functionality` consent. They add optional user-facing capabilities, such as chat widgets, that should only run after the user allows them.
 
-export function App({ children }: { children: React.ReactNode }) {
-  return (
-    <ConsentManagerProvider
-      options={{
-        scripts: [
-          yourScript({ /* options */ }),
-        ],
-      }}
-    >
-      {children}
-    </ConsentManagerProvider>
-  );
-}
-```
+* [Crisp](/docs/integrations/crisp)
+* [Intercom](/docs/integrations/intercom)
 
-## Script Loader
+## Ads & Pixels
 
-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.
+Advertising pixels usually require `marketing` consent. Many of them need startup stubs so events can be queued safely before the remote SDK loads — built-in helpers handle this for you.
 
-c15t's script loader allows you to easily integrate your tools that require consent with c15t. The prebuilt integrations in `@c15t/scripts` are the recommended starting point, and the custom integration guide explains how to build your own when you need something more specialized.
+* [Meta Pixel](/docs/integrations/meta-pixel)
+* [Snapchat Pixel](/docs/integrations/snapchat-pixel)
+* [Reddit Pixel](/docs/integrations/reddit-pixel)
+* [TikTok Pixel](/docs/integrations/tiktok-pixel)
+* [LinkedIn Insight Tag](/docs/integrations/linkedin-insights)
+* [Microsoft UET](/docs/integrations/microsoft-uet)
+* [X (Twitter) Pixel](/docs/integrations/x-pixel)
 
-* [JavaScript](/docs/frameworks/javascript/script-loader)
-* [React](/docs/frameworks/react/script-loader)
-* [Next.js](/docs/frameworks/next/script-loader)
+## Tag Managers
 
-## Building Your Own
+Tag managers can load other scripts, so they deserve extra care. Prefer vendor consent modes and denied defaults before any tags are allowed to run.
 
-If you need a vendor we do not ship yet:
+* [Google Tag Manager](/docs/integrations/google-tag-manager)
 
-* build a one-off `Script` directly in your app for simple cases
-* build a reusable manifest-backed helper for shared or package-level integrations
+## Build Your Own
 
-Read the [custom integration guide](/docs/integrations/building-integrations) for the manifest phases, structured step model, testing checklist, and devtools debugging flow.
+If c15t does not ship the vendor you need, drop down a level:
 
-## has() method
+* build a one-off `Script` directly in your app for simple cases,
+* build a reusable manifest-backed helper for shared or package-level integrations,
+* or combine the script loader with iframe gating for visible media and widget integrations.
 
-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).
+### Build a Custom Integration
 
-```ts
+Learn when to use a raw `Script`, when to use a manifest, and how to debug and test custom integrations.
 
+[Read the guide →](/docs/integrations/building-integrations)
 
-const hasAnalytics = has('measurement');
+## Where To Next
 
-if (hasAnalytics) {
-  myAnalyticsLibrary.track('checkout_completed');
-}
-```
+* Read the script loader guide for your framework: [JavaScript](/docs/frameworks/javascript/script-loader), [React](/docs/frameworks/react/script-loader), [Next.js](/docs/frameworks/next/script-loader).
+* Use the [Google Maps](/docs/integrations/google-maps) and [YouTube](/docs/integrations/youtube) components for built-in renderable integrations.
+* See the [iframe blocking](/docs/frameworks/react/iframe-blocking) pattern for other visible embeds such as calendars and social widgets.
+* Use [`has()`](/docs/frameworks/javascript/api/checking-consent) to conditionally run app code based on consent state.

package/docs/integrations/pirsch.md

@@ -0,0 +1,142 @@
+---
+title: Pirsch
+description: Privacy-friendly, cookieless analytics loaded with Pirsch's fixed
+  script id and identification-code attributes.
+group: integrations
+icon: pirsch
+---
+[Pirsch](https://pirsch.io) provides privacy-friendly, cookieless web analytics. The official embed loads a single deferred script with an `id` of `pianjs` and your `data-code` identification code. c15t preserves that script id so the Pirsch loader can find its own element and read the configured attributes.
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { pirsch } from '@c15t/scripts/pirsch';
+
+const scripts = [
+  pirsch({
+    identificationCode: 'YOUR_IDENTIFICATION_CODE',
+  }),
+];
+
+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 { pirsch } from '@c15t/scripts/pirsch';
+
+const scripts = [
+  pirsch({
+    identificationCode: 'YOUR_IDENTIFICATION_CODE',
+  }),
+];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { pirsch } from '@c15t/scripts/pirsch';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [
+    pirsch({
+      identificationCode: 'YOUR_IDENTIFICATION_CODE',
+    }),
+  ],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `measurement` (Analytics)
+* **Loads when:** measurement consent is granted
+* **On revocation:** unloaded — c15t removes the script element from the DOM. Pirsch is cookieless, so no client-side cookies need clearing.
+
+The helper maps Pirsch's core script attributes:
+
+```ts
+pirsch({
+  identificationCode: 'YOUR_IDENTIFICATION_CODE',
+  domain: 'rollup.example.com:ROLLUP_IDENTIFICATION_CODE',
+  dev: 'example.com',
+  hitEndpoint: 'https://analytics.example.com/hit',
+  eventEndpoint: 'https://analytics.example.com/event',
+  disablePageViews: true,
+})
+```
+
+Use the extended loader when you need Pirsch's extended script variant:
+
+```ts
+pirsch({
+  identificationCode: 'YOUR_IDENTIFICATION_CODE',
+  extended: true,
+})
+```
+
+To proxy or self-host the loader, pass a custom URL:
+
+```ts
+pirsch({
+  identificationCode: 'YOUR_IDENTIFICATION_CODE',
+  scriptUrl: 'https://analytics.example.com/pa.js',
+})
+```
+
+## Types
+
+### PirschOptions
+
+|Property|Value|
+|:--|:--|
+|Type Name|\`PirschOptions\`|
+|Source Path|\`./packages/scripts/src/vendors/analytics/pirsch.ts\`|
+
+\*ExtractedTypeTable: Could not extract "PirschOptions" from "./packages/scripts/src/vendors/analytics/pirsch.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
+
+### Script
+
+|Property|Value|
+|:--|:--|
+|Type Name|\`Script\`|
+|Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
+
+\*ExtractedTypeTable: Could not extract "Script" from "./packages/core/src/libs/script-loader/types.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*

package/docs/integrations/plausible-analytics.md

@@ -0,0 +1,154 @@
+---
+title: Plausible Analytics
+description: Privacy-friendly cookieless analytics with a prebuilt helper that
+  preserves Plausible's queue bootstrap and loader attributes.
+group: integrations
+icon: plausible
+---
+Plausible Analytics is a privacy-friendly, cookieless analytics product with a lightweight script loader. The `plausibleAnalytics()` helper models Plausible's queue bootstrap and script attributes as a c15t-managed script so early `window.plausible(...)` calls are buffered safely until the tracker loads.
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { plausibleAnalytics } from '@c15t/scripts/plausible-analytics';
+
+const scripts = [plausibleAnalytics({ domain: 'example.com' })];
+
+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 { plausibleAnalytics } from '@c15t/scripts/plausible-analytics';
+
+const scripts = [plausibleAnalytics({ domain: 'example.com' })];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { plausibleAnalytics } from '@c15t/scripts/plausible-analytics';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [plausibleAnalytics({ domain: 'example.com' })],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `measurement` (Analytics)
+* **Loads when:** measurement consent is granted
+* **On revocation:** unloaded — c15t removes the script element from the DOM. Plausible is cookieless, so no client-side state needs clearing.
+
+If you need script extensions or hash-based routing support, pass them through the helper:
+
+```ts
+plausibleAnalytics({
+  domain: 'example.com',
+  extension: ['file-downloads', 'outbound-links'],
+  hashBasedRouting: true,
+})
+```
+
+The helper seeds a `window.plausible` queue stub during `onBeforeLoad`, so any calls made between the consent grant and the real script attaching get buffered into `plausible.q` and replayed. It also maps the legacy `data-domain` / `data-api` attributes and the new `scriptId`-based loader URL automatically.
+
+## Tracking events in your app
+
+c15t gates the Plausible script from loading until `measurement` consent is granted. Your application code that calls Plausible is **not** automatically gated — `window.plausible` does not exist until the script is loaded, so unguarded calls before consent throw.
+
+Guard event calls by checking consent state. From React:
+
+```tsx
+import { useCallback } from 'react';
+import { useConsentManager } from '@c15t/react';
+
+function useTrackSignup() {
+  const { has } = useConsentManager();
+
+  return useCallback(() => {
+    if (has('measurement')) {
+      window.plausible?.('Signup');
+    }
+  }, [has]);
+}
+
+function SignupButton() {
+  const trackSignup = useTrackSignup();
+
+  return (
+    <button type="button" onClick={trackSignup}>
+      Sign up
+    </button>
+  );
+}
+```
+
+From plain JavaScript:
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+
+const { consentStore } = getOrCreateConsentRuntime();
+
+if (consentStore.getState().has('measurement')) {
+  window.plausible?.('Signup');
+}
+```
+
+## Types
+
+### PlausibleAnalyticsOptions
+
+|Property|Value|
+|:--|:--|
+|Type Name|\`PlausibleAnalyticsOptions\`|
+|Source Path|\`./packages/scripts/src/vendors/analytics/plausible-analytics.ts\`|
+
+\*ExtractedTypeTable: Could not extract "PlausibleAnalyticsOptions" from "./packages/scripts/src/vendors/analytics/plausible-analytics.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*
+
+### Script
+
+|Property|Value|
+|:--|:--|
+|Type Name|\`Script\`|
+|Source Path|\`./packages/core/src/libs/script-loader/types.ts\`|
+
+\*ExtractedTypeTable: Could not extract "Script" from "./packages/core/src/libs/script-loader/types.ts" using base path "/home/runner/work/c15t/c15t". Verify the path/name and that the file is included by your tsconfig.\*