@copilotkit/shared/dist/telemetry/telemetry-client.d.ts

<img src="https://github.com/user-attachments/assets/0a6b64d9-e193-4940-a3f6-60334ac34084" alt="banner" style="border-radius: 12px; border: 2px solid #d6d4fa;" />

import { Analytics } from '@segment/analytics-node';
import { AnalyticsEvents } from './events.js';

/**
 * Checks if telemetry is disabled via environment variables.
 * Users can opt out by setting:
 * - COPILOTKIT_TELEMETRY_DISABLED=true or COPILOTKIT_TELEMETRY_DISABLED=1
 * - DO_NOT_TRACK=true or DO_NOT_TRACK=1
 */
declare function isTelemetryDisabled(): boolean;
declare class TelemetryClient {
    segment: Analytics | undefined;
    globalProperties: Record<string, any>;
    cloudConfiguration: {
        publicApiKey: string;
        baseUrl: string;
    } | null;
    packageName: string;
    packageVersion: string;
    private telemetryDisabled;
    private sampleRate;
    private anonymousId;
    constructor({ packageName, packageVersion, telemetryDisabled, telemetryBaseUrl, sampleRate, }: {
        packageName: string;
        packageVersion: string;
        telemetryDisabled?: boolean;
        telemetryBaseUrl?: string;
        sampleRate?: number;
    });
    private shouldSendEvent;
    capture<K extends keyof AnalyticsEvents>(event: K, properties: AnalyticsEvents[K]): Promise<void>;
    setGlobalProperties(properties: Record<string, any>): void;
    setCloudConfiguration(properties: {
        publicApiKey: string;
        baseUrl: string;
    }): void;
    private setSampleRate;
}

export { TelemetryClient, isTelemetryDisabled };