@c15t/scripts 2.1.0 → 2.2.0-canary-20260804162155

package/docs/integrations/hotjar.md

@@ -0,0 +1,143 @@
+---
+title: Hotjar
+description: Product analytics and behavior insights with a prebuilt helper that
+  seeds Hotjar globals before loading the vendor bundle.
+group: integrations
+icon: hotjar
+---
+Hotjar helps you understand behavior with heatmaps, session recordings, and feedback tools. The `hotjar()` helper sets up Hotjar's `_hjSettings` global and `hj` queue stub, then loads the vendor script once `measurement` consent is granted.
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { hotjar } from '@c15t/scripts/hotjar';
+
+const scripts = [hotjar({ siteId: 1234567, version: 6 })];
+
+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 { hotjar } from '@c15t/scripts/hotjar';
+
+const scripts = [hotjar({ siteId: 1234567, version: 6 })];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { hotjar } from '@c15t/scripts/hotjar';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [hotjar({ siteId: 1234567, version: 6 })],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `measurement` (Analytics)
+* **Loads when:** measurement consent is granted
+* **On revocation:** unloaded - c15t removes the loader script element from the DOM, which prevents further loader-driven network requests. Existing Hotjar requests, timers, event listeners, and globals may continue until they finish or are cleared by Hotjar-specific APIs.
+
+To load Hotjar from a custom URL:
+
+```ts
+hotjar({
+  siteId: 1234567,
+  scriptUrl: 'https://cdn.example.com/hotjar.js',
+});
+```
+
+## Tracking events in your app
+
+c15t gates loading of the Hotjar script until `measurement` consent is granted. The `hotjar()` helper initializes Hotjar globals by creating a pre-load queue stub at `window.hj`, so calls to Hotjar's runtime API (`window.hj(...)`) can be queued before the real script loads. After the helper runs, `window.hj` exists as that queue stub; once Hotjar's script loads, it is replaced by Hotjar's real implementation.
+
+Guard event calls by checking consent state. From React:
+
+```tsx
+import { useCallback } from 'react';
+import { useConsentManager } from '@c15t/react';
+
+function SignupExample() {
+  const { has } = useConsentManager();
+
+  const trackSignup = useCallback(() => {
+    if (has('measurement')) {
+      window.hj?.('event', 'signup');
+    }
+  }, [has]);
+
+  // Call trackSignup() from an event handler after signup succeeds.
+}
+```
+
+From plain JavaScript:
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+
+const { consentStore } = getOrCreateConsentRuntime();
+
+if (consentStore.getState().has('measurement')) {
+  window.hj?.('event', 'signup');
+}
+```
+
+## Types
+
+### HotjarOptions
+
+|Property|Value|
+|:--|:--|
+|Type Name|\`HotjarOptions\`|
+|Source Path|\`./packages/scripts/src/vendors/analytics/hotjar.ts\`|
+
+\*ExtractedTypeTable: Could not extract "HotjarOptions" from "./packages/scripts/src/vendors/analytics/hotjar.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/intercom.md

@@ -0,0 +1,144 @@
+---
+title: Intercom
+description: Bootstrap Intercom settings and load the messenger widget bundle.
+group: integrations
+icon: intercom
+---
+Intercom adds the Intercom messenger widget and queues early `Intercom(...)`
+calls until the widget bundle loads.
+
+## Official Intercom documentation
+
+* [Install Intercom Messenger](https://developers.intercom.com/installing-intercom/web/installation)
+* [Secure your Messenger](https://developers.intercom.com/installing-intercom/web/identity-verification)
+* [JavaScript API](https://developers.intercom.com/installing-intercom/web/methods)
+* [Attributes and objects](https://developers.intercom.com/installing-intercom/web/attributes-objects)
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { intercom } from '@c15t/scripts/intercom';
+
+const scripts = [intercom({ appId: 'abc123' })];
+
+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 { intercom } from '@c15t/scripts/intercom';
+
+const scripts = [intercom({ appId: 'abc123' })];
+
+export function ConsentProvider({ children }: { children: ReactNode }) {
+  return (
+    <ConsentManagerProvider
+      options={{
+        mode: 'hosted',
+        backendURL: '/api/c15t',
+        scripts,
+      }}
+    >
+      {children}
+    </ConsentManagerProvider>
+  );
+}
+```
+
+**JavaScript**
+
+```ts
+import { getOrCreateConsentRuntime } from 'c15t';
+import { intercom } from '@c15t/scripts/intercom';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [intercom({ appId: 'abc123' })],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `functionality` (Functional)
+* **Loads when:** functionality consent is granted
+* **Before load:** c15t seeds `window.intercomSettings` and a queueing
+  `Intercom` stub
+* **On revocation:** c15t follows the default script loader behavior for
+  non-persistent scripts
+
+## Configure the integration
+
+Intercom's default regional API base is `https://api-iam.intercom.io`. If your
+workspace uses the EU or Australia data host, pass the matching `apiBase`.
+
+```ts
+intercom({
+  appId: 'abc123',
+  apiBase: 'https://api-iam.eu.intercom.io',
+})
+```
+
+### Runtime options
+
+Pass additional Intercom settings through `settings`. The helper always writes
+the provided `appId` to `app_id` and `apiBase` to `api_base`.
+
+```ts
+intercom({
+  appId: 'abc123',
+  settings: {
+    name: 'Ada Lovelace',
+    user_id: 'user-123',
+    company: {
+      company_id: 'company-123',
+      name: 'Example Company Inc.',
+    },
+  },
+})
+```
+
+For logged-in users, Intercom recommends securing the Messenger with
+server-generated identity data. Generate verification tokens on your backend and
+only pass client-safe values through `settings`.
+
+## Types
+
+### IntercomOptions
+
+|Property|Value|
+|:--|:--|
+|Type Name|\`IntercomOptions\`|
+|Source Path|\`./packages/scripts/src/vendors/functional/intercom.ts\`|
+
+\*ExtractedTypeTable: Could not extract "IntercomOptions" from "./packages/scripts/src/vendors/functional/intercom.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/linkedin-insights.md

@@ -0,0 +1,161 @@
+---
+title: LinkedIn Insights
+description: Track conversions and build matched audiences for LinkedIn
+  advertising campaigns.
+icon: linkedin
+group: integrations
+---
+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
+
+**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>
+  );
+}
+```
+
+**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';
+
+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|Value|
+|:--|:--|
+|Type Name|\`LinkedInInsightsOptions\`|
+|Source Path|\`./packages/scripts/src/vendors/ads-and-pixels/linkedin-insights.ts\`|
+
+\*ExtractedTypeTable: Could not extract "LinkedInInsightsOptions" from "./packages/scripts/src/vendors/ads-and-pixels/linkedin-insights.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/logrocket.md

@@ -0,0 +1,175 @@
+---
+title: LogRocket
+description: Session replay and monitoring loaded after measurement consent with
+  LogRocket's browser SDK.
+group: integrations
+icon: logrocket
+---
+[LogRocket](https://logrocket.com) records session replay, frontend errors, network activity, console logs, and user behavior so product and engineering teams can debug production sessions. c15t loads `LogRocket.min.js` with `crossorigin="anonymous"` and then calls `window.LogRocket.init('org-slug/app-slug')`.
+
+## Integrate with c15t
+
+**React**
+
+```tsx
+import { type ReactNode } from 'react';
+import { ConsentManagerProvider } from '@c15t/react';
+import { logRocket } from '@c15t/scripts/logrocket';
+
+const scripts = [
+  logRocket({
+    appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
+    initOptions: {
+      dom: {
+        inputSanitizer: true,
+      },
+    },
+  }),
+];
+
+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 { logRocket } from '@c15t/scripts/logrocket';
+
+const scripts = [
+  logRocket({
+    appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
+    initOptions: {
+      dom: {
+        inputSanitizer: 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 { logRocket } from '@c15t/scripts/logrocket';
+
+getOrCreateConsentRuntime({
+  mode: 'hosted',
+  backendURL: 'https://your-instance.c15t.dev',
+  scripts: [
+    logRocket({
+      appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
+      initOptions: {
+        dom: {
+          inputSanitizer: true,
+        },
+      },
+    }),
+  ],
+});
+```
+
+## How c15t loads it
+
+* **Category:** `measurement` (Analytics)
+* **Loads when:** measurement consent is granted
+* **On revocation:** unloaded - c15t removes the script element from the DOM. LogRocket does not document a web SDK consent opt-out or stop-recording API equivalent to Clarity or Mixpanel consent methods, and removing the loader does not stop an already-initialized recorder in the current page view. Revocation fully takes effect on the next page load.
+
+The helper maps the script-tag snippet into the manifest engine:
+
+```ts
+logRocket({
+  appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
+})
+```
+
+It loads `https://cdn.logrocket.io/LogRocket.min.js` with `crossorigin="anonymous"` and calls:
+
+```ts
+window.LogRocket?.init('YOUR_ORG_SLUG/YOUR_APP_SLUG', initOptions)
+```
+
+after the script load event. `appId` is required and must be in `org/app` format.
+
+## Privacy and sanitization
+
+LogRocket captures user behavior for replay, so configure sanitization before deploying it. LogRocket documents DOM redaction with `data-private`, automatic text/input/image sanitization, and network request/response sanitizers. Password fields are never recorded, but other sensitive inputs, DOM nodes, network payloads, Redux state, and Redux actions should be explicitly excluded.
+
+Pass JSON-serializable LogRocket init options as `initOptions`:
+
+```ts
+logRocket({
+  appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
+  initOptions: {
+    dom: {
+      inputSanitizer: true,
+      textSanitizer: true,
+      imageSanitizer: true,
+      privateClassNameBlocklist: ['private-profile'],
+      privateAttributeBlocklist: ['data-hide-from-replay'],
+    },
+  },
+})
+```
+
+Only pass values that can safely cross the manifest boundary. Avoid functions, class instances, prototypes, `Map`, `Set`, or other non-JSON types unless you are constructing a manual `Script` outside the manifest helper. LogRocket also supports function-based network sanitizers; use a manual `Script` if you need those callbacks.
+
+To proxy or self-host the loader, pass a custom URL. LogRocket's proxy setup also chain-loads a logger bundle, so set `asyncScriptUrl` as well — otherwise the async bundle is still fetched from LogRocket's CDN:
+
+```ts
+logRocket({
+  appId: 'YOUR_ORG_SLUG/YOUR_APP_SLUG',
+  scriptUrl: 'https://analytics.example.com/LogRocket.min.js',
+  asyncScriptUrl: 'https://analytics.example.com/logger.min.js',
+})
+```
+
+## Types
+
+### LogRocketOptions
+
+|Property|Value|
+|:--|:--|
+|Type Name|\`LogRocketOptions\`|
+|Source Path|\`./packages/scripts/src/vendors/analytics/logrocket.ts\`|
+
+\*ExtractedTypeTable: Could not extract "LogRocketOptions" from "./packages/scripts/src/vendors/analytics/logrocket.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.\*