@c15t/scripts 3.0.0-alpha.1 → 3.0.0-alpha.3

package/dist-types/vendors/ads-and-pixels/reddit-pixel.d.ts

@@ -1,210 +1,2 @@
-import type { Script } from '@c15t/core';
-/**
- * Reddit Pixel standard conversion event names.
- *
- * @see {@link https://business.reddithelp.com/s/article/supported-conversion-events | Reddit supported conversion events}
- */
-export type RedditPixelEventName = 'PageVisit' | 'ViewContent' | 'Search' | 'AddToCart' | 'AddToWishlist' | 'Purchase' | 'Lead' | 'SignUp';
-/**
- * Controls Reddit Pixel automatic advanced matching signals.
- *
- * @see {@link https://business.reddithelp.com/s/article/reddit-pixel | Reddit Pixel setup}
- */
-export interface RedditPixelAdvancedMatchingOptions {
-    /** Automatically scan page content for email addresses. */
-    email?: boolean;
-    /** Automatically scan page content for phone numbers. */
-    phone_number?: boolean;
-}
-/**
- * Reddit Pixel initialization options.
- *
- * @see {@link https://business.reddithelp.com/s/article/reddit-pixel | Reddit Pixel setup}
- * @see {@link https://business.reddithelp.com/s/article/Limited-Data-Use | Reddit Limited Data Use}
- */
-export interface RedditPixelInitOptions {
-    /**
-     * Opt the user out of Reddit Pixel tracking.
-     *
-     * Reddit sends this as `opt_out=1` on pixel requests.
-     */
-    optOut?: boolean;
-    /**
-     * Disable Reddit first-party cookies during initialization.
-     */
-    disableFirstPartyCookies?: boolean;
-    /** Email address or SHA-256 email hash for attribution matching. */
-    email?: string;
-    /** Phone number or SHA-256 phone hash for attribution matching. */
-    phoneNumber?: string;
-    /** External user identifier or SHA-256 hash for attribution matching. */
-    externalId?: string;
-    /** Android Advertising ID or SHA-256 hash. */
-    aaid?: string;
-    /** iOS Identifier for Advertisers or SHA-256 hash. */
-    idfa?: string;
-    /** Automatic advanced matching controls. */
-    aam?: RedditPixelAdvancedMatchingOptions;
-    /**
-     * Data processing mode, including Reddit Limited Data Use values.
-     *
-     * @see {@link https://business.reddithelp.com/s/article/Limited-Data-Use | Reddit Limited Data Use}
-     */
-    dpm?: string | string[];
-    /**
-     * Data processing country code.
-     *
-     * @see {@link https://business.reddithelp.com/s/article/Limited-Data-Use | Reddit Limited Data Use}
-     */
-    dpcc?: string;
-    /**
-     * Data processing region code.
-     *
-     * @see {@link https://business.reddithelp.com/s/article/Limited-Data-Use | Reddit Limited Data Use}
-     */
-    dprc?: string;
-    /** Integration partner name. */
-    partner?: string;
-    /** Integration partner version. */
-    partner_version?: string;
-    /** Source integration name reported to Reddit. */
-    integration?: 'reddit' | 'gtm' | (string & Record<never, never>);
-    /** Enable Reddit Pixel debug logging. */
-    debug?: boolean;
-    /**
-     * Send monetary `value` metadata as `valueDecimal`.
-     *
-     * @default true
-     */
-    useDecimalCurrencyValues?: boolean;
-    [key: string]: unknown;
-}
-/**
- * Metadata supported by Reddit Pixel conversion events.
- *
- * @see {@link https://business.reddithelp.com/s/article/about-event-metadata | Reddit event metadata}
- * @see {@link https://business.reddithelp.com/s/article/manual-conversion-events-with-the-reddit-pixel | Reddit manual conversion events}
- */
-export interface RedditPixelEventMetadata {
-    itemCount?: number | string;
-    value?: number | string;
-    valueDecimal?: number | string;
-    currency?: string;
-    transactionId?: string;
-    customEventName?: string;
-    products?: string | {
-        id?: string | number;
-        name?: string;
-        category?: string;
-        quantity?: number | string;
-        itemPrice?: number | string;
-    }[];
-    /**
-     * Conversion ID used to deduplicate Pixel events against Conversions API
-     * events.
-     *
-     * @see {@link https://business.reddithelp.com/s/article/event-deduplication | Reddit event deduplication}
-     */
-    conversionId?: string;
-    [key: string]: unknown;
-}
-interface RedditPixelFunction {
-    (command: 'init', pixelId: string, options?: RedditPixelInitOptions): void;
-    (command: 'enableFirstPartyCookies' | 'disableFirstPartyCookies'): void;
-    (command: 'track', eventName: RedditPixelEventName | (string & Record<never, never>), properties?: RedditPixelEventMetadata): void;
-    (command: string, ...args: unknown[]): void;
-}
-declare global {
-    interface Window {
-        rdt?: RedditPixelFunction & {
-            callQueue?: unknown[][];
-            sendEvent?: (...args: unknown[]) => void;
-        };
-    }
-}
-/**
- * Reddit Pixel vendor manifest.
- *
- * Sets up Reddit's queue stub and optionally queues the standard page visit
- * event before the external bundle loads.
- */
-export declare const redditPixelManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly bootstrap: [{
-        readonly dispatchProperty: 'sendEvent';
-        readonly ifUndefined: true;
-        readonly name: 'rdt';
-        readonly queue: {
-            readonly property: 'callQueue';
-        };
-        readonly queueFormat: 'array';
-        readonly type: 'defineStubFunction';
-    }];
-    readonly category: 'marketing';
-    readonly install: [{
-        readonly args: ["init", "{{pixelId}}"];
-        readonly global: 'rdt';
-        readonly type: 'callGlobal';
-    }, {
-        readonly args: ["track", "PageVisit"];
-        readonly global: 'rdt';
-        readonly type: 'callGlobal';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly onConsentDenied: [{
-        readonly args: ["disableFirstPartyCookies"];
-        readonly global: 'rdt';
-        readonly type: 'callGlobal';
-    }];
-    readonly onConsentGranted: [{
-        readonly args: ["enableFirstPartyCookies"];
-        readonly global: 'rdt';
-        readonly type: 'callGlobal';
-    }];
-    readonly persistAfterConsentRevoked: true;
-    readonly vendor: 'reddit-pixel';
-};
-export interface RedditPixelOptions {
-    /**
-     * Your Reddit Pixel ID.
-     * @example `t2_abcdef`
-     */
-    pixelId: string;
-    /**
-     * Queue the standard `PageVisit` event during setup.
-     * @default true
-     */
-    trackPageVisit?: boolean;
-    /**
-     * Optional payload passed as the third argument to `rdt('init', ...)`.
-     */
-    initOptions?: RedditPixelInitOptions;
-    /**
-     * Disable Reddit first-party cookies during setup.
-     *
-     * This is merged into `initOptions.disableFirstPartyCookies`.
-     */
-    disableFirstPartyCookies?: boolean;
-    /** Reddit Pixel loader URL. */
-    scriptUrl?: string;
-}
-/**
- * Creates a Reddit Pixel script.
- *
- * @param options - The options for the Reddit Pixel script.
- * @returns The Reddit Pixel script configuration.
- */
-export declare const redditPixel: ({ pixelId, trackPageVisit, initOptions, disableFirstPartyCookies, scriptUrl, }: RedditPixelOptions) => Script;
-/**
- * Tracks a Reddit Pixel event.
- *
- * @param eventName - Reddit standard event name or a custom event name.
- * @param metadata - Optional event metadata, including `conversionId` for
- * Pixel plus Conversions API deduplication.
- */
-export declare const redditPixelEvent: (eventName: RedditPixelEventName | (string & Record<never, never>), metadata?: RedditPixelEventMetadata) => void;
-export {};
+/** @deprecated Use @c15t/integrations/vendors/ads-and-pixels/reddit-pixel. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/ads-and-pixels/reddit-pixel';

package/dist-types/vendors/ads-and-pixels/snapchat-pixel.d.ts

@@ -1,171 +1,2 @@
-import type { Script } from '@c15t/core';
-export type SnapchatPixelEventName = 'PAGE_VIEW' | 'VIEW_CONTENT' | 'ADD_CART' | 'PURCHASE' | 'SIGN_UP' | 'SAVE' | 'START_CHECKOUT' | 'APP_OPEN' | 'ADD_BILLING' | 'SEARCH' | 'SUBSCRIBE' | 'AD_CLICK' | 'AD_VIEW' | 'COMPLETE_TUTORIAL' | 'LEVEL_COMPLETE' | 'INVITE' | 'LOGIN' | 'SHARE' | 'RESERVE' | 'ACHIEVEMENT_UNLOCKED' | 'ADD_TO_WISHLIST' | 'SPENT_CREDITS' | 'RATE' | 'START_TRIAL' | 'LIST_VIEW';
-export interface SnapchatPixelEventProperties {
-    /** Total monetary value for commerce events such as `PURCHASE`. */
-    price?: number;
-    /**
-     * Event identifier used to deduplicate browser Pixel events against
-     * server-side Conversions API events.
-     */
-    client_dedup_id?: string;
-    /** ISO 4217 currency code, for example `USD`. */
-    currency?: string;
-    /** Transaction/order identifier for purchase events. */
-    transaction_id?: string;
-    /** Product, SKU, or content identifiers associated with the event. */
-    item_ids?: string[];
-    /** Product or content category associated with the event. */
-    item_category?: string;
-    /** Free-form description for the event. */
-    description?: string;
-    /** Query text for `SEARCH` events. */
-    search_string?: string;
-    /** Number of items represented by the event. */
-    number_items?: number;
-    /** Whether payment information was available, represented as `0` or `1`. */
-    payment_info_available?: 0 | 1;
-    /** Signup method for `SIGN_UP` events. */
-    sign_up_method?: string;
-    /** Whether the action succeeded, represented as `0` or `1`. */
-    success?: 0 | 1;
-    /** Brand names associated with the event contents. */
-    brands?: string[];
-    /** Fulfillment method for commerce events. */
-    delivery_method?: 'in_store' | 'curbside' | 'delivery';
-    /** Customer lifecycle status associated with the event. */
-    customer_status?: 'new' | 'returning' | 'reactivated';
-    /** Optional custom tag for event segmentation in Snapchat. */
-    event_tag?: string;
-    [key: string]: unknown;
-}
-interface SnapchatPixelFunction {
-    (command: 'track', eventName: SnapchatPixelEventName | (string & Record<never, never>), properties?: SnapchatPixelEventProperties): void;
-    (command: 'init', pixelId: string, config?: Record<string, unknown>): void;
-    (command: string, ...args: unknown[]): void;
-}
-declare global {
-    interface Window {
-        snaptr?: SnapchatPixelFunction & {
-            handleRequest?: (...args: unknown[]) => void;
-            loaded?: boolean;
-            push?: Window['snaptr'];
-            queue?: unknown[][];
-            version?: string;
-        };
-        _snaptr?: Window['snaptr'];
-    }
-}
-/**
- * Snapchat Pixel vendor manifest.
- *
- * Uses a structured queue stub and queues `init` plus an optional
- * `PAGE_VIEW` event before the vendor bundle loads.
- */
-export declare const snapchatPixelManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly bootstrap: [{
-        readonly aliases: ["_snaptr"];
-        readonly dispatchProperty: 'handleRequest';
-        readonly ifUndefined: true;
-        readonly name: 'snaptr';
-        readonly properties: {
-            readonly loaded: true;
-            readonly version: '1.0';
-        };
-        readonly queue: {
-            readonly property: 'queue';
-        };
-        readonly queueFormat: 'array';
-        readonly selfReferences: ["push"];
-        readonly type: 'defineStubFunction';
-    }];
-    readonly category: 'marketing';
-    readonly install: [{
-        readonly args: ["init", "{{pixelId}}"];
-        readonly global: 'snaptr';
-        readonly type: 'callGlobal';
-    }, {
-        readonly args: ["track", "PAGE_VIEW"];
-        readonly global: 'snaptr';
-        readonly type: 'callGlobal';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'snapchat-pixel';
-};
-export interface SnapchatPixelOptions {
-    /**
-     * Your Snapchat Pixel ID.
-     * @example `123456789012345`
-     */
-    pixelId: string;
-    /** Optional init payload passed to `snaptr('init', ...)`. */
-    initOptions?: Record<string, unknown>;
-    /**
-     * Queue the default `PAGE_VIEW` event during setup.
-     * @default true
-     */
-    trackPageView?: boolean;
-    /** Snapchat Pixel loader URL. */
-    scriptUrl?: string;
-}
-/**
- * Creates a Snapchat Pixel script.
- *
- * @param options.pixelId - Snapchat Pixel ID used in `snaptr('init', ...)`.
- *   Expected format is a numeric string (commonly 15 digits), for example
- *   `'123456789012345'`. This value is required and should come directly from
- *   Snapchat Ads Manager.
- * @param options.initOptions - Optional object passed as the third argument to
- *   `snaptr('init', pixelId, initOptions)`, for advanced initialization values.
- *   Example: `{ user_email: 'user@example.com', user_phone_number: '+15551234567' }`.
- * @param options.trackPageView - Whether to queue the default
- *   `snaptr('track', 'PAGE_VIEW')` call during setup. Defaults to `true`; set to
- *   `false` when you want to control page-view tracking manually.
- * @returns A resolved c15t `Script` configuration that defines the Snapchat
- *   queue stub, runs `init` (and optionally `PAGE_VIEW`), and then loads the
- *   Snapchat SDK script URL.
- * @throws {Error} `resolveManifest` may throw when required placeholders cannot be
- *   resolved (for example, when `pixelId` is missing/empty) or when provided
- *   manifest values are invalid for interpolation.
- *
- * Edge cases:
- * - Missing `pixelId` causes manifest resolution to fail.
- * - Non-numeric or malformed `pixelId` values may initialize incorrectly in
- *   Snapchat even if local script construction succeeds.
- *
- * @example
- * ```ts
- * const script = snapchatPixel({
- * 	pixelId: '123456789012345',
- * 	initOptions: {
- * 		user_email: 'user@example.com',
- * 		user_phone_number: '+15551234567',
- * 	},
- * 	trackPageView: false,
- * });
- * ```
- */
-export declare const snapchatPixel: ({ pixelId, initOptions, trackPageView, scriptUrl, }: SnapchatPixelOptions) => Script;
-/**
- * Tracks a Snapchat Pixel event.
- *
- * @param eventName - Snapchat standard event name or a custom event name.
- * @param properties - Optional event properties, including
- *   `client_dedup_id` for Pixel plus Conversions API deduplication.
- *
- * @example
- * ```ts
- * snapchatPixelEvent('PURCHASE', {
- * 	price: 99,
- * 	currency: 'USD',
- * 	transaction_id: 'order-123',
- * 	client_dedup_id: 'event-123',
- * });
- * ```
- */
-export declare const snapchatPixelEvent: (eventName: SnapchatPixelEventName | (string & Record<never, never>), properties?: SnapchatPixelEventProperties) => void;
-export {};
+/** @deprecated Use @c15t/integrations/vendors/ads-and-pixels/snapchat-pixel. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/ads-and-pixels/snapchat-pixel';

package/dist-types/vendors/ads-and-pixels/tiktok-pixel.d.ts

@@ -1,106 +1,2 @@
-import type { Script } from '@c15t/core';
-interface TikTokPixelFunction {
-    grantConsent: () => void;
-    revokeConsent: () => void;
-    page: () => void;
-    track: (eventName: string, properties?: Record<string, unknown>) => void;
-    identify: (properties?: Record<string, unknown>) => void;
-    instances: (...args: unknown[]) => void;
-    debug: (...args: unknown[]) => void;
-    on: (...args: unknown[]) => void;
-    off: (...args: unknown[]) => void;
-    once: (...args: unknown[]) => void;
-    ready: (...args: unknown[]) => void;
-    alias: (...args: unknown[]) => void;
-    group: (...args: unknown[]) => void;
-    enableCookie: (...args: unknown[]) => void;
-    disableCookie: (...args: unknown[]) => void;
-    holdConsent: (...args: unknown[]) => void;
-}
-declare global {
-    interface Window {
-        ttq: TikTokPixelFunction;
-    }
-}
-/**
- * TikTok Pixel vendor manifest.
- *
- * Uses structured bootstrap steps and provides a consent API
- * via `ttq.grantConsent()` / `ttq.revokeConsent()`.
- */
-export declare const tiktokPixelManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly afterLoad: [{
-        readonly global: 'ttq';
-        readonly method: 'grantConsent';
-        readonly type: 'callGlobal';
-    }];
-    readonly bootstrap: [{
-        readonly name: 'TiktokAnalyticsObject';
-        readonly type: 'setGlobal';
-        readonly value: 'ttq';
-    }, {
-        readonly ifUndefined: true;
-        readonly name: 'ttq';
-        readonly type: 'setGlobal';
-        readonly value: readonly [];
-    }, {
-        readonly methods: ["page", "track", "identify", "instances", "debug", "on", "off", "once", "ready", "alias", "group", "enableCookie", "disableCookie", "holdConsent", "revokeConsent", "grantConsent"];
-        readonly target: 'ttq';
-        readonly type: 'defineQueueMethods';
-    }];
-    readonly category: 'marketing';
-    readonly install: [{
-        readonly global: 'ttq';
-        readonly method: 'grantConsent';
-        readonly type: 'callGlobal';
-    }, {
-        readonly global: 'ttq';
-        readonly method: 'page';
-        readonly type: 'callGlobal';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptSrc}}?sdkid={{pixelId}}&lib=ttq';
-        readonly type: 'loadScript';
-    }];
-    readonly onConsentDenied: [{
-        readonly global: 'ttq';
-        readonly method: 'revokeConsent';
-        readonly type: 'callGlobal';
-    }];
-    readonly onConsentGranted: [{
-        readonly global: 'ttq';
-        readonly method: 'grantConsent';
-        readonly type: 'callGlobal';
-    }];
-    readonly persistAfterConsentRevoked: true;
-    readonly vendor: 'tiktok-pixel';
-};
-export interface TikTokPixelOptions {
-    /**
-     * Your TikTok Pixel ID
-     * @example `123456789012345`
-     */
-    pixelId: string;
-    /** TikTok Pixel loader base URL. */
-    scriptSrc?: string;
-}
-/**
- * Creates a Tiktok Pixel script.
- * This script is persistent after consent is revoked because it has built-in functionality to opt into and out of tracking based on consent, which allows us to not need to load the script again when consent is revoked.
- *
- * @param options - The options for the TikTok Pixel script
- * @returns The TikTok Pixel script configuration
- *
- * @example
- * ```ts
- * const tiktokPixelScript = tiktokPixel({
- *   pixelId: '123456789012345',
- * });
- * ```
- *
- * @see {@link https://ads.tiktok.com/help/article/tiktok-pixel} TikTok Pixel documentation
- */
-export declare const tiktokPixel: ({ pixelId, scriptSrc, }: TikTokPixelOptions) => Script;
-export {};
+/** @deprecated Use @c15t/integrations/vendors/ads-and-pixels/tiktok-pixel. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/ads-and-pixels/tiktok-pixel';

package/dist-types/vendors/ads-and-pixels/x-pixel.d.ts

@@ -1,183 +1,2 @@
-import type { Script } from '@c15t/core';
-export interface XPixelContent {
-    /**
-     * Type of the content
-     * @example "Animals & Pet Supplies > Pet Supplies > Cat Supplies > Cat Beds"
-     * @see https://www.google.com/basepages/producttype/taxonomy.en-US.txt
-     */
-    content_type?: string;
-    /**
-     * ID of the content
-     * For product catalog users: please pass SKU
-     * For all other users: Please pass Global Trade Item Number (GTIN) if available, otherwise pass SKU
-     * @example "1234567890"
-     */
-    content_id: string;
-    /**
-     * Name of a product or service
-     * @example "Cat Bed"
-     */
-    content_name?: string;
-    /**
-     * Price of a product or service
-     * @example 10.00
-     */
-    content_price?: number;
-    /**
-     * Quantity of the content
-     * @example 1
-     */
-    num_items?: number;
-    /**
-     * ID associated with a group of product variants
-     * @example "1234567890"
-     */
-    content_group_id?: string;
-}
-export interface XPixelEvent {
-    /**
-     * Total value of the conversion event (ex: $ value of the transaction in case of a purchase, etc.)
-     * @example 10.00
-     */
-    value?: number;
-    /**
-     * Currency of the conversion event
-     * ISO 4217 code (ex: USD, EUR, JPY, etc.)
-     * @example USD
-     */
-    currency?: string;
-    /**
-     * Unique identifier for the event that can be used for deduplication purposes
-     * @example tw-xxxx-xxxx
-     */
-    conversion_id?: string;
-    /**
-     * Search string of the conversion event
-     * @example "search query"
-     */
-    search_string?: string;
-    /**
-     * Description of the conversion event
-     * @example "purchase"
-     */
-    description?: string;
-    /**
-     * twclid of the conversion event
-     * The X Pixel already automatically passes twclid from URL or first-party cookie. This parameter can be optionally used to force attribution to a certain ad click.
-     * @example "twclid"
-     */
-    twclid?: string;
-    /**
-     * Status of the conversion event
-     * Should be set to values like "started" or "completed".
-     * @example "completed"
-     */
-    status?: 'started' | 'completed';
-    /**
-     * Email address used for user matching.
-     * The X Pixel hashes this value before transmission.
-     * @example "[email protected]"
-     */
-    email_address?: string;
-    /**
-     * Phone number used for user matching.
-     * Include country code in E.164 format (for example, +11234567890).
-     * The X Pixel hashes this value before transmission.
-     * @example "+11234567890"
-     */
-    phone_number?: string;
-    /**
-     * Content/products associated with the conversion event
-     * @example [{content_id: 'OT001', content_name: 'bird seed', content_price: 50, num_items: 1}]
-     * @see {@link XPixelContent}
-     */
-    contents?: XPixelContent[];
-}
-declare global {
-    interface Window {
-        twq?: (event: string, ...args: unknown[]) => void;
-    }
-}
-/**
- * X (Twitter) Pixel vendor manifest.
- *
- * Uses structured startup steps to load the X tracking pixel.
- * No consent API — the script simply loads or doesn't based on consent.
- */
-export declare const xPixelManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly bootstrap: [{
-        readonly dispatchProperty: 'exe';
-        readonly ifUndefined: true;
-        readonly name: 'twq';
-        readonly properties: {
-            readonly version: '1.1';
-        };
-        readonly queue: {
-            readonly property: 'queue';
-        };
-        readonly type: 'defineStubFunction';
-    }];
-    readonly category: 'marketing';
-    readonly install: [{
-        readonly args: ["config", "{{pixelId}}"];
-        readonly global: 'twq';
-        readonly type: 'callGlobal';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptSrc}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'x-pixel';
-};
-export interface XPixelOptions {
-    /**
-     * Your X Pixel ID
-     * @example `123456789012345`
-     */
-    pixelId: string;
-    /** X Pixel loader URL. */
-    scriptSrc?: string;
-}
-/**
- * Creates an X Pixel script.
- * This script loads only when consent is granted.
- * X Pixel does not expose a consent update API, so c15t treats it as a standard consent-gated loader.
- *
- * @param options - The options for the X Pixel script
- * @returns The X Pixel script configuration
- *
- * @example
- * ```ts
- * const xPixelScript = xPixel({
- *   pixelId: '123456789012345',
- * });
- * ```
- *
- * @see {@link https://business.x.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites} X conversion tracking documentation
- */
-export declare const xPixel: ({ pixelId, scriptSrc, }: XPixelOptions) => Script;
-/**
- * @param eventId - The event ID to track
- * @example 'tw-xxxx-xxxx'
- * @param metadata - Optional metadata to track
- *
- * @example
- * ```ts
- * xPixelEvent('tw-xxxx-xxxx', {
- *   value: 200.00,
- *   currency: 'USD',
- *   contents: [
- *     {content_id: 'OT001', content_name: 'bird seed', content_price: 50, num_items: 1},
- *     {content_id: 'OT002', content_name: 'bird cage', content_price: 150, num_items: 1}
- *   ]
- * });
- * ```
- *
- * @see {@link https://business.x.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites#event-types-and-parameters}
- * @throws {Error} Throws when `window` is unavailable or `window.twq` is not a
- * function. Ensure marketing consent is granted and the X Pixel has loaded
- * before calling this helper.
- */
-export declare const xPixelEvent: (eventId: string, metadata?: XPixelEvent) => void;
+/** @deprecated Use @c15t/integrations/vendors/ads-and-pixels/x-pixel. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/ads-and-pixels/x-pixel';