avo-inspector/dist/AvoInspector.d.ts

[](https://badge.fury.io/js/avo-inspector)

import { type AvoInspectorEnvValueType } from "./AvoInspectorEnv";
import { AvoBatcher } from "./AvoBatcher";
import { type EventProperty } from "./AvoNetworkCallsHandler";
import { AvoStorage } from "./AvoStorage";
import { AvoDeduplicator } from "./AvoDeduplicator";
export declare class AvoInspector {
    environment: AvoInspectorEnvValueType;
    avoBatcher: AvoBatcher;
    avoDeduplicator: AvoDeduplicator;
    apiKey: string;
    version: string;
    private avoNetworkCallsHandler;
    private publicEncryptionKey?;
    private streamId?;
    private eventSpecCache?;
    private eventSpecFetcher?;
    private currentBranchId;
    static avoStorage: AvoStorage;
    private static _batchSize;
    static get batchSize(): number;
    static set batchSize(newSize: number);
    private static _batchFlushSeconds;
    static get batchFlushSeconds(): number;
    private static _shouldLog;
    static get shouldLog(): boolean;
    static set shouldLog(enable: boolean);
    private static _networkTimeout;
    static get networkTimeout(): number;
    static set networkTimeout(timeout: number);
    constructor(options: {
        apiKey: string;
        env: AvoInspectorEnvValueType;
        version: string;
        appName?: string;
        suffix?: string;
        publicEncryptionKey?: string;
    });
    trackSchemaFromEvent(eventName: string, eventProperties: Record<string, any>): Promise<EventProperty[]>;
    private _avoFunctionTrackSchemaFromEvent;
    trackSchema(eventName: string, eventSchema: Array<{
        propertyName: string;
        propertyType: string;
        encryptedPropertyValue?: string;
        children?: any;
    }>): Promise<void>;
    private trackSchemaInternal;
    enableLogging(enable: boolean): void;
    extractSchema(eventProperties: Record<string, any>, shouldLogIfEnabled?: boolean): Promise<Array<{
        propertyName: string;
        propertyType: string;
        encryptedPropertyValue?: string;
        children?: any;
    }>>;
    setBatchSize(newBatchSize: number): void;
    setBatchFlushSeconds(newBatchFlushSeconds: number): void;
    /**
     * Handles branch change detection and cache storage for a fetched event spec.
     * This logic is shared between fetchEventSpecIfNeeded and fetchAndValidateEvent.
     */
    private handleBranchChangeAndCache;
    /**
     * Fetches the event spec if spec fetching is enabled.
     * Used by trackSchema when we don't have raw properties to validate.
     *
     * Note: EventSpec fetching only happens in dev/staging environments.
     */
    private fetchEventSpecIfNeeded;
    /**
     * Fetches event spec and validates the event against it.
     * Returns ValidationResult if spec is available, null otherwise.
     *
     * Note: EventSpec fetching and validation only happens in dev/staging environments.
     */
    private fetchAndValidateEvent;
    /**
     * Merges validation results into the event schema.
     * Adds failedEventIds or passedEventIds to each property based on validation.
     * Recursively merges validation results for nested children.
     */
    private mergeValidationResults;
    /**
     * Merges validation result into a single property, recursively handling children.
     */
    private mergePropertyValidation;
    /**
     * Sends an event immediately with validation data (bypasses batching).
     * Logs validation info if shouldLog is true.
     */
    private sendEventWithValidation;
}