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

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

@@ -1,60 +1,2 @@
-import type { Script } from '@c15t/core';
-/**
- * Clearbit vendor manifest.
- *
- * Loads Clearbit's visitor and company enrichment tag from the account-keyed
- * `tags.js` endpoint. Clearbit enrichment can identify visitors and companies,
- * so the default consent category is `marketing` rather than `measurement`.
- * The GitHub issue left the category open between measurement and marketing;
- * c15t treats enrichment and intent profiling as marketing-sensitive.
- */
-export declare const clearbitManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'marketing';
-    readonly install: [{
-        readonly attributes: {
-            readonly referrerpolicy: 'strict-origin-when-cross-origin';
-        };
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'clearbit';
-};
-export interface ClearbitOptions {
-    /**
-     * Your Clearbit publishable key.
-     */
-    publishableKey: string;
-    /**
-     * Custom loader URL.
-     * @default `https://tag.clearbitscripts.com/v1/{publishableKey}/tags.js`
-     */
-    scriptUrl?: string;
-}
-/**
- * Creates a Clearbit enrichment script.
- *
- * @see https://help.clearbit.com/hc/en-us/articles/4420022080783 — installing the Clearbit tag
- *
- * @param options - The options for the Clearbit script.
- * @returns The Clearbit script.
- * @throws {Error} When `publishableKey` is missing, empty, or invalid.
- * Provide a valid non-empty `publishableKey` string to prevent this error.
- *
- * @remarks
- * Clearbit identifies visitors and companies for enrichment and intent use
- * cases. This helper therefore uses the `marketing` consent category by
- * default even though Clearbit is listed with analytics integrations for
- * discovery.
- *
- * @example
- * ```ts
- * import { clearbit } from '@c15t/scripts/clearbit';
- *
- * clearbit({
- *   publishableKey: 'YOUR_PUBLISHABLE_KEY',
- * });
- * ```
- */
-export declare const clearbit: (options: ClearbitOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/clearbit. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/clearbit';

package/dist-types/vendors/analytics/cloudflare-web-analytics.d.ts

@@ -1,67 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        __cfBeacon?: {
-            spa?: boolean;
-            token: string;
-        };
-    }
-}
-/**
- * Cloudflare Web Analytics vendor manifest.
- *
- * Serializes Cloudflare's beacon config into the `data-cf-beacon` attribute.
- * Cloudflare Web Analytics is cookieless, so the script is consent-gated on
- * `measurement` and unloaded when consent is revoked.
- */
-export declare const cloudflareWebAnalyticsManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly attributes: {
-            readonly 'data-cf-beacon': '{{beaconConfig}}';
-        };
-        readonly defer: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'cloudflare-web-analytics';
-};
-export interface CloudflareWebAnalyticsOptions {
-    /**
-     * Your Cloudflare Web Analytics token.
-     */
-    token: string;
-    /**
-     * Enable Cloudflare's SPA route tracking.
-     * @default true
-     */
-    spa?: boolean;
-    /**
-     * Custom loader URL.
-     * @default 'https://static.cloudflareinsights.com/beacon.min.js'
-     */
-    scriptUrl?: string;
-}
-/**
- * Creates a Cloudflare Web Analytics script.
- *
- * @see https://developers.cloudflare.com/analytics/web-analytics/get-started/
- *
- * @param options - The options for the Cloudflare Web Analytics script.
- * @returns The Cloudflare Web Analytics script.
- * @throws {Error} Throws `cloudflareWebAnalytics: missing token` when
- * `options.token` is missing, invalid, or trims to an empty string.
- *
- * @example
- * ```ts
- * import { cloudflareWebAnalytics } from '@c15t/scripts/cloudflare-web-analytics';
- *
- * cloudflareWebAnalytics({
- *   token: 'abc123...',
- *   spa: true,
- * });
- * ```
- */
-export declare const cloudflareWebAnalytics: (options: CloudflareWebAnalyticsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/cloudflare-web-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/cloudflare-web-analytics';

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

@@ -1,147 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        databuddy?: {
-            track: (eventName: string, properties?: Record<string, unknown>) => void;
-            screenView: (screenName?: string, properties?: Record<string, unknown>) => void;
-            clear: () => void;
-            flush: () => void;
-            setGlobalProperties: (properties: Record<string, unknown>) => void;
-            trackCustomEvent: (eventName: string, properties?: Record<string, unknown>) => void;
-            options: {
-                disabled: boolean;
-                [key: string]: unknown;
-            };
-        };
-        databuddyConfig?: {
-            clientId?: string;
-            apiUrl?: string;
-            [key: string]: unknown;
-        };
-    }
-}
-/**
- * DataBuddy vendor manifest.
- *
- * DataBuddy always loads but controls tracking via its `options.disabled` flag.
- * Config is seeded via `window.databuddyConfig` before the script loads.
- */
-export declare const databuddyManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly alwaysLoad: true;
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly async: true;
-        readonly attributes: {
-            readonly crossorigin: 'anonymous';
-            readonly 'data-api-url': '{{apiUrl}}';
-            readonly 'data-client-id': '{{clientId}}';
-        };
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly onBeforeLoadDenied: [{
-        readonly ifUndefined: true;
-        readonly name: 'databuddyConfig';
-        readonly type: 'setGlobal';
-        readonly value: '{{configWhenDenied}}';
-    }];
-    readonly onBeforeLoadGranted: [{
-        readonly ifUndefined: true;
-        readonly name: 'databuddyConfig';
-        readonly type: 'setGlobal';
-        readonly value: '{{configWhenGranted}}';
-    }];
-    readonly onConsentDenied: [{
-        readonly ifUndefined: false;
-        readonly name: 'databuddyConfig';
-        readonly type: 'setGlobal';
-        readonly value: '{{configWhenDenied}}';
-    }, {
-        readonly path: ["databuddy", "options", "disabled"];
-        readonly type: 'setGlobalPath';
-        readonly value: true;
-    }];
-    readonly onConsentGranted: [{
-        readonly ifUndefined: false;
-        readonly name: 'databuddyConfig';
-        readonly type: 'setGlobal';
-        readonly value: '{{configWhenGranted}}';
-    }, {
-        readonly path: ["databuddy", "options", "disabled"];
-        readonly type: 'setGlobalPath';
-        readonly value: false;
-    }];
-    readonly onLoadDenied: [{
-        readonly path: ["databuddy", "options", "disabled"];
-        readonly type: 'setGlobalPath';
-        readonly value: true;
-    }];
-    readonly onLoadGranted: [{
-        readonly path: ["databuddy", "options", "disabled"];
-        readonly type: 'setGlobalPath';
-        readonly value: false;
-    }];
-    readonly vendor: 'databuddy';
-};
-export interface DatabuddyConsentOptions {
-    /**
-     * Your Databuddy client ID.
-     */
-    clientId: string;
-    /**
-     * Your Databuddy API URL.
-     * @default 'https://basket.databuddy.cc'
-     */
-    apiUrl?: string;
-    /**
-     * The Databuddy script URL.
-     * @default 'https://cdn.databuddy.cc/databuddy.js'
-     */
-    scriptUrl?: string;
-    /** Databuddy config object to seed when consent is granted at load time. */
-    configWhenGranted: Record<string, unknown>;
-    /** Databuddy config object to seed when consent is denied at load time. */
-    configWhenDenied: Record<string, unknown>;
-}
-/**
- * Loads the Databuddy script and manages consent state declaratively via the manifest runtime.
- *
- * The script always loads (`alwaysLoad: true`) but tracking is controlled via the `disabled`
- * flag on Databuddy's global config/runtime objects, allowing the vendor to stay present in
- * the DOM while respecting consent boundaries.
- *
- * @param options - Configuration for the Databuddy consent script
- * @returns The Databuddy script configuration object for c15t's script loader
- *
- * @example
- * ```ts
- * import { createConsentKernel } from 'c15t';
- * import { createScriptLoader } from 'c15t/modules/script-loader';
- * import { databuddy } from '@c15t/scripts/databuddy';
- *
- * const kernel = createConsentKernel();
- * const loader = createScriptLoader({
- *   kernel,
- *   scripts: [
- *     databuddy({
- *       clientId: 'db_1234567890abcdef',
- *       configWhenGranted: {
- *         clientId: 'db_1234567890abcdef',
- *         trackScreenViews: true,
- *         trackOutgoingLinks: true,
- *         trackPerformance: true,
- *         samplingRate: 1.0,
- *         disabled: false,
- *       },
- *       configWhenDenied: {
- *         clientId: 'db_1234567890abcdef',
- *         disabled: true,
- *       },
- *     }),
- *   ],
- * });
- * ```
- */
-export declare const databuddy: (options: DatabuddyConsentOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/databuddy. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/databuddy';

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

@@ -1,90 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        fathom?: {
-            blockTrackingForMe: () => void;
-            enableTrackingForMe: () => void;
-            trackEvent: (eventName: string, opts?: {
-                _value?: number;
-            }) => void;
-            trackGoal: (goalId: string, cents: number) => void;
-            trackPageview: (opts?: {
-                url: string;
-                referrer?: string;
-            }) => void;
-        };
-    }
-}
-/**
- * Fathom Analytics vendor manifest.
- *
- * Configures Fathom via script `data-*` attributes. Fathom is a cookieless
- * analytics product, so the script is consent-gated on `measurement` and
- * unloaded when consent is revoked.
- */
-export declare const fathomAnalyticsManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly attributes: {
-            readonly 'data-auto': '{{autoAttribute}}';
-            readonly 'data-canonical': '{{canonicalAttribute}}';
-            readonly 'data-honor-dnt': '{{honorDntAttribute}}';
-            readonly 'data-site': '{{site}}';
-            readonly 'data-spa': '{{spa}}';
-        };
-        readonly defer: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'fathom-analytics';
-};
-export interface FathomAnalyticsOptions {
-    /**
-     * Your Fathom Analytics site ID.
-     */
-    site: string;
-    /**
-     * The SPA tracking mode. When undefined, SPA auto-routing is disabled and
-     * the `data-spa` attribute is omitted.
-     */
-    spa?: 'auto' | 'history' | 'hash';
-    /**
-     * Automatically track page views.
-     */
-    auto?: boolean;
-    /**
-     * Enable canonical URL tracking.
-     */
-    canonical?: boolean;
-    /**
-     * Honor Do Not Track requests.
-     */
-    honorDnt?: boolean;
-    /**
-     * Custom loader URL.
-     * @default 'https://cdn.usefathom.com/script.js'
-     */
-    scriptUrl?: string;
-}
-/**
- * Creates a Fathom Analytics script.
- *
- * @see https://usefathom.com/docs/script/script-settings
- *
- * @param options - The options for the Fathom Analytics script.
- * @returns The Fathom Analytics script.
- *
- * @example
- * ```ts
- * import { fathomAnalytics } from '@c15t/scripts/fathom-analytics';
- *
- * fathomAnalytics({
- *   site: 'SITE123',
- *   spa: 'history',
- *   canonical: true,
- * });
- * ```
- */
-export declare const fathomAnalytics: (options: FathomAnalyticsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/fathom-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/fathom-analytics';

package/dist-types/vendors/analytics/google-tag.d.ts

@@ -1,95 +1,2 @@
-import type { AllConsentNames, Script } from '@c15t/core';
-declare global {
-    interface Window {
-        dataLayer: unknown[];
-        gtag: (...args: unknown[]) => void;
-    }
-}
-/**
- * Google Tag (gtag.js) vendor manifest.
- *
- * Similar to GTM but for direct Google product integration (Analytics, Ads, Floodlight).
- * Uses the same Consent Mode v2 mapping.
- */
-export declare const gtagManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly alwaysLoad: true;
-    readonly bootstrap: [{
-        readonly ifUndefined: true;
-        readonly name: 'dataLayer';
-        readonly type: 'setGlobal';
-        readonly value: readonly [];
-    }, {
-        readonly ifUndefined: true;
-        readonly name: 'gtag';
-        readonly queue: 'dataLayer';
-        readonly type: 'defineQueueFunction';
-    }];
-    readonly category: '{{category}}';
-    readonly consentMapping: Record<string, string[]>;
-    readonly consentSignal: 'gtag';
-    readonly install: [{
-        readonly args: ["js", {
-            readonly kind: "c15t.runtime-value";
-            readonly value: 'date';
-        }];
-        readonly global: 'gtag';
-        readonly type: 'callGlobal';
-    }, {
-        readonly args: ["config", "{{id}}"];
-        readonly global: 'gtag';
-        readonly type: 'callGlobal';
-    }, {
-        readonly async: true;
-        readonly src: 'https://www.googletagmanager.com/gtag/js?id={{id}}';
-        readonly type: 'loadScript';
-    }];
-    readonly persistAfterConsentRevoked: true;
-    readonly vendor: 'gtag';
-};
-export interface GtagOptions {
-    /** Parameters forwarded to gtag config. */
-    config?: Record<string, unknown>;
-    /**
-     * Your gtag id
-     * @example `G-XXXXXXX`
-     */
-    id: string;
-    /**
-     * The consent category to use for the gtag script. This is typically marketing (Ads & Floodlight) or measurement (Analytics)
-     * @example 'marketing'
-     */
-    category: AllConsentNames;
-    /**
-     * Custom mapping from c15t consent categories to Google Consent Mode v2 types.
-     * Overrides the default mapping when provided.
-     *
-     * @default
-     * ```ts
-     * {
-     *   necessary: ['security_storage'],
-     *   functionality: ['functionality_storage'],
-     *   measurement: ['analytics_storage'],
-     *   marketing: ['ad_storage', 'ad_user_data', 'ad_personalization'],
-     *   experience: ['personalization_storage'],
-     * }
-     * ```
-     */
-    consentMapping?: Record<string, string[]>;
-    /**
-     * Deprecated script-level overrides preserved for backwards compatibility.
-     *
-     * Prefer manifest-backed options instead of this generic override bag.
-     * @deprecated
-     */
-    script?: Partial<Script>;
-}
-/**
- * Creates a Google Tag (gtag.js) script.
- * Allows you to send data website to linked Google products like Analytics, Ads & Floodlight.
- *
- * @param options - The options for the gtag script.
- * @returns The Google Tag Manager script.
- */
-export declare const gtag: ({ id, config, category, consentMapping, script, }: GtagOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/google-tag. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/google-tag';