c15t 2.0.4 → 2.1.0

package/docs/integrations/linkedin-insights.md

@@ -1,33 +1,152 @@
 ---
 title: LinkedIn Insights
 description: Track conversions and build matched audiences for LinkedIn advertising campaigns.
-lastModified: 2025-09-24
-
+lastModified: 2026-05-11
 icon: linkedin
 ---
-LinkedIn Insights Tag is LinkedIn's conversion tracking and audience matching tool for LinkedIn advertising campaigns. It tracks website actions, measures ad performance, builds matched audiences for retargeting, and provides demographic insights about your visitors. By default, c15t loads this script based on `marketing` consent.
+LinkedIn Insight Tag is LinkedIn's conversion tracking and audience matching tool for LinkedIn advertising campaigns. It tracks website actions, measures ad performance, builds website retargeting audiences, and provides aggregate audience insights about visitors from LinkedIn member accounts.
+
+## Official LinkedIn documentation
+
+* [Add the LinkedIn Insight Tag to your website](https://www.linkedin.com/help/lms/answer/a418880)
+* [LinkedIn Insight Tag overview](https://www.linkedin.com/help/lms/answer/a489169)
+* [LinkedIn Insight Tag FAQs](https://www.linkedin.com/help/lms/answer/a427660)
+* [Insight Tag source status](https://www.linkedin.com/help/lms/answer/a488323)
+* [Compatible tag management systems](https://www.linkedin.com/help/lms/answer/a422760)
+* [LinkedIn Ads Agreement](https://www.linkedin.com/legal/sas-terms)
+
+## Integrate with c15t
 
-## Adding the LinkedIn Insights Tag to c15t
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { linkedinInsights } from '@c15t/scripts/linkedin-insights';
+
+const scripts = [
+  linkedinInsights({
+    id: '123456789012345',
+  }),
+];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: 'https://your-instance.c15t.dev',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
 
-> ℹ️ **Info:**
-> See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).
+**Next.js**
+
+```tsx
+'use client';
+
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/nextjs';
+import { linkedinInsights } from '@c15t/scripts/linkedin-insights';
+
+const scripts = [
+  linkedinInsights({
+    id: '123456789012345',
+  }),
+];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
 
 ```ts
+import { getOrCreateConsentRuntime } from 'c15t';
 import { linkedinInsights } from '@c15t/scripts/linkedin-insights';
 
-linkedinInsights({
-  id: '123456789012345',
-})
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [
+    linkedinInsights({
+      id: '123456789012345',
+    }),
+  ],
+});
 ```
 
+## How c15t loads it
+
+* **Category:** `marketing` (Ads & Pixels)
+* **Loads when:** marketing consent is granted
+* **Default install:** c15t sets the LinkedIn partner ID globals, seeds the `lintrk` queue, and loads LinkedIn's `insight.min.js`
+* **On revocation:** unloaded - c15t removes the script element from the DOM
+
+> ⚠️ **Warning:**
+> LinkedIn says the Insight Tag should not be installed on pages that collect or contain Sensitive Data, including certain consumer health or financial pages. If your app has those pages, only include this script on eligible routes and confirm the placement with your legal team.
+
+Use the LinkedIn Insight Tag partner ID as `id`. You can find it in Campaign Manager under **Data** -> **Signals manager** -> **Insight Tag**.
+
+c15t intentionally does not add LinkedIn's `<noscript>` image pixel fallback. The integration is consent-gated JavaScript, so the script only loads after `marketing` consent is granted.
+
+## Tracking events in your app
+
+c15t gates the LinkedIn Insight Tag from loading until `marketing` consent is granted. Page tracking is automatic once the script loads, but if you fire custom conversions through `window.lintrk(...)`, those calls are **not** automatically gated - `window.lintrk` does not exist before consent is granted, and is removed again if consent is revoked.
+
+Guard custom conversion calls by checking consent state:
+
+```tsx
+import { useCallback } from 'react';
+import { useConsentManager } from '@c15t/react';
+
+function useTrackSignup() {
+  const { has } = useConsentManager();
+  return useCallback(() => {
+    if (has('marketing')) {
+      window.lintrk?.('track', { conversion_id: 12345 });
+    }
+  }, [has]);
+}
+
+function SignupButton() {
+  const trackSignup = useTrackSignup();
+  return <button onClick={trackSignup}>Sign up</button>;
+}
+```
+
+## Verify setup
+
+LinkedIn validates the tag after an associated domain or URL receives traffic. Source status can take a few minutes and up to 24 hours to update after the first page load:
+
+* **Active:** signal received in the past seven days
+* **No recent activity:** no signal for more than seven days
+* **Unverified:** no signal received yet
+
 ## Types
 
 ### LinkedInInsightsOptions
 
 |Property|Type|Description|Default|Required|
 |:--|:--|:--|:--|:--:|
-|id|string|Your LinkedIn Insights ID|-|✅ Required|
-|scriptSrc|string \|undefined|LinkedIn Insights loader URL.|-|Optional|
+|id|string|Your LinkedIn Insight Tag partner ID. LinkedIn shows this in Campaign Manager under Data -> Signals manager -> Insight Tag.|-|✅ Required|
+|scriptSrc|string \|undefined|LinkedIn Insight Tag loader URL.|-|Optional|
 
 ### Script
 

package/docs/integrations/matomo-analytics.md

@@ -0,0 +1,246 @@
+---
+title: Matomo Analytics
+description: Load Matomo with c15t and keep Matomo's queue aligned with measurement consent.
+lastModified: 2026-05-10
+icon: matomo
+---
+Matomo gives you privacy-focused web analytics with self-hosted and cloud deployment options. The `matomoAnalytics()` helper sets up Matomo's `_paq` queue, points it at your tracker, and can queue consent-aware commands before the vendor bundle loads.
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { matomoAnalytics } from '@c15t/scripts/matomo-analytics';
+
+const scripts = [
+  matomoAnalytics({
+    matomoUrl: 'https://analytics.example.com',
+    siteId: 1,
+  }),
+];
+
+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 { matomoAnalytics } from '@c15t/scripts/matomo-analytics';
+
+const scripts = [
+  matomoAnalytics({
+    matomoUrl: 'https://analytics.example.com',
+    siteId: 1,
+  }),
+];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { matomoAnalytics } from '@c15t/scripts/matomo-analytics';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [
+    matomoAnalytics({
+      matomoUrl: 'https://analytics.example.com',
+      siteId: 1,
+    }),
+  ],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `measurement` (Analytics)
+* **Loads when:** measurement consent is granted by default
+* **Consent mode option:** with `defaultConsent`, the helper switches to `alwaysLoad: true` and uses Matomo queue commands to grant/forget consent without unloading the SDK.
+
+## Configure the integration
+
+If you want Matomo to manage consent internally, set `defaultConsent` to one
+of these values:
+
+* `'required'` queues Matomo's `requireConsent` command so no tracking runs
+  until consent is granted.
+* `'given'` queues Matomo's `setConsentGiven` command so tracking starts as
+  granted by default.
+
+When `defaultConsent` is omitted, c15t uses the standard script-loader flow:
+Matomo only loads after `measurement` consent is granted.
+
+```ts
+import { matomoAnalytics } from '@c15t/scripts/matomo-analytics';
+
+matomoAnalytics({
+  matomoUrl: 'https://analytics.example.com',
+  siteId: 1,
+  defaultConsent: 'required',
+});
+```
+
+## Tracking events in your app
+
+Matomo's runtime API is queue-based (`window._paq`). When the script is not loaded yet, pushing to `_paq` is still safe as long as the queue exists. The helper creates `_paq` during setup.
+
+From React:
+
+```tsx
+import { useCallback } from 'react';
+import { useConsentManager } from '@c15t/react';
+
+function SignupExample() {
+  const { has } = useConsentManager();
+
+  const trackSignup = useCallback(() => {
+    if (has('measurement')) {
+      window._paq?.push(['trackEvent', 'signup', 'completed']);
+    }
+  }, [has]);
+
+  return <button onClick={trackSignup}>Sign up</button>;
+}
+```
+
+From plain JavaScript:
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+
+const { consentStore } = getOrCreateConsentRuntime();
+
+if (consentStore.getState().has('measurement')) {
+  window._paq?.push(['trackEvent', 'signup', 'completed']);
+}
+```
+
+## Types
+
+### MatomoAnalyticsOptions
+
+|Property|Type|Description|Default|Required|
+|:--|:--|:--|:--|:--:|
+|siteId|string \|number \|undefined|Your Matomo site ID.|-|Optional|
+|matomoUrl|string \|undefined|Your Matomo base URL, for example \`https\://analytics.example.com\`.|-|Optional|
+|cloudId|string \|undefined|Your Matomo Cloud identifier, for example \`my-site.matomo.cloud\`.|-|Optional|
+|trackerUrl|string \|undefined|Optional explicit tracker endpoint override.|-|Optional|
+|scriptUrl|string \|undefined|Optional explicit script URL override.|-|Optional|
+|enableLinkTracking|boolean \|undefined|Queue \`enableLinkTracking\`.|-|Optional|
+|disableCookies|boolean \|undefined|Queue \`disableCookies\`.|-|Optional|
+|trackPageView|boolean \|undefined|Queue an initial \`trackPageView\`.|-|Optional|
+|defaultConsent|"required" \|"given" \|undefined|Default Matomo consent state (\`required\` blocks, \`given\` starts enabled).|-|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|