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

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

@@ -1,66 +1,2 @@
-import type { Script } from '@c15t/core';
-export type VercelAnalyticsMode = 'auto' | 'development' | 'production';
-declare global {
-    interface Window {
-        va?: (event: string, properties?: unknown) => void;
-        vaq?: [string, unknown?][];
-        vam?: 'development' | 'production';
-    }
-}
-/**
- * Vercel Analytics vendor manifest.
- *
- * Seeds Vercel's event queue before loading the tracker bundle.
- */
-export declare const vercelAnalyticsManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly bootstrap: [{
-        readonly ifUndefined: true;
-        readonly name: 'vaq';
-        readonly type: 'setGlobal';
-        readonly value: readonly [];
-    }, {
-        readonly ifUndefined: true;
-        readonly name: 'va';
-        readonly queue: {
-            readonly global: 'vaq';
-        };
-        readonly queueFormat: 'array';
-        readonly type: 'defineStubFunction';
-    }];
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly attributes: {
-            readonly 'data-disable-auto-track': '{{disableAutoTrackAttribute}}';
-            readonly 'data-dsn': '{{dsn}}';
-            readonly 'data-endpoint': '{{endpoint}}';
-            readonly 'data-sdkn': 'c15t';
-        };
-        readonly defer: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'vercel-analytics';
-};
-export interface VercelAnalyticsOptions {
-    /** Project DSN for self-hosted or non-Vercel deployments. */
-    dsn?: string;
-    /** Disable automatic pageview tracking. */
-    disableAutoTrack?: boolean;
-    /** Preferred script mode. */
-    mode?: VercelAnalyticsMode;
-    /** Load Vercel's debug bundle when set to `true`. */
-    debug?: boolean;
-    /** Custom ingestion endpoint. */
-    endpoint?: string;
-    /** Custom loader URL. */
-    scriptUrl?: string;
-}
-/**
- * Creates a Vercel Analytics script.
- *
- * @param options - The options for the Vercel Analytics script.
- * @returns The Vercel Analytics script.
- */
-export declare const vercelAnalytics: (options?: VercelAnalyticsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/vercel-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/vercel-analytics';

package/dist-types/vendors/email-and-sms/klaviyo.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/vendors/email-and-sms/klaviyo. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/email-and-sms/klaviyo';

package/dist-types/vendors/functional/crisp.d.ts

@@ -1,78 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        $crisp: unknown[][];
-        CRISP_WEBSITE_ID: string;
-        CRISP_RUNTIME_CONFIG?: {
-            locale?: string;
-            session_merge?: boolean;
-        };
-        CRISP_COOKIE_DOMAIN?: string;
-        CRISP_COOKIE_EXPIRE?: number;
-        CRISP_TOKEN_ID?: string;
-    }
-}
-/**
- * Crisp vendor manifest.
- *
- * Seeds the Crisp queue and website ID before loading the chat client.
- * Optional runtime globals are added when provided by the helper options.
- */
-export declare const crispManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'functionality';
-    readonly install: [{
-        readonly ifUndefined: false;
-        readonly name: '$crisp';
-        readonly type: 'setGlobal';
-        readonly value: readonly [];
-    }, {
-        readonly ifUndefined: false;
-        readonly name: 'CRISP_WEBSITE_ID';
-        readonly type: 'setGlobal';
-        readonly value: '{{websiteId}}';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptSrc}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'crisp';
-};
-export interface CrispOptions {
-    /** Your Crisp website ID. */
-    websiteId: string;
-    /** Optional locale passed through `window.CRISP_RUNTIME_CONFIG`. */
-    locale?: string;
-    /** Optional cookie domain override for Crisp. */
-    cookieDomain?: string;
-    /** Optional cookie expiration in seconds. */
-    cookieExpiry?: number;
-    /** Optional Crisp token ID for session continuity. */
-    tokenId?: string;
-    /** Whether to merge anonymous sessions into token-backed sessions. */
-    sessionMerge?: boolean;
-    /** Whether to enable `$crisp` safe mode before other queued calls. */
-    safeMode?: boolean;
-    /** Crisp loader URL. */
-    scriptSrc?: string;
-}
-/**
- * Creates a Crisp chat script.
- *
- * This manifest-based helper keeps the serializable queue/bootstrap globals and
- * omits the upstream ready callback wrapper.
- *
- * @param options - The options for the Crisp script.
- * @returns The Crisp script configuration.
- *
- * @example
- * ```ts
- * const crispScript = crisp({
- * 	websiteId: '1234-abcd',
- * });
- * ```
- *
- * @see {@link https://help.crisp.chat/en/article/how-do-i-install-crisp-live-chat-on-my-website-10wcj3l/} Crisp installation documentation.
- */
-export declare const crisp: (options: CrispOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/functional/crisp. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/functional/crisp';

package/dist-types/vendors/functional/front-chat.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/vendors/functional/front-chat. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/functional/front-chat';

package/dist-types/vendors/functional/intercom.d.ts

@@ -1,135 +1,2 @@
-import type { Script } from '@c15t/core';
-export declare const INTERCOM_API_BASES: {
-    readonly au: 'https://api-iam.au.intercom.io';
-    readonly eu: 'https://api-iam.eu.intercom.io';
-    readonly us: 'https://api-iam.intercom.io';
-};
-export type IntercomApiBase = (typeof INTERCOM_API_BASES)[keyof typeof INTERCOM_API_BASES] | (string & Record<never, never>);
-export type IntercomThemeMode = 'light' | 'dark' | 'system';
-export interface IntercomAvatar {
-    type: 'avatar';
-    image_url: string;
-}
-export interface IntercomCompany {
-    id?: string;
-    company_id?: string;
-    name?: string;
-    created_at?: number;
-    remote_created_at?: number;
-    plan?: string;
-    monthly_spend?: number;
-    size?: number;
-    website?: string;
-    industry?: string;
-    [key: string]: unknown;
-}
-export interface IntercomSettings extends Record<string, unknown> {
-    app_id: string;
-    api_base: IntercomApiBase;
-    custom_launcher_selector?: string;
-    alignment?: 'left' | 'right';
-    vertical_padding?: number;
-    horizontal_padding?: number;
-    z_index?: number;
-    hide_default_launcher?: boolean;
-    hide_notifications?: boolean;
-    theme_mode?: IntercomThemeMode;
-    session_duration?: number;
-    action_color?: string;
-    background_color?: string;
-    link_color?: string;
-    email?: string;
-    user_id?: string;
-    created_at?: number;
-    name?: string;
-    phone?: string;
-    unsubscribed_from_emails?: boolean;
-    language_override?: string;
-    utm_campaign?: string;
-    utm_content?: string;
-    utm_medium?: string;
-    utm_source?: string;
-    utm_term?: string;
-    avatar?: IntercomAvatar;
-    user_hash?: string;
-    company?: IntercomCompany;
-    companies?: IntercomCompany[];
-    page_title?: string;
-}
-export type IntercomCustomSettings = Partial<Omit<IntercomSettings, 'app_id' | 'api_base'>> & Record<string, unknown>;
-declare global {
-    interface Window {
-        Intercom?: ((...args: unknown[]) => void) & {
-            q?: unknown[][];
-        };
-        intercomSettings?: IntercomSettings;
-    }
-}
-/**
- * Intercom vendor manifest.
- *
- * Seeds `window.intercomSettings` and a queueing `Intercom` stub before loading
- * the messenger widget bundle.
- */
-export declare const intercomManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'functionality';
-    readonly install: [{
-        readonly ifUndefined: true;
-        readonly name: 'Intercom';
-        readonly queue: {
-            readonly property: 'q';
-        };
-        readonly queueFormat: 'array';
-        readonly type: 'defineStubFunction';
-    }, {
-        readonly ifUndefined: false;
-        readonly name: 'intercomSettings';
-        readonly type: 'setGlobal';
-        readonly value: '{{settings}}';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptSrc}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'intercom';
-};
-export interface IntercomOptions {
-    /**
-     * Your Intercom app ID.
-     */
-    appId: string;
-    /**
-     * Regional Intercom API base.
-     *
-     * @default 'https://api-iam.intercom.io'
-     */
-    apiBase?: IntercomApiBase;
-    /**
-     * Additional serializable Intercom settings merged into
-     * `window.intercomSettings`.
-     */
-    settings?: IntercomCustomSettings;
-    /** Intercom loader URL. */
-    scriptSrc?: string;
-}
-/**
- * Creates an Intercom messenger script.
- *
- * The helper bootstraps the documented Intercom settings object and queues
- * early `Intercom(...)` calls until the messenger bundle loads.
- *
- * @param options - The options for the Intercom script.
- * @returns The Intercom script configuration.
- *
- * @example
- * ```ts
- * const intercomScript = intercom({
- * 	appId: 'abc123',
- * });
- * ```
- *
- * @see {@link https://developers.intercom.com/installing-intercom/web/installation} Intercom installation documentation.
- */
-export declare const intercom: ({ appId, apiBase, settings, scriptSrc, }: IntercomOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/functional/intercom. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/functional/intercom';

package/dist-types/vendors/tag-managers/cloudflare-zaraz.d.ts

@@ -1,39 +1,2 @@
-import type { AllConsentNames, Script } from '@c15t/core';
-/** The Zaraz Consent API methods used by the bridge. */
-export interface ZarazConsentApi {
-    APIReady: boolean;
-    modal?: unknown;
-    getAll: () => Record<string, boolean>;
-    set: (permissions: Record<string, boolean>) => void;
-    sendQueuedEvents: () => void;
-}
-export interface CloudflareZarazOptions {
-    /** Map c15t categories to purpose IDs from the Zaraz dashboard. */
-    purposes: Partial<Record<AllConsentNames, readonly string[]>>;
-    /** Hide the currently visible Zaraz modal. Disable auto-display in Zaraz too. @default true */
-    hideBuiltInModal?: boolean;
-    /** Replay Zaraz's queued pageview events after a denied purpose becomes allowed. @default true */
-    sendQueuedEvents?: boolean;
-    /**
-     * Called once after the first successful synchronization. With automatic
-     * pageviews disabled in Zaraz, send the initial Pageview from this callback.
-     */
-    onReady?: () => void;
-    /** Called when synchronization fails. Retried on the next consent update or readiness event. */
-    onError?: (error: unknown) => void;
-}
-/**
- * Synchronize c15t effective permissions with externally loaded Zaraz tools.
- * Does not load Zaraz or configure tools. Unmapped Zaraz purposes are denied.
- * Disable automatic pageviews and send the first Pageview from onReady to avoid
- * running tools with a stale Zaraz consent cookie before synchronization.
- *
- * @param options - Purpose mapping and synchronization callbacks.
- * @returns A callback-only script for the existing c15t script loader.
- * @throws {Error} If the mapping is empty, contains blank IDs, or maps an ID twice.
- * @example
- * ```ts
- * cloudflareZaraz({ purposes: { measurement: ['analytics-purpose'] } });
- * ```
- */
-export declare const cloudflareZaraz: (options: CloudflareZarazOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/tag-managers/cloudflare-zaraz. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/tag-managers/cloudflare-zaraz';

package/dist-types/vendors/tag-managers/google-tag-manager.d.ts

@@ -1,94 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        dataLayer: unknown[];
-        gtag: (...args: unknown[]) => void;
-    }
-}
-/**
- * Google Tag Manager vendor manifest.
- *
- * Defines GTM as a declarative integration:
- * - Initializes dataLayer and gtag function before the container loads
- * - Maps c15t consent categories to Google Consent Mode v2 types
- * - Signals consent state via `gtag('consent', 'default'|'update', ...)`
- */
-export declare const googleTagManagerManifest: {
-    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: 'necessary';
-    readonly consentMapping: Record<string, string[]>;
-    readonly consentSignal: 'gtag';
-    readonly install: [{
-        readonly queue: 'dataLayer';
-        readonly type: 'pushToQueue';
-        readonly value: {
-            readonly event: 'gtm.js';
-            readonly 'gtm.start': {
-                readonly kind: "c15t.runtime-value";
-                readonly value: 'timestamp';
-            };
-        };
-    }, {
-        readonly async: true;
-        readonly src: 'https://www.googletagmanager.com/gtm.js?id={{id}}';
-        readonly type: 'loadScript';
-    }];
-    readonly onConsentChange: [{
-        readonly args: ["event", "{{updateEventName}}"];
-        readonly global: 'gtag';
-        readonly type: 'callGlobal';
-    }];
-    readonly vendor: 'google-tag-manager';
-};
-export interface GoogleTagManagerOptions {
-    /**
-     * Your Google Tag Manager container ID. Begins with 'GTM-'.
-     * @example `GTM-1234XXX`
-     */
-    id: string;
-    /**
-     * Custom event name fired after consent updates.
-     * Can be used as a trigger in GTM to load scripts once consent is updated.
-     *
-     * @default 'consent-update'
-     */
-    updateEventName?: string;
-    /**
-     * 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[]>;
-}
-/**
- * Creates a Google Tag Manager script.
- * GTM can be used for managing the consent of other scripts via Google Tag Manager consent mode.
- * We recommend using c15t's script loader instead so your script logic is centralised.
- *
- * @param options - The options for the Google Tag Manager script.
- * @returns The Google Tag Manager script.
- */
-export declare const googleTagManager: ({ id, updateEventName, consentMapping, }: GoogleTagManagerOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/tag-managers/google-tag-manager. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/tag-managers/google-tag-manager';

package/dist-types/vercel-analytics.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/vercel-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vercel-analytics';

package/dist-types/x-pixel.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Use @c15t/integrations/x-pixel. Compatibility ends in v4. */
+export * from '@c15t/integrations/x-pixel';