@c15t/scripts 2.1.0 → 2.2.0-canary-20260804162155

package/dist-types/vendors/analytics/logrocket.d.ts

@@ -0,0 +1,101 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        LogRocket?: {
+            init: (appId: string, options?: Record<string, unknown>) => void;
+            identify?: (id: string, traits?: Record<string, unknown>) => void;
+            track?: (event: string, properties?: Record<string, unknown>) => void;
+            getSessionURL?: (callback: (sessionUrl: string) => void) => void;
+            start?: () => void;
+            startNewSession?: () => void;
+            uninstall?: () => void;
+        };
+    }
+}
+/**
+ * LogRocket vendor manifest.
+ *
+ * Loads the browser SDK and initializes it after the loader fires its `load`
+ * event. LogRocket does not document a consent opt-out or stop-recording API
+ * for the web SDK, so c15t gates the loader on measurement consent and unloads
+ * the script element when that consent is revoked.
+ */
+export declare const logRocketManifest: {
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'logrocket';
+    readonly category: 'measurement';
+    readonly install: [{
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
+        readonly attributes: {
+            readonly crossorigin: 'anonymous';
+        };
+    }];
+    readonly afterLoad: [{
+        readonly type: 'callGlobal';
+        readonly global: 'LogRocket';
+        readonly method: 'init';
+        readonly args: ["{{appId}}", "{{initOptions}}"];
+    }];
+};
+export interface LogRocketOptions {
+    /**
+     * Your LogRocket app ID in `org-slug/app-slug` format.
+     */
+    appId: string;
+    /**
+     * LogRocket init options passed as the second `LogRocket.init()` argument.
+     *
+     * The manifest engine serializes this object as a template variable, so use
+     * JSON-serializable values only (no functions, class instances, prototypes,
+     * `Map`, `Set`, or other non-JSON types).
+     */
+    initOptions?: Record<string, unknown>;
+    /**
+     * Custom LogRocket loader URL.
+     * @default 'https://cdn.logrocket.io/LogRocket.min.js'
+     */
+    scriptUrl?: string;
+    /**
+     * Proxied URL for LogRocket's asynchronously loaded logger bundle.
+     *
+     * LogRocket's proxy setup requires `window._lrAsyncScript` in addition to
+     * the main `scriptUrl`, because the SDK chain-loads its logger bundle from
+     * this location. Only needed when proxying traffic through your own
+     * domain.
+     *
+     * @see https://docs.logrocket.com/docs/proxying-traffic-through-your-own-domain
+     */
+    asyncScriptUrl?: string;
+}
+/**
+ * Creates a LogRocket script.
+ *
+ * @see https://docs.logrocket.com/reference/init
+ *
+ * @param options - The options for the LogRocket script.
+ * @returns The LogRocket script.
+ * @throws {Error} When `appId` is missing, empty, or not in `org/app` format.
+ * Provide the app ID from LogRocket Project Setup to prevent this error.
+ *
+ * @remarks
+ * LogRocket records session replay and monitoring data. Configure LogRocket's
+ * privacy and sanitization options before deployment so sensitive DOM, input,
+ * network, or application state data is excluded from recordings.
+ *
+ * @example
+ * ```ts
+ * import { logRocket } from '@c15t/scripts/logrocket';
+ *
+ * logRocket({
+ * 	appId: 'org-slug/app-slug',
+ * 	initOptions: {
+ * 		dom: {
+ * 			inputSanitizer: true,
+ * 		},
+ * 	},
+ * });
+ * ```
+ */
+export declare function logRocket(options: LogRocketOptions): Script;

package/dist-types/vendors/analytics/microsoft-clarity.d.ts

@@ -1,7 +1,32 @@
 import type { Script } from 'c15t';
-export type ClarityConsentValue = boolean | Record<string, string>;
+/**
+ * Microsoft Clarity Consent V2 storage state.
+ *
+ * Clarity accepts string consent values instead of booleans for its granular
+ * `ad_Storage` and `analytics_Storage` channels.
+ */
+export type ClarityConsentState = 'granted' | 'denied';
+/**
+ * Consent V2 payload sent to Microsoft Clarity.
+ *
+ * c15t maps `marketing` consent to `ad_Storage` and `measurement` consent to
+ * `analytics_Storage`.
+ */
+export interface ClarityConsentV2Payload {
+    ad_Storage: ClarityConsentState;
+    analytics_Storage: ClarityConsentState;
+}
+/**
+ * Optional boot-time consent override accepted by the Clarity helper.
+ *
+ * Booleans apply the same value to both Clarity Consent V2 channels. Object
+ * values may use Clarity keys or c15t category aliases and are merged over the
+ * current c15t consent state.
+ */
+export type ClarityConsentValue = boolean | Partial<Record<keyof ClarityConsentV2Payload | 'ad_storage' | 'analytics_storage' | 'marketing' | 'measurement' | 'analytics', ClarityConsentState | boolean>>;
 type ClarityFunction = {
-    (command: 'consent', value?: ClarityConsentValue): void;
+    (command: 'consent', value?: boolean): void;
+    (command: 'consentv2', value: ClarityConsentV2Payload): void;
     (command: 'event', value: string): void;
     (command: 'identify', id: string, session?: string, page?: string): unknown;
     (command: 'set', key: string, value: string | string[]): void;
@@ -13,7 +38,6 @@ declare global {
     interface Window {
         clarity?: ClarityFunction & {
             q?: unknown[][];
-            v?: string;
         };
     }
 }
@@ -21,41 +45,28 @@ declare global {
  * Microsoft Clarity vendor manifest.
  *
  * Seeds the global queue stub before loading the vendor bundle and uses
- * Clarity's consent API for simple granted and denied transitions.
+ * Clarity's Consent V2 API for granular analytics and ad storage transitions.
  */
 export declare const clarityManifest: {
-    readonly vendor: "microsoft-clarity";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'microsoft-clarity';
+    readonly category: 'measurement';
     readonly persistAfterConsentRevoked: true;
     readonly bootstrap: [{
-        readonly type: "defineStubFunction";
-        readonly name: "clarity";
+        readonly type: 'defineStubFunction';
+        readonly name: 'clarity';
         readonly queue: {
-            readonly property: "q";
-        };
-        readonly queueFormat: "array";
-        readonly properties: {
-            readonly v: "0.7.0";
+            readonly property: 'q';
         };
+        readonly queueFormat: 'array';
         readonly ifUndefined: true;
     }];
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
     }];
-    readonly onConsentGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "clarity";
-        readonly args: ["consent", true];
-    }];
-    readonly onConsentDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "clarity";
-        readonly args: ["consent", false];
-    }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface ClarityOptions {
     /**
@@ -64,10 +75,11 @@ export interface ClarityOptions {
      */
     id: string;
     /**
-     * Optional initial consent value queued before the script loads.
+     * Optional initial Consent V2 value queued before the script loads.
      *
-     * Object-shaped advanced consent vectors are supported only for this initial
-     * boot-time value. Later c15t consent changes are mapped to simple booleans.
+     * By default, c15t maps `measurement` to `analytics_Storage` and `marketing`
+     * to `ad_Storage`. Pass this only when boot-time consent must override the
+     * current c15t consent state.
      */
     defaultConsent?: ClarityConsentValue;
     /** Clarity loader URL. */

package/dist-types/vendors/analytics/mixpanel-analytics.d.ts

@@ -9,61 +9,73 @@ declare global {
             register: (properties: Record<string, unknown>) => void;
             opt_in_tracking: () => void;
             opt_out_tracking: () => void;
+            /** Snippet version marker consumed by `init_from_snippet`. */
+            __SV?: number;
+            /** Pending `[token, config, instanceName]` init tuples consumed at SDK load. */
+            _i?: unknown[][];
         };
     }
 }
 /**
  * Mixpanel vendor manifest.
  *
+ * Implements the official snippet contract: the stub array carries the
+ * snippet version marker (`__SV`) and the pending `[token, config, 'mixpanel']`
+ * init tuple in `_i`, which `mixpanel-2-latest.min.js` consumes at load time via
+ * `init_from_snippet`. Without `__SV` the SDK logs "Mixpanel error: Version
+ * mismatch" and never initializes, silently dropping queued calls.
+ *
  * Mixpanel can stay loaded across consent changes and toggle tracking with its
  * own opt-in and opt-out APIs.
  */
 export declare const mixpanelAnalyticsManifest: {
-    readonly vendor: "mixpanel-analytics";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'mixpanel-analytics';
+    readonly category: 'measurement';
     readonly alwaysLoad: true;
     readonly install: [{
-        readonly type: "setGlobal";
-        readonly name: "mixpanel";
+        readonly type: 'setGlobal';
+        readonly name: 'mixpanel';
         readonly value: readonly [];
         readonly ifUndefined: true;
     }, {
-        readonly type: "defineQueueMethods";
-        readonly target: "mixpanel";
+        readonly type: 'setGlobalPath';
+        readonly path: ["mixpanel", "__SV"];
+        readonly value: 1.2;
+    }, {
+        readonly type: 'setGlobalPath';
+        readonly path: ["mixpanel", "_i"];
+        readonly value: readonly [readonly ["{{token}}", "{{initOptions}}", "mixpanel"]];
+    }, {
+        readonly type: 'defineQueueMethods';
+        readonly target: 'mixpanel';
         readonly methods: ["track", "identify", "reset", "register", "opt_in_tracking", "opt_out_tracking"];
     }, {
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
     }];
-    readonly afterLoad: [{
-        readonly type: "callGlobal";
-        readonly global: "mixpanel";
-        readonly method: "init";
-        readonly args: ["{{token}}", "{{initOptions}}"];
-    }];
     readonly onLoadGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "mixpanel";
-        readonly method: "opt_in_tracking";
+        readonly type: 'callGlobal';
+        readonly global: 'mixpanel';
+        readonly method: 'opt_in_tracking';
     }];
     readonly onLoadDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "mixpanel";
-        readonly method: "opt_out_tracking";
+        readonly type: 'callGlobal';
+        readonly global: 'mixpanel';
+        readonly method: 'opt_out_tracking';
     }];
     readonly onConsentGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "mixpanel";
-        readonly method: "opt_in_tracking";
+        readonly type: 'callGlobal';
+        readonly global: 'mixpanel';
+        readonly method: 'opt_in_tracking';
     }];
     readonly onConsentDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "mixpanel";
-        readonly method: "opt_out_tracking";
+        readonly type: 'callGlobal';
+        readonly global: 'mixpanel';
+        readonly method: 'opt_out_tracking';
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface MixpanelAnalyticsOptions {
     /** Your Mixpanel project token. */

package/dist-types/vendors/analytics/pirsch.d.ts

@@ -0,0 +1,96 @@
+import type { Script } from 'c15t';
+declare global {
+    interface Window {
+        pirsch?: (eventName: string, options?: {
+            duration?: number;
+            meta?: Record<string, unknown>;
+            non_interactive?: boolean;
+        }) => Promise<null | undefined>;
+        pirschClearSession?: () => void;
+        pirschInit?: () => void;
+        pirschNotFound?: () => void;
+    }
+}
+/**
+ * Pirsch vendor manifest.
+ *
+ * Configures Pirsch through script attributes. Pirsch finds the script element
+ * by a fixed element id, so the `id` attribute is part of the loader contract.
+ */
+export declare const pirschManifest: {
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'pirsch';
+    readonly category: 'measurement';
+    readonly install: [{
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
+        readonly defer: true;
+        readonly attributes: {
+            readonly id: '{{scriptElementId}}';
+            readonly 'data-code': '{{identificationCode}}';
+            readonly 'data-domain': '{{domain}}';
+            readonly 'data-dev': '{{dev}}';
+            readonly 'data-hit-endpoint': '{{hitEndpoint}}';
+            readonly 'data-event-endpoint': '{{eventEndpoint}}';
+            readonly 'data-disable-page-views': '{{disablePageViews}}';
+        };
+    }];
+};
+export interface PirschOptions {
+    /**
+     * Your Pirsch identification code.
+     */
+    identificationCode: string;
+    /**
+     * Additional dashboard domains, optionally including per-domain codes.
+     *
+     * Arrays are serialized as Pirsch's comma-separated `data-domain` value.
+     */
+    domain?: string | string[];
+    /**
+     * Enable localhost testing by rewriting the tracked hostname.
+     */
+    dev?: string;
+    /**
+     * Custom pageview endpoint.
+     */
+    hitEndpoint?: string;
+    /**
+     * Custom event endpoint.
+     */
+    eventEndpoint?: string;
+    /**
+     * Disable automatic pageview tracking.
+     */
+    disablePageViews?: boolean;
+    /**
+     * Load Pirsch's extended script variant.
+     */
+    extended?: boolean;
+    /**
+     * Custom loader URL.
+     */
+    scriptUrl?: string;
+}
+/**
+ * Creates a Pirsch Analytics script.
+ *
+ * @see https://docs.pirsch.io/get-started/frontend-integration
+ *
+ * @param options - The options for the Pirsch script.
+ * @returns The Pirsch script.
+ * @throws {Error} When `identificationCode` is missing, empty, or invalid.
+ * Provide a valid non-empty `identificationCode` string to prevent this error.
+ *
+ * @example
+ * ```ts
+ * import { pirsch } from '@c15t/scripts/pirsch';
+ *
+ * pirsch({
+ *   identificationCode: 'YOUR_IDENTIFICATION_CODE',
+ *   domain: 'rollup.example.com:ROLLUP_CODE',
+ * });
+ * ```
+ */
+export declare function pirsch(options: PirschOptions): Script;

package/dist-types/vendors/analytics/plausible-analytics.d.ts

@@ -27,31 +27,31 @@ declare global {
  * unloaded when consent is revoked.
  */
 export declare const plausibleAnalyticsManifest: {
-    readonly vendor: "plausible-analytics";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'plausible-analytics';
+    readonly category: 'measurement';
     readonly bootstrap: [{
-        readonly type: "defineStubFunction";
-        readonly name: "plausible";
+        readonly type: 'defineStubFunction';
+        readonly name: 'plausible';
         readonly queue: {
-            readonly property: "q";
+            readonly property: 'q';
         };
-        readonly queueFormat: "array";
+        readonly queueFormat: 'array';
         readonly properties: {
-            readonly o: "{{initOptions}}";
+            readonly o: '{{initOptions}}';
         };
         readonly ifUndefined: true;
     }];
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly defer: true;
         readonly attributes: {
-            readonly 'data-domain': "{{domain}}";
-            readonly 'data-api': "{{apiAttribute}}";
+            readonly 'data-domain': '{{domain}}';
+            readonly 'data-api': '{{apiAttribute}}';
         };
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface PlausibleAnalyticsOptions {
     /**

package/dist-types/vendors/analytics/posthog.d.ts

@@ -12,6 +12,12 @@ declare global {
             opt_out_capturing: () => void;
             get_explicit_consent_status: () => string;
             capture: (event: string, properties?: Record<string, unknown>) => void;
+            /**
+             * Pending `[token, config, instanceName]` init tuples, as seeded by
+             * the official PostHog snippet. `array.js` only installs its runtime
+             * over an existing `window.posthog` when this is an array.
+             */
+            _i?: unknown[][];
         };
     }
 }
@@ -25,73 +31,85 @@ export type PosthogLoadMode = 'always' | 'after-consent' | 'disabled';
  * measurement consent is granted.
  */
 export declare const posthogManifest: {
-    readonly vendor: "posthog";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'posthog';
+    readonly category: 'measurement';
     readonly alwaysLoad: true;
     readonly bootstrap: [{
-        readonly type: "setGlobal";
-        readonly name: "posthog";
-        readonly value: {};
+        readonly type: 'setGlobal';
+        readonly name: 'posthog';
+        readonly value: readonly [];
         readonly ifUndefined: true;
     }, {
-        readonly type: "defineGlobalMethods";
-        readonly target: "posthog";
+        readonly type: 'setGlobalPath';
+        readonly path: ["posthog", "_i"];
+        readonly value: readonly [readonly ["{{id}}", "{{initOptions}}", "posthog"]];
+        readonly ifGlobalIsQueue: true;
+    }, {
+        readonly type: 'setGlobalPath';
+        readonly path: ["posthog", "people"];
+        readonly value: readonly [];
+        readonly ifGlobalIsQueue: true;
+    }, {
+        readonly type: 'defineQueueMethods';
+        readonly target: 'posthog';
+        readonly methods: ["capture", "opt_in_capturing", "opt_out_capturing"];
+    }, {
+        readonly type: 'defineGlobalMethods';
+        readonly target: 'posthog';
+        readonly ifGlobalIsQueue: true;
         readonly methods: [{
-            readonly name: "init";
-            readonly behavior: "noop";
-        }, {
-            readonly name: "capture";
-            readonly behavior: "noop";
+            readonly name: 'init';
+            readonly behavior: 'noop';
         }, {
-            readonly name: "opt_in_capturing";
-            readonly behavior: "noop";
-        }, {
-            readonly name: "opt_out_capturing";
-            readonly behavior: "noop";
-        }, {
-            readonly name: "get_explicit_consent_status";
-            readonly behavior: "return";
-            readonly value: "pending";
+            readonly name: 'get_explicit_consent_status';
+            readonly behavior: 'return';
+            readonly value: 'pending';
         }];
     }];
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
         readonly attributes: {
-            readonly crossorigin: "anonymous";
-            readonly 'data-api-host': "{{apiHost}}";
-            readonly 'data-ui-host': "{{uiHost}}";
+            readonly crossorigin: 'anonymous';
+            readonly 'data-api-host': '{{apiHost}}';
+            readonly 'data-ui-host': '{{uiHost}}';
         };
     }];
-    readonly afterLoad: [{
-        readonly type: "callGlobal";
-        readonly global: "posthog";
-        readonly method: "init";
-        readonly args: ["{{id}}", "{{initOptions}}"];
+    readonly onBeforeLoadGranted: [{
+        readonly type: 'pushToQueue';
+        readonly queue: 'posthog';
+        readonly value: readonly ["opt_in_capturing", {
+            readonly captureEventName: null;
+        }];
+    }];
+    readonly onBeforeLoadDenied: [{
+        readonly type: 'pushToQueue';
+        readonly queue: 'posthog';
+        readonly value: readonly ["opt_out_capturing"];
     }];
     readonly onLoadGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "posthog";
-        readonly method: "opt_in_capturing";
+        readonly type: 'callGlobal';
+        readonly global: 'posthog';
+        readonly method: 'opt_in_capturing';
     }];
     readonly onLoadDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "posthog";
-        readonly method: "opt_out_capturing";
+        readonly type: 'callGlobal';
+        readonly global: 'posthog';
+        readonly method: 'opt_out_capturing';
     }];
     readonly onConsentGranted: [{
-        readonly type: "callGlobal";
-        readonly global: "posthog";
-        readonly method: "opt_in_capturing";
+        readonly type: 'callGlobal';
+        readonly global: 'posthog';
+        readonly method: 'opt_in_capturing';
     }];
     readonly onConsentDenied: [{
-        readonly type: "callGlobal";
-        readonly global: "posthog";
-        readonly method: "opt_out_capturing";
+        readonly type: 'callGlobal';
+        readonly global: 'posthog';
+        readonly method: 'opt_out_capturing';
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface PosthogConsentOptions {
     /**

package/dist-types/vendors/analytics/promptwatch.d.ts

@@ -5,18 +5,18 @@ import type { Script } from 'c15t';
  * Loads the Promptwatch client with your project id on the script element.
  */
 export declare const promptwatchManifest: {
-    readonly vendor: "promptwatch";
-    readonly category: "measurement";
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+    readonly vendor: 'promptwatch';
+    readonly category: 'measurement';
     readonly install: [{
-        readonly type: "loadScript";
-        readonly src: "{{scriptUrl}}";
+        readonly type: 'loadScript';
+        readonly src: '{{scriptUrl}}';
         readonly async: true;
         readonly attributes: {
-            readonly 'data-project-id': "{{projectId}}";
+            readonly 'data-project-id': '{{projectId}}';
         };
     }];
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
 };
 export interface PromptwatchOptions {
     /** Your Promptwatch project id (UUID from the Promptwatch dashboard). */