@c15t/scripts 2.0.0 → 2.1.0

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

@@ -0,0 +1,158 @@
+import type { Script } from 'c15t';
+/**
+ * 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 vendor: "segment";
+    readonly category: "measurement";
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "analytics";
+        readonly value: readonly [];
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "defineQueueMethods";
+        readonly target: "analytics";
+        readonly methods: ["track", "page", "identify", "group", "alias", "reset"];
+    }];
+    readonly install: [{
+        readonly type: "callGlobal";
+        readonly global: "analytics";
+        readonly method: "page";
+    }, {
+        readonly type: "loadScript";
+        readonly src: "{{scriptUrl}}";
+        readonly async: true;
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+export interface SegmentOptions {
+    /** 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 function segment({ writeKey, trackPageView, scriptUrl, }: SegmentOptions): Script;

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

@@ -0,0 +1,93 @@
+import type { Script } from 'c15t';
+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 vendor: "umami-analytics";
+    readonly category: "measurement";
+    readonly install: [{
+        readonly type: "loadScript";
+        readonly src: "{{scriptUrl}}";
+        readonly defer: true;
+        readonly attributes: {
+            readonly 'data-website-id': "{{websiteId}}";
+            readonly 'data-host-url': "{{hostUrl}}";
+            readonly 'data-auto-track': "{{autoTrackAttribute}}";
+            readonly 'data-domains': "{{domains}}";
+            readonly 'data-tag': "{{tag}}";
+            readonly 'data-before-send': "{{beforeSend}}";
+        };
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+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 function umamiAnalytics(options: UmamiAnalyticsOptions): Script;

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

@@ -0,0 +1,66 @@
+import type { Script } from 'c15t';
+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 vendor: "vercel-analytics";
+    readonly category: "measurement";
+    readonly bootstrap: [{
+        readonly type: "setGlobal";
+        readonly name: "vaq";
+        readonly value: readonly [];
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "defineStubFunction";
+        readonly name: "va";
+        readonly queue: {
+            readonly global: "vaq";
+        };
+        readonly queueFormat: "array";
+        readonly ifUndefined: true;
+    }];
+    readonly install: [{
+        readonly type: "loadScript";
+        readonly src: "{{scriptUrl}}";
+        readonly defer: true;
+        readonly attributes: {
+            readonly 'data-sdkn': "c15t";
+            readonly 'data-dsn': "{{dsn}}";
+            readonly 'data-disable-auto-track': "{{disableAutoTrackAttribute}}";
+            readonly 'data-endpoint': "{{endpoint}}";
+        };
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+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 function vercelAnalytics(options?: VercelAnalyticsOptions): Script;

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

@@ -0,0 +1,78 @@
+import type { Script } from 'c15t';
+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 vendor: "crisp";
+    readonly category: "functionality";
+    readonly install: [{
+        readonly type: "setGlobal";
+        readonly name: "$crisp";
+        readonly value: readonly [];
+        readonly ifUndefined: false;
+    }, {
+        readonly type: "setGlobal";
+        readonly name: "CRISP_WEBSITE_ID";
+        readonly value: "{{websiteId}}";
+        readonly ifUndefined: false;
+    }, {
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}";
+        readonly async: true;
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+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 function crisp(options: CrispOptions): Script;

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

@@ -0,0 +1,135 @@
+import type { Script } from 'c15t';
+export declare const INTERCOM_API_BASES: {
+    readonly us: "https://api-iam.intercom.io";
+    readonly eu: "https://api-iam.eu.intercom.io";
+    readonly au: "https://api-iam.au.intercom.io";
+};
+export type IntercomApiBase = (typeof INTERCOM_API_BASES)[keyof typeof INTERCOM_API_BASES] | (string & {});
+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 vendor: "intercom";
+    readonly category: "functionality";
+    readonly install: [{
+        readonly type: "defineStubFunction";
+        readonly name: "Intercom";
+        readonly queue: {
+            readonly property: "q";
+        };
+        readonly queueFormat: "array";
+        readonly ifUndefined: true;
+    }, {
+        readonly type: "setGlobal";
+        readonly name: "intercomSettings";
+        readonly value: "{{settings}}";
+        readonly ifUndefined: false;
+    }, {
+        readonly type: "loadScript";
+        readonly src: "{{scriptSrc}}";
+        readonly async: true;
+    }];
+    readonly kind: "c15t.vendor-manifest";
+    readonly schemaVersion: 1;
+};
+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 function intercom({ appId, apiBase, settings, scriptSrc, }: IntercomOptions): Script;

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

@@ -32,7 +32,10 @@ export declare const googleTagManagerManifest: {
         readonly type: "pushToQueue";
         readonly queue: "dataLayer";
         readonly value: {
-            readonly 'gtm.start': "{{loadTime}}";
+            readonly 'gtm.start': {
+                readonly kind: "c15t.runtime-value";
+                readonly value: "timestamp";
+            };
             readonly event: "gtm.js";
         };
     }, {
@@ -45,13 +48,7 @@ export declare const googleTagManagerManifest: {
         readonly global: "gtag";
         readonly args: ["event", "{{updateEventName}}"];
     }];
-    readonly consentMapping: {
-        readonly necessary: ["security_storage"];
-        readonly functionality: ["functionality_storage"];
-        readonly measurement: ["analytics_storage"];
-        readonly marketing: ["ad_storage", "ad_user_data", "ad_personalization"];
-        readonly experience: ["personalization_storage"];
-    };
+    readonly consentMapping: Record<string, string[]>;
     readonly consentSignal: "gtag";
     readonly kind: "c15t.vendor-manifest";
     readonly schemaVersion: 1;