@c15t/scripts 3.0.0-alpha.2 → 3.0.0-alpha.4

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

@@ -1,101 +1,2 @@
-import type { Script } from '@c15t/core';
-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 afterLoad: [{
-        readonly args: ["{{appId}}", "{{initOptions}}"];
-        readonly global: 'LogRocket';
-        readonly method: 'init';
-        readonly type: 'callGlobal';
-    }];
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly attributes: {
-            readonly crossorigin: 'anonymous';
-        };
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'logrocket';
-};
-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 const logRocket: (options: LogRocketOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/logrocket. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/logrocket';

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

@@ -1,41 +1,2 @@
-import type { Script } from '@c15t/core';
-import type { VendorManifest } from '../../types.js';
-declare global {
-    interface Window {
-        _paq?: unknown[];
-    }
-}
-export declare const matomoAnalyticsManifest: VendorManifest;
-export interface MatomoAnalyticsOptions {
-    /** Your Matomo site ID. */
-    siteId?: string | number;
-    /** Your Matomo base URL, for example `https://analytics.example.com`. */
-    matomoUrl?: string;
-    /** Your Matomo Cloud identifier, for example `my-site.matomo.cloud`. */
-    cloudId?: string;
-    /** Optional explicit tracker endpoint override. */
-    trackerUrl?: string;
-    /** Optional explicit script URL override. */
-    scriptUrl?: string;
-    /** Queue `enableLinkTracking`. */
-    enableLinkTracking?: boolean;
-    /** Queue `disableCookies`. */
-    disableCookies?: boolean;
-    /** Queue an initial `trackPageView`. */
-    trackPageView?: boolean;
-    /** Default Matomo consent state (`required` blocks, `given` starts enabled). */
-    defaultConsent?: 'required' | 'given';
-}
-/**
- * Creates a Matomo Analytics script.
- *
- * @param options - The options for the Matomo Analytics script.
- * @returns The Matomo Analytics script configuration.
- * @throws {Error} Throws
- * `'matomoAnalytics requires \`matomoUrl\`, \`cloudId\`, or explicit \`trackerUrl\` and \`scriptUrl\` values.'`
- * when either resolved `trackerUrl` or `scriptUrl` is missing (for example,
- * when neither `matomoUrl` nor `cloudId` is provided and explicit
- * `trackerUrl`/`scriptUrl` values are not supplied). Provide `matomoUrl`, or
- * provide both explicit `trackerUrl` and `scriptUrl`.
- */
-export declare const matomoAnalytics: (options?: MatomoAnalyticsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/matomo-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/matomo-analytics';

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

@@ -1,97 +1,2 @@
-import type { Script } from '@c15t/core';
-/**
- * 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>>;
-interface ClarityFunction {
-    (command: 'consent', value?: boolean): void;
-    (command: 'consentv2', value: ClarityConsentV2Payload): void;
-    (command: 'event' | 'upgrade', value: string): void;
-    (command: 'identify', id: string, session?: string, page?: string): unknown;
-    (command: 'set', key: string, value: string | string[]): void;
-    (command: 'start', options?: Record<string, unknown>): void;
-    (command: string, ...args: unknown[]): unknown;
-}
-declare global {
-    interface Window {
-        clarity?: ClarityFunction & {
-            q?: unknown[][];
-        };
-    }
-}
-/**
- * Microsoft Clarity vendor manifest.
- *
- * Seeds the global queue stub before loading the vendor bundle and uses
- * Clarity's Consent V2 API for granular analytics and ad storage transitions.
- */
-export declare const clarityManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly bootstrap: [{
-        readonly ifUndefined: true;
-        readonly name: 'clarity';
-        readonly queue: {
-            readonly property: 'q';
-        };
-        readonly queueFormat: 'array';
-        readonly type: 'defineStubFunction';
-    }];
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly async: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly persistAfterConsentRevoked: true;
-    readonly vendor: 'microsoft-clarity';
-};
-export interface ClarityOptions {
-    /**
-     * Your Microsoft Clarity project ID.
-     * @example `abcdef1234`
-     */
-    id: string;
-    /**
-     * Optional initial Consent V2 value queued before the script loads.
-     *
-     * 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. */
-    scriptUrl?: string;
-}
-/**
- * Creates a Microsoft Clarity script.
- *
- * @param options - The options for the Clarity script.
- * @returns The Clarity script configuration.
- * @throws {Error} When `options.id` is missing or invalid and no `scriptUrl`
- * override is provided. Provide a valid Clarity project id string to prevent
- * this error.
- */
-export declare const clarity: ({ id, defaultConsent, scriptUrl, }: ClarityOptions) => Script;
-export {};
+/** @deprecated Use @c15t/integrations/vendors/analytics/microsoft-clarity. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/microsoft-clarity';

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

@@ -1,113 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        mixpanel?: {
-            init: (token: string, config?: Record<string, unknown>) => void;
-            track: (event: string, properties?: Record<string, unknown>) => void;
-            identify: (distinctId: string) => void;
-            reset: () => void;
-            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 kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly alwaysLoad: true;
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly ifUndefined: true;
-        readonly name: 'mixpanel';
-        readonly type: 'setGlobal';
-        readonly value: readonly [];
-    }, {
-        readonly path: ["mixpanel", "__SV"];
-        readonly type: 'setGlobalPath';
-        readonly value: 1.2;
-    }, {
-        readonly path: ["mixpanel", "_i"];
-        readonly type: 'setGlobalPath';
-        readonly value: readonly [readonly ["{{token}}", "{{initOptions}}", "mixpanel"]];
-    }, {
-        readonly methods: ["track", "identify", "reset", "register", "opt_in_tracking", "opt_out_tracking"];
-        readonly target: 'mixpanel';
-        readonly type: 'defineQueueMethods';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly onConsentDenied: [{
-        readonly global: 'mixpanel';
-        readonly method: 'opt_out_tracking';
-        readonly type: 'callGlobal';
-    }];
-    readonly onConsentGranted: [{
-        readonly global: 'mixpanel';
-        readonly method: 'opt_in_tracking';
-        readonly type: 'callGlobal';
-    }];
-    readonly onLoadDenied: [{
-        readonly global: 'mixpanel';
-        readonly method: 'opt_out_tracking';
-        readonly type: 'callGlobal';
-    }];
-    readonly onLoadGranted: [{
-        readonly global: 'mixpanel';
-        readonly method: 'opt_in_tracking';
-        readonly type: 'callGlobal';
-    }];
-    readonly vendor: 'mixpanel-analytics';
-};
-export interface MixpanelAnalyticsOptions {
-    /** Your Mixpanel project token. */
-    token: string;
-    /**
-     * Mixpanel init options passed after the library loads.
-     *
-     * 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). Named instances and nested
-     * `people.*` queue helpers are intentionally out of scope for this helper.
-     */
-    initOptions?: Record<string, unknown>;
-    /** Mixpanel loader URL. */
-    scriptUrl?: string;
-}
-/**
- * Creates a Mixpanel Analytics script.
- *
- * @param options - The options for the Mixpanel Analytics script.
- * @returns The Mixpanel Analytics script configuration.
- * @throws {Error} Throws when `token` is not a non-empty 32-character
- * hexadecimal Mixpanel project token.
- *
- * @example
- * ```ts
- * import { mixpanelAnalytics } from '@c15t/scripts/mixpanel-analytics';
- *
- * const script = mixpanelAnalytics({
- * 	token: '1234567890abcdef1234567890abcdef',
- * 	initOptions: { debug: true },
- * });
- * ```
- */
-export declare const mixpanelAnalytics: ({ token, initOptions, scriptUrl, }: MixpanelAnalyticsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/mixpanel-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/mixpanel-analytics';

package/dist-types/vendors/analytics/one-dollar-stats.d.ts

@@ -1,39 +1,2 @@
-import type { Script } from '@c15t/core';
-/** The classic script from OneDollarStats' installation instructions. */
-export declare const ONE_DOLLAR_STATS_SCRIPT_SRC = "https://assets.onedollarstats.com/stonks.js";
-/** OneDollarStats is loaded only after measurement consent is granted. */
-export declare const oneDollarStatsManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly defer: true;
-        readonly src: "https://assets.onedollarstats.com/stonks.js";
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'one-dollar-stats';
-};
-export interface OneDollarStatsOptions {
-    /**
-     * Bare hostname, such as `docs.example.com`. Overrides the event hostname
-     * on every host, including production. Required for local dev mode.
-     */
-    hostname?: string;
-    /**
-     * Tracker settings forwarded as `data-*` attributes. Use string values,
-     * e.g. `devmode: 'true'`, `autocollect: 'false'`, or a custom `url`.
-     * Setting `'hash-routing': 'false'` omits the presence-based attribute.
-     */
-    [setting: string]: string | undefined;
-}
-/**
- * Creates a consent-gated OneDollarStats script. No API key is required.
- * The tracker reads data attributes from `document.currentScript` and
- * handles client-side navigation itself.
- *
- * @param options - Tracker settings without the `data-` prefix.
- * @returns The OneDollarStats script configuration.
- * @throws {Error} When hostname is not a bare host, or a setting name is not
- * a valid attribute name or its value is not a string.
- */
-export declare const oneDollarStats: (options?: OneDollarStatsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/one-dollar-stats. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/one-dollar-stats';

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

@@ -1,96 +1,2 @@
-import type { Script } from '@c15t/core';
-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 category: 'measurement';
-    readonly install: [{
-        readonly attributes: {
-            readonly 'data-code': '{{identificationCode}}';
-            readonly 'data-dev': '{{dev}}';
-            readonly 'data-disable-page-views': '{{disablePageViews}}';
-            readonly 'data-domain': '{{domain}}';
-            readonly 'data-event-endpoint': '{{eventEndpoint}}';
-            readonly 'data-hit-endpoint': '{{hitEndpoint}}';
-            readonly id: '{{scriptElementId}}';
-        };
-        readonly defer: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'pirsch';
-};
-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 const pirsch: (options: PirschOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/pirsch. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/pirsch';

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

@@ -1,122 +1,2 @@
-import type { Script } from '@c15t/core';
-export type PlausibleExtension = 'hash' | 'outbound-links' | 'file-downloads' | 'tagged-events' | 'revenue' | 'pageview-props' | 'compat' | 'local' | 'manual';
-export interface PlausibleInitOptions {
-    customProperties?: Record<string, unknown>;
-    endpoint?: string;
-    fileDownloads?: {
-        fileExtensions?: string[];
-    };
-    hashBasedRouting?: boolean;
-    autoCapturePageviews?: boolean;
-    captureOnLocalhost?: boolean;
-}
-declare global {
-    interface Window {
-        plausible?: ((...args: unknown[]) => void) & {
-            o?: PlausibleInitOptions;
-            q?: unknown[][];
-        };
-    }
-}
-/**
- * Plausible Analytics vendor manifest.
- *
- * Seeds a small queue stub so early `window.plausible(...)` calls can be
- * buffered before the real tracker loads. Plausible is cookieless and only
- * tracks page views, so the script is gated on `measurement` consent and is
- * unloaded when consent is revoked.
- */
-export declare const plausibleAnalyticsManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly bootstrap: [{
-        readonly ifUndefined: true;
-        readonly name: 'plausible';
-        readonly properties: {
-            readonly o: '{{initOptions}}';
-        };
-        readonly queue: {
-            readonly property: 'q';
-        };
-        readonly queueFormat: 'array';
-        readonly type: 'defineStubFunction';
-    }];
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly attributes: {
-            readonly 'data-api': '{{apiAttribute}}';
-            readonly 'data-domain': '{{domain}}';
-        };
-        readonly defer: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'plausible-analytics';
-};
-export interface PlausibleAnalyticsOptions {
-    /**
-     * Unique Plausible script ID for the new script format.
-     */
-    scriptId?: string;
-    /**
-     * Legacy domain-based site identifier.
-     */
-    domain?: string;
-    /**
-     * Legacy script extensions.
-     */
-    extension?: PlausibleExtension | PlausibleExtension[];
-    /**
-     * Properties tracked with each pageview.
-     */
-    customProperties?: Record<string, unknown>;
-    /**
-     * Custom tracking endpoint.
-     */
-    endpoint?: string;
-    /**
-     * File download tracking configuration.
-     */
-    fileDownloads?: {
-        fileExtensions?: string[];
-    };
-    /**
-     * Enable hash-based routing support.
-     */
-    hashBasedRouting?: boolean;
-    /**
-     * Disable automatic pageview capture when set to `false`.
-     */
-    autoCapturePageviews?: boolean;
-    /**
-     * Enable tracking on localhost.
-     */
-    captureOnLocalhost?: boolean;
-    /**
-     * Custom loader URL.
-     */
-    scriptUrl?: string;
-}
-/**
- * Creates a Plausible Analytics script.
- *
- * Models Plausible's queue bootstrap and loader attributes as a c15t-managed
- * script. Supports both the new `scriptId`-based loader and the legacy
- * `domain` + extension-based loader.
- *
- * @see https://plausible.io/docs/script-extensions
- *
- * @param options - The options for the Plausible Analytics script.
- * @returns The Plausible Analytics script.
- *
- * @example
- * ```ts
- * import { plausibleAnalytics } from '@c15t/scripts/plausible-analytics';
- *
- * plausibleAnalytics({
- *   domain: 'example.com',
- *   extension: ['file-downloads', 'outbound-links'],
- * });
- * ```
- */
-export declare const plausibleAnalytics: (options: PlausibleAnalyticsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/plausible-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/plausible-analytics';