@ohos-ports/vite-plugin-radar 0.11.0-beta.0

package/dist/index.d.mts

@@ -0,0 +1,451 @@
+import { HtmlTagDescriptor, Plugin } from 'vite';
+
+interface BaiduTongjiDefaults {
+    /**
+     * `hm.js` script source
+     */
+    script?: string;
+    /**
+     * `async` attribute set on the injected script tag
+     */
+    async?: boolean;
+    /**
+     * Value pushed to `_hmt` for `_setAutoPageview`
+     */
+    autoPageview?: boolean;
+}
+interface BaiduTongjiProperty extends BaiduTongjiDefaults {
+    id: string;
+}
+type BaiduTongjiOptions = BaiduTongjiProperty | BaiduTongjiProperty[];
+
+declare global {
+    interface Window {
+        _hmt: any[];
+    }
+}
+
+interface FacebookPixelDefaults {
+    /**
+     * `fbevents.js` script source
+     */
+    script?: string;
+    /**
+     * Tracking endpoint used by the `<noscript>` pixel
+     */
+    noScript?: string;
+    /**
+     * Event tracked on load (`fbq('track', <event>)`)
+     */
+    event?: string;
+}
+interface FacebookPixel extends FacebookPixelDefaults {
+    /**
+     * Pixel tag
+     */
+    id: string;
+}
+type FacebookPixelOption = FacebookPixel | FacebookPixel[];
+
+declare global {
+    interface Window {
+        fbq: (event: string, id?: string, params?: Record<string, any>) => void;
+    }
+}
+
+interface FullStoryDefaults {
+    host?: string;
+    script?: string;
+    namespace?: string;
+    /**
+     * The FullStory loader snippet (the IIFE that boots the `FS` API).
+     * Override only if you need to pin a different snippet version.
+     */
+    loader?: string;
+}
+interface FullStoryOptions extends FullStoryDefaults {
+    org?: string;
+}
+
+declare global {
+    interface Window {
+        _fs_host: any[];
+        _fs_script: any[];
+        _fs_org: any[];
+        _fs_namespace: any[];
+    }
+}
+
+interface GAConfiguration extends Record<string, any> {
+    send_page_view?: boolean;
+    allow_google_signals?: boolean;
+    allow_ad_personalization_signals?: boolean;
+    transport_url?: string;
+    cookie_domain?: string;
+    cookie_expires?: number;
+    cookie_prefix?: string;
+    cookie_update?: boolean;
+    cookie_flags?: string;
+    user_id?: string;
+    page_title?: string;
+    currency?: string;
+    debug_mode?: boolean;
+}
+interface GAConsentDefaults {
+    ad_storage?: 'granted' | 'denied';
+    analytics_storage?: 'granted' | 'denied';
+    wait_for_update?: number;
+}
+interface GoogleAnaliticsDefaults {
+    /**
+     * Origin serving `gtag.js` (e.g. a self-hosted proxy)
+     */
+    source?: string;
+    /**
+     * Path appended to `source` to build the `gtag.js` URL
+     */
+    basePath?: string;
+    /**
+     * `async` attribute set on the injected `gtag.js` script tag
+     */
+    async?: boolean;
+    /**
+     * Bootstrap snippet that defines `dataLayer` and the `gtag()` function
+     */
+    loader?: string;
+}
+type GoogleAnaliticsMainProperty = GoogleAnaliticsProperty & GoogleAnaliticsDefaults & {
+    consentDefaults?: GAConsentDefaults;
+    injectTo?: HtmlTagDescriptor['injectTo'];
+};
+interface GoogleAnaliticsProperty {
+    id: string;
+    disable?: boolean;
+    config?: GAConfiguration;
+    persistentValues?: Record<string, string | number | boolean>;
+}
+type GoogleAnaliticsOptions = GoogleAnaliticsMainProperty | [GoogleAnaliticsMainProperty, ...GoogleAnaliticsProperty[]];
+
+declare global {
+    interface Window {
+        dataLayer: any[];
+        gtag: (command: string, ...args: any[]) => void;
+    }
+}
+
+interface GoogleTagManagerMainProperty {
+    id: string;
+}
+interface GoogleTagManagerEnvironment {
+    auth: string;
+    preview: string;
+}
+interface GoogleTagManagerDefaults {
+    /**
+     * `gtm.js` script source
+     */
+    gtmBase?: string;
+    /**
+     * `ns.html` (noscript iframe) source
+     */
+    nsBase?: string;
+    /**
+     * `async` attribute set on the injected `gtm.js` script tag
+     */
+    async?: boolean;
+    /**
+     * Bootstrap snippet that initialises `dataLayer` and the `gtm.start` event
+     */
+    loader?: string;
+}
+interface GoogleTagManagerDefaultProperty extends GoogleTagManagerDefaults {
+    environment?: GoogleTagManagerEnvironment;
+}
+type GoogleTagManagerProperty = GoogleTagManagerMainProperty & GoogleTagManagerDefaultProperty;
+type GoogleTagManagerOptions = GoogleTagManagerProperty | GoogleTagManagerProperty[];
+
+declare global {
+    interface Window {
+        dataLayer: any[];
+    }
+}
+
+interface HotjarDefaults {
+    /**
+     * Hotjar tracking script source prefix
+     */
+    script?: string;
+    /**
+     * Hotjar snippet version (`hjsv`)
+     */
+    version?: number;
+    /**
+     * `async` value set on the injected script element
+     */
+    async?: number;
+}
+interface HotjarOptions extends HotjarDefaults {
+    id: number;
+}
+
+declare global {
+    interface Window {
+        hj: any[];
+        _hjSettings: any[];
+    }
+}
+
+interface LinkedinInsightDefaults {
+    /**
+     * `insight.min.js` script source
+     */
+    script?: string;
+    /**
+     * Collect endpoint used by the `<noscript>` pixel
+     */
+    noScript?: string;
+    /**
+     * `async` attribute set on the injected script tag
+     */
+    async?: boolean;
+}
+interface LinkedinInsightProperty extends LinkedinInsightDefaults {
+    id: string;
+}
+type LinkedinInsightOptions = LinkedinInsightProperty | LinkedinInsightProperty[];
+
+declare global {
+    interface Window {
+        _linkedin_data_partner_ids: any[];
+    }
+}
+
+interface MicrosoftAdvertisingDefaults {
+    /**
+     * `bat.js` (UET) script source
+     */
+    script?: string;
+    /**
+     * `async` value set on the injected script element
+     */
+    async?: number;
+}
+interface MicrosoftAdvertisingOptions extends MicrosoftAdvertisingDefaults {
+    id: string;
+}
+
+declare global {
+    interface Window {
+        uetq: any[];
+    }
+}
+
+interface MicrosoftClarityDefaults {
+    /**
+     * Clarity tag script source (the property id is appended to it)
+     */
+    script?: string;
+    /**
+     * `async` value set on the injected script element
+     */
+    async?: number;
+}
+interface MicrosoftClarityOptions extends MicrosoftClarityDefaults {
+    id: string;
+}
+
+declare global {
+    interface Window {
+        clarity: any[];
+    }
+}
+
+interface PlausibleAnalyticsDefaults {
+    /**
+     * Tracking script source
+     */
+    script?: string;
+    /**
+     * `defer` attribute set on the injected script tag
+     */
+    defer?: boolean;
+}
+interface PlausibleAnalyticsOptions extends PlausibleAnalyticsDefaults {
+    enabled: boolean;
+    hostname?: string;
+}
+
+interface PostHogAnalyticsDefaults {
+    /**
+     * The PostHog loader snippet (the `array.js` bootstrap).
+     * Override only if you need to pin a different snippet version.
+     */
+    loader?: string;
+}
+interface PostHogAnalyticsOptions extends PostHogAnalyticsDefaults {
+    enabled: boolean;
+    token: string;
+    api_host: string;
+    config?: Record<string, any>;
+}
+
+interface SimpleAnalyticsDefaults {
+    /**
+     * Tracking script source
+     */
+    script?: string;
+    /**
+     * `<noscript>` pixel source
+     */
+    noScript?: string;
+    /**
+     * `async` attribute set on the injected script tag
+     */
+    async?: boolean;
+    /**
+     * `defer` attribute set on the injected script tag
+     */
+    defer?: boolean;
+}
+interface SimpleAnalyticsOptions extends SimpleAnalyticsDefaults {
+    enabled: boolean;
+    hostname?: string;
+}
+
+interface TikTokPixelDefaults {
+    /**
+     * TikTok pixel events script source
+     */
+    script?: string;
+    /**
+     * Pixel methods registered on the `ttq` stub
+     */
+    methods?: string[];
+    /**
+     * Call executed right after the pixel is loaded
+     */
+    page?: string;
+}
+interface TikTokPixelOptions extends TikTokPixelDefaults {
+    id: string;
+}
+
+declare global {
+    interface Window {
+        TiktokAnalyticsObject: 'ttq';
+        ttq: Record<string, (...args: any[]) => void>;
+    }
+}
+
+interface UnbounceDefaults {
+    /**
+     * Unbounce tracking script source
+     */
+    script?: string;
+    /**
+     * Goal pushed to `_ubaq` (raw arguments array as a string)
+     */
+    goal?: string;
+}
+interface UnbounceOptions extends UnbounceDefaults {
+    enabled: boolean;
+}
+
+interface VKRetargetingDefaults {
+    /**
+     * `openapi.js` script source
+     */
+    script?: string;
+    /**
+     * Tracking endpoint used by the `<noscript>` pixel
+     */
+    noScript?: string;
+    /**
+     * Hit call executed once the script is loaded
+     */
+    hit?: string;
+}
+interface VKRetargeting extends VKRetargetingDefaults {
+    /**
+     * Retargeting tag
+     */
+    id: string;
+}
+type VKRetargetingOption = VKRetargeting | VKRetargeting[];
+
+declare global {
+    interface Window {
+        VK: any;
+    }
+}
+
+interface MetricaConfiguration {
+    defer?: boolean;
+    clickmap?: boolean;
+    trackLinks?: boolean;
+    accurateTrackBounce?: boolean;
+    childIframe?: boolean;
+    webvisor?: boolean;
+    trackHash?: boolean;
+    triggerEvent?: boolean;
+    ecommerce?: string | boolean | any[];
+    trustedDomains?: string[];
+    type?: number;
+    params?: Record<string, string | number | boolean> | Record<string, string | number | boolean>[];
+    userParams?: Record<string, string | number | boolean>;
+}
+interface YandexMetricaDefaults {
+    /**
+     * `tag.js` script source
+     */
+    script?: string;
+    /**
+     * Tracking endpoint used by the `<noscript>` pixel
+     */
+    noScript?: string;
+}
+interface YandexMetricaProperty extends YandexMetricaDefaults {
+    id: string;
+    config?: MetricaConfiguration;
+}
+type YandexMetricaOptions = YandexMetricaProperty | YandexMetricaProperty[];
+
+declare global {
+    interface Window {
+        dataLayer: any[];
+        ym: (id: string, command: string, ...args: any[]) => void;
+    }
+}
+
+interface VitePluginRadarOptions {
+    enableDev?: boolean;
+    analytics?: GoogleAnaliticsOptions;
+    gtm?: GoogleTagManagerOptions;
+    pixel?: FacebookPixelOption;
+    linkedin?: LinkedinInsightOptions;
+    tongji?: BaiduTongjiOptions;
+    metrica?: YandexMetricaOptions;
+    microsoft?: MicrosoftAdvertisingOptions;
+    microsoftClarity?: MicrosoftClarityOptions;
+    retargeting?: VKRetargetingOption;
+    hotjar?: HotjarOptions;
+    fullStory?: FullStoryOptions;
+    unbounce?: UnbounceOptions | boolean;
+    tiktok?: TikTokPixelOptions;
+    simpleanalytics?: SimpleAnalyticsOptions;
+    posthog?: PostHogAnalyticsOptions;
+    plausible?: PlausibleAnalyticsOptions;
+}
+type InjectorKey = Exclude<keyof VitePluginRadarOptions, 'enableDev'>;
+interface InjectorEntry {
+    key: InjectorKey;
+    enabled?: (value: any) => boolean;
+    load: () => Promise<{
+        default: (options: any) => HtmlTagDescriptor[];
+    }>;
+}
+declare const INJECTORS: InjectorEntry[];
+declare function VitePluginRadar({ enableDev, ...options }: VitePluginRadarOptions): Plugin;
+
+export { INJECTORS, VitePluginRadar };
+export type { VitePluginRadarOptions };