posthog-react-native 2.2.0-alpha1 → 2.2.0-alpha3

package/lib/index.d.ts

@@ -1,276 +0,0 @@
-import { PostHogDecideResponse as PostHogDecideResponse$1 } from 'posthog-core';
-import React from 'react';
-import { StyleProp, ViewStyle } from 'react-native';
-
-declare type PosthogCoreOptions = {
-    host?: string;
-    flushAt?: number;
-    flushInterval?: number;
-    enable?: boolean;
-    sendFeatureFlagEvent?: boolean;
-    preloadFeatureFlags?: boolean;
-    bootstrap?: {
-        distinctId?: string;
-        isIdentifiedId?: boolean;
-        featureFlags?: Record<string, boolean | string>;
-    };
-    fetchRetryCount?: number;
-    fetchRetryDelay?: number;
-    sessionExpirationTimeSeconds?: number;
-    captureMode?: 'json' | 'form';
-};
-declare enum PostHogPersistedProperty {
-    AnonymousId = "anonymous_id",
-    DistinctId = "distinct_id",
-    Props = "props",
-    FeatureFlags = "feature_flags",
-    OverrideFeatureFlags = "override_feature_flags",
-    Queue = "queue",
-    OptedOut = "opted_out",
-    SessionId = "session_id",
-    SessionLastTimestamp = "session_timestamp",
-    PersonProperties = "person_properties",
-    GroupProperties = "group_properties"
-}
-declare type PostHogFetchOptions = {
-    method: 'GET' | 'POST' | 'PUT' | 'PATCH';
-    mode?: 'no-cors';
-    credentials?: 'omit';
-    headers: {
-        [key: string]: string;
-    };
-    body?: string;
-    signal?: AbortSignal;
-};
-declare type PostHogFetchResponse = {
-    status: number;
-    text: () => Promise<string>;
-    json: () => Promise<any>;
-};
-declare type PostHogEventProperties = {
-    [key: string]: any;
-};
-declare type PostHogAutocaptureElement = {
-    $el_text?: string;
-    tag_name: string;
-    href?: string;
-    nth_child?: number;
-    nth_of_type?: number;
-    order?: number;
-} & {
-    [key: string]: any;
-};
-declare type PostHogDecideResponse = {
-    config: {
-        enable_collect_everything: boolean;
-    };
-    editorParams: {
-        toolbarVersion: string;
-        jsURL: string;
-    };
-    isAuthenticated: true;
-    supportedCompression: string[];
-    featureFlags: {
-        [key: string]: string | boolean;
-    };
-    sessionRecording: boolean;
-};
-
-interface RetriableOptions {
-    retryCount?: number;
-    retryDelay?: number;
-    retryCheck?: (err: any) => true;
-}
-
-declare class SimpleEventEmitter {
-    events: {
-        [key: string]: ((...args: any[]) => void)[];
-    };
-    constructor();
-    on(event: string, listener: (...args: any[]) => void): () => void;
-    emit(event: string, payload: any): void;
-}
-
-declare abstract class PostHogCore {
-    private apiKey;
-    host: string;
-    private flushAt;
-    private flushInterval;
-    private captureMode;
-    private sendFeatureFlagEvent;
-    private flagCallReported;
-    private removeDebugCallback?;
-    protected _events: SimpleEventEmitter;
-    protected _flushTimer?: any;
-    protected _decideResponsePromise?: Promise<PostHogDecideResponse>;
-    protected _retryOptions: RetriableOptions;
-    protected _sessionExpirationTimeSeconds: number;
-    abstract fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
-    abstract getLibraryId(): string;
-    abstract getLibraryVersion(): string;
-    abstract getCustomUserAgent(): string | void;
-    abstract getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
-    abstract setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
-    private _optoutOverride;
-    constructor(apiKey: string, options?: PosthogCoreOptions);
-    protected getCommonEventProperties(): any;
-    protected setupBootstrap(options?: Partial<PosthogCoreOptions>): void;
-    private get props();
-    private set props(value);
-    private clearProps;
-    private _props;
-    get optedOut(): boolean;
-    optIn(): void;
-    optOut(): void;
-    on(event: string, cb: (...args: any[]) => void): () => void;
-    reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
-    debug(enabled?: boolean): void;
-    private buildPayload;
-    getSessionId(): string | undefined;
-    resetSessionId(): void;
-    getAnonymousId(): string;
-    getDistinctId(): string;
-    register(properties: {
-        [key: string]: any;
-    }): void;
-    unregister(property: string): void;
-    /***
-     *** TRACKING
-     ***/
-    identify(distinctId?: string, properties?: PostHogEventProperties): this;
-    capture(event: string, properties?: {
-        [key: string]: any;
-    }, forceSendFeatureFlags?: boolean): this;
-    alias(alias: string): this;
-    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties): this;
-    /***
-     *** GROUPS
-     ***/
-    groups(groups: {
-        [type: string]: string | number;
-    }): this;
-    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties): this;
-    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties): this;
-    /***
-     * PROPERTIES
-     ***/
-    personProperties(properties: {
-        [type: string]: string;
-    }): this;
-    groupProperties(properties: {
-        [type: string]: Record<string, string>;
-    }): this;
-    /***
-     *** FEATURE FLAGS
-     ***/
-    private decideAsync;
-    private _decideAsync;
-    private setKnownFeatureFlags;
-    getFeatureFlag(key: string): boolean | string | undefined;
-    getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
-    isFeatureEnabled(key: string): boolean | undefined;
-    reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags']>;
-    onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
-    onFeatureFlag(key: string, cb: (value: string | boolean) => void): () => void;
-    overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): void;
-    _sendFeatureFlags(event: string, properties?: {
-        [key: string]: any;
-    }): void;
-    /***
-     *** QUEUEING AND FLUSHING
-     ***/
-    private enqueue;
-    flushAsync(): Promise<any>;
-    flush(callback?: (err?: any, data?: any) => void): void;
-    private fetchWithRetry;
-    shutdownAsync(): Promise<void>;
-    shutdown(): void;
-}
-
-declare type PostHogAutocaptureNavigationTrackerOptions = {
-    routeToName?: (name: string, params: any) => string;
-    routeToProperties?: (name: string, params: any) => string;
-};
-declare type PostHogAutocaptureOptions = {
-    captureTouches?: boolean;
-    customLabelProp?: string;
-    noCaptureProp?: string;
-    maxElementsCaptured?: number;
-    ignoreLabels?: string[];
-    propsToCapture?: string[];
-    captureScreens?: boolean;
-    navigation?: PostHogAutocaptureNavigationTrackerOptions;
-    captureLifecycleEvents?: boolean;
-};
-interface PostHogCustomAppProperties {
-    /** Build number like "1.2.2" or "122" */
-    $app_build?: string | null;
-    /** Name of the app as displayed below the icon like "PostHog" */
-    $app_name?: string | null;
-    /** Namespace of the app usually like "com.posthog.app" */
-    $app_namespace?: string | null;
-    /** Human friendly app version like what a user would see in the app store like "1.2.2" */
-    $app_version?: string | null;
-    /** Manufacturer like "Apple", "Samsung" or "Android" */
-    $device_manufacturer?: string | null;
-    /** Readable model name like "iPhone 12" */
-    $device_name?: string | null;
-    /** Operating system name like iOS or Android */
-    $os_name?: string | null;
-    /** Operating system version "14.0" */
-    $os_version?: string | null;
-    /** Locale (language) of the device like "en-US" */
-    $locale?: string | null;
-    /** Timezone of the device like "Europe/Berlin" */
-    $timezone?: string | null;
-}
-interface PostHogCustomAsyncStorage {
-    getItem: (key: string) => Promise<string | null>;
-    setItem: (key: string, value: string) => Promise<void>;
-}
-
-declare type PostHogOptions = PosthogCoreOptions & {
-    persistence?: 'memory' | 'file';
-    customAppProperties?: PostHogCustomAppProperties;
-    customAsyncStorage?: PostHogCustomAsyncStorage;
-};
-declare class PostHog extends PostHogCore {
-    private _persistence;
-    private _memoryStorage;
-    private _semiAsyncStorage;
-    private _appProperties;
-    constructor(apiKey: string, options?: PostHogOptions);
-    /** Await this method to ensure that all state has been loaded from the async provider */
-    initAsync(): Promise<void>;
-    getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
-    setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
-    fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
-    getLibraryId(): string;
-    getLibraryVersion(): string;
-    getCustomUserAgent(): void;
-    getCommonEventProperties(): any;
-    screen(name: string, properties?: any): this;
-}
-
-declare function useLifecycleTracker(client?: PostHog): void;
-
-declare function _useNavigationTracker(options?: PostHogAutocaptureNavigationTrackerOptions, client?: PostHog): void;
-declare const useNavigationTracker: typeof _useNavigationTracker;
-
-declare function useFeatureFlags(client?: PostHog): PostHogDecideResponse$1['featureFlags'] | undefined;
-
-declare function useFeatureFlag(flag: string): string | boolean | undefined;
-
-declare const usePostHog: () => PostHog | undefined;
-
-interface PostHogProviderProps {
-    children: React.ReactNode;
-    options?: PostHogOptions;
-    apiKey?: string;
-    client?: PostHog;
-    autocapture?: boolean | PostHogAutocaptureOptions;
-    style?: StyleProp<ViewStyle>;
-}
-declare const PostHogProvider: ({ children, client, options, apiKey, autocapture, style, }: PostHogProviderProps) => JSX.Element;
-
-export { PostHog, PostHogAutocaptureNavigationTrackerOptions, PostHogAutocaptureOptions, PostHogCustomAppProperties, PostHogCustomAsyncStorage, PostHogOptions, PostHogProvider, PostHogProviderProps, PostHog as default, useFeatureFlag, useFeatureFlags, useLifecycleTracker, useNavigationTracker, usePostHog };