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

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

@@ -1,164 +1,2 @@
-import type { Script } from '@c15t/core';
-/**
- * Public Segment Analytics.js API exposed on `window.analytics`.
- *
- * Use this interface when interacting with Segment calls queued before or after
- * the client library is fully initialized.
- *
- * @example
- * ```ts
- * window.analytics.track('Signup', { plan: 'pro' });
- * ```
- */
-export interface SegmentApi {
-    /**
-     * Queues an event tracking call.
-     *
-     * @param event - Event name to record.
-     * @param properties - Optional event properties payload.
-     * @returns `void`.
-     *
-     * @remarks
-     * Calls are queued until Analytics.js initializes.
-     *
-     * @example
-     * ```ts
-     * window.analytics.track('Signup', { plan: 'pro' });
-     * ```
-     */
-    track: (event: string, properties?: Record<string, unknown>) => void;
-    /**
-     * Queues a page tracking call.
-     *
-     * @param name - Optional page name override.
-     * @param properties - Optional page metadata payload.
-     * @returns `void`.
-     *
-     * @remarks
-     * If no name is passed, Segment infers the current page context.
-     *
-     * @example
-     * ```ts
-     * window.analytics.page('Pricing');
-     * ```
-     */
-    page: (name?: string, properties?: Record<string, unknown>) => void;
-    /**
-     * Queues a user identification call.
-     *
-     * @param userId - Stable user identifier.
-     * @param traits - Optional trait map associated with the user.
-     * @param options - Optional Segment call options.
-     * @returns `void`.
-     *
-     * @remarks
-     * Ensure the client is initialized and use a stable `userId` to avoid
-     * fragmented user profiles.
-     *
-     * @example
-     * ```ts
-     * window.analytics.identify('user_123', { email: 'dev@example.com' });
-     * ```
-     */
-    identify: (userId: string, traits?: Record<string, unknown>, options?: Record<string, unknown>) => void;
-    /**
-     * Queues a group association call for account-level analytics.
-     *
-     * @param groupId - Group or account identifier.
-     * @param traits - Optional group trait map.
-     * @param options - Optional Segment call options.
-     * @returns `void`.
-     *
-     * @example
-     * ```ts
-     * window.analytics.group('acme-inc', { plan: 'enterprise' });
-     * ```
-     */
-    group: (groupId: string, traits?: Record<string, unknown>, options?: Record<string, unknown>) => void;
-    /**
-     * Queues a user alias call to merge identities.
-     *
-     * @param userId - New canonical user identifier.
-     * @param previousId - Optional previous anonymous or legacy identifier.
-     * @param options - Optional Segment call options.
-     * @returns `void`.
-     *
-     * @remarks
-     * Use `previousId` only when linking an existing anonymous identity to the
-     * new `userId`.
-     *
-     * @example
-     * ```ts
-     * window.analytics.alias('user_123', 'anon_456');
-     * ```
-     */
-    alias: (userId: string, previousId?: string, options?: Record<string, unknown>) => void;
-    /**
-     * Queues a reset call that clears current user identity state.
-     *
-     * @returns `void`.
-     *
-     * @example
-     * ```ts
-     * window.analytics.reset();
-     * ```
-     */
-    reset: () => void;
-}
-declare global {
-    interface Window {
-        analytics?: SegmentApi;
-    }
-}
-/**
- * Segment vendor manifest.
- *
- * Uses Segment's standard `window.analytics` queue shape and optionally queues
- * the initial `page()` call before the bundle loads.
- */
-export declare const segmentManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly bootstrap: [{
-        readonly ifUndefined: true;
-        readonly name: 'analytics';
-        readonly type: 'setGlobal';
-        readonly value: readonly [];
-    }, {
-        readonly methods: ["track", "page", "identify", "group", "alias", "reset"];
-        readonly target: 'analytics';
-        readonly type: 'defineQueueMethods';
-    }];
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly path: ["analytics", "_loadOptions"];
-        readonly type: 'setGlobalPath';
-        readonly value: '{{loadOptions}}';
-    }, {
-        readonly global: 'analytics';
-        readonly method: 'page';
-        readonly type: 'callGlobal';
-    }, {
-        readonly async: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'segment';
-};
-export interface SegmentOptions {
-    /** Options consumed by Analytics.js on initialization. */
-    loadOptions?: Record<string, unknown>;
-    /** Your Segment write key. */
-    writeKey: string;
-    /** Queue the initial `analytics.page()` call during setup. */
-    trackPageView?: boolean;
-    /** Optional full loader URL override. */
-    scriptUrl?: string;
-}
-/**
- * Creates a Segment Analytics.js script.
- *
- * @param options - The options for the Segment script.
- * @returns The Segment script configuration.
- */
-export declare const segment: ({ writeKey, loadOptions, trackPageView, scriptUrl, }: SegmentOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/segment. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/segment';

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

@@ -1,93 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        umami?: {
-            identify: (sessionData?: Record<string, unknown> | string) => void;
-            track: {
-                (payload?: Record<string, unknown>): void;
-                (eventName: string, eventData?: Record<string, unknown>): void;
-            };
-        };
-    }
-}
-/**
- * Umami Analytics vendor manifest.
- *
- * Configures Umami entirely through script `data-*` attributes. Umami is a
- * cookieless analytics product, so the script is consent-gated on
- * `measurement` and unloaded when consent is revoked.
- */
-export declare const umamiAnalyticsManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'measurement';
-    readonly install: [{
-        readonly attributes: {
-            readonly 'data-auto-track': '{{autoTrackAttribute}}';
-            readonly 'data-before-send': '{{beforeSend}}';
-            readonly 'data-domains': '{{domains}}';
-            readonly 'data-host-url': '{{hostUrl}}';
-            readonly 'data-tag': '{{tag}}';
-            readonly 'data-website-id': '{{websiteId}}';
-        };
-        readonly defer: true;
-        readonly src: '{{scriptUrl}}';
-        readonly type: 'loadScript';
-    }];
-    readonly vendor: 'umami-analytics';
-};
-export interface UmamiAnalyticsOptions {
-    /**
-     * Your Umami website ID.
-     */
-    websiteId: string;
-    /**
-     * Override the host that receives analytics events.
-     */
-    hostUrl?: string;
-    /**
-     * Disable automatic tracking when set to `false`.
-     */
-    autoTrack?: boolean;
-    /**
-     * Restrict tracking to specific domains.
-     */
-    domains?: string[] | string;
-    /**
-     * Attach a tag to tracked events.
-     */
-    tag?: string;
-    /**
-     * Optional global hook name used for Umami's `data-before-send` attribute.
-     *
-     * Callback functions are intentionally not supported here because the c15t
-     * manifest runtime cannot serialize custom JavaScript functions.
-     */
-    beforeSend?: string;
-    /**
-     * Custom loader URL.
-     * @default 'https://cloud.umami.is/script.js'
-     */
-    scriptUrl?: string;
-}
-/**
- * Creates an Umami Analytics script.
- *
- * @see https://umami.is/docs/tracker-config
- *
- * @param options - The options for the Umami Analytics script.
- * @returns The Umami Analytics script.
- * @throws {Error} When `websiteId` is missing, empty, or invalid. Provide a
- * valid non-empty `websiteId` string to prevent this error.
- *
- * @example
- * ```ts
- * import { umamiAnalytics } from '@c15t/scripts/umami-analytics';
- *
- * umamiAnalytics({
- *   websiteId: 'site-abc-123',
- *   domains: ['example.com', 'www.example.com'],
- * });
- * ```
- */
-export declare const umamiAnalytics: (options: UmamiAnalyticsOptions) => Script;
+/** @deprecated Use @c15t/integrations/vendors/analytics/umami-analytics. Compatibility ends in v4. */
+export * from '@c15t/integrations/vendors/analytics/umami-analytics';

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

@@ -1,62 +1,2 @@
-import type { Script } from '@c15t/core';
-declare global {
-    interface Window {
-        FrontChat?: (command: string, options?: Record<string, unknown>) => unknown;
-    }
-}
-/** Front Chat loader and consent-gated widget initialisation. */
-export declare const frontChatManifest: {
-    readonly kind: "c15t.vendor-manifest";
-    readonly schemaVersion: 1;
-    readonly category: 'functionality';
-    readonly install: [{
-        readonly async: true;
-        readonly src: '{{scriptSrc}}';
-        readonly type: 'loadScript';
-    }];
-    readonly onLoadGranted: [{
-        readonly args: ["init", "{{initOptions}}"];
-        readonly global: 'FrontChat';
-        readonly type: 'callGlobal';
-    }];
-    readonly vendor: 'front-chat';
-};
-export interface FrontChatOptions {
-    /** Public chat ID from the Front channel's installation snippet. */
-    chatId: string;
-    /** Show Front's default launcher. @default true */
-    useDefaultLauncher?: boolean;
-    /** Custom or proxied Front Chat bundle URL. */
-    scriptSrc?: string;
-    /** CSP nonce forwarded to the loader and Front's generated scripts. */
-    nonce?: string;
-}
-/**
- * Creates a Front Chat script gated on functionality consent.
- *
- * Keep c15t's default reload-on-revocation behaviour enabled to stop an
- * already-running widget. Removing its loader cannot unload the SDK.
- *
- * @param options - Front channel and launcher configuration.
- * @returns The Front Chat script configuration.
- * @throws {Error} When chatId is missing or empty. Copy the public ID from
- * the Front channel's installation snippet.
- * @example
- * frontChat({ chatId: 'YOUR_FRONT_CHAT_ID' });
- * @see https://help.front.com/en/articles/2049
- */
-export declare const frontChat: (options: FrontChatOptions) => Script;
-/**
- * Requests widget removal and session cleanup through Front's SDK.
- *
- * Optionally call it from `onBeforeConsentRevocationReload`. Front does not
- * provide a completion promise, so this does not guarantee cleanup before
- * navigation.
- * Safe to call during SSR or before the SDK loads.
- *
- * @returns Nothing.
- * @example
- * shutdownFrontChat();
- * @see https://dev.frontapp.com/docs/chat-sdk-reference
- */
-export declare const shutdownFrontChat: () => void;
+/** @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';