posthog-react-native 2.1.3 → 2.2.0-alpha1

package/lib/index.d.ts

@@ -9,6 +9,11 @@ declare type PosthogCoreOptions = {
     enable?: boolean;
     sendFeatureFlagEvent?: boolean;
     preloadFeatureFlags?: boolean;
+    bootstrap?: {
+        distinctId?: string;
+        isIdentifiedId?: boolean;
+        featureFlags?: Record<string, boolean | string>;
+    };
     fetchRetryCount?: number;
     fetchRetryDelay?: number;
     sessionExpirationTimeSeconds?: number;
@@ -34,7 +39,8 @@ declare type PostHogFetchOptions = {
     headers: {
         [key: string]: string;
     };
-    body: string;
+    body?: string;
+    signal?: AbortSignal;
 };
 declare type PostHogFetchResponse = {
     status: number;
@@ -108,6 +114,7 @@ declare abstract class PostHogCore {
     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;
@@ -158,6 +165,7 @@ declare abstract class PostHogCore {
      ***/
     private decideAsync;
     private _decideAsync;
+    private setKnownFeatureFlags;
     getFeatureFlag(key: string): boolean | string | undefined;
     getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
     isFeatureEnabled(key: string): boolean | undefined;
@@ -179,14 +187,61 @@ declare abstract class PostHogCore {
     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;
-    static initAsync(): Promise<void>;
+    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>;
@@ -199,20 +254,6 @@ declare class PostHog extends PostHogCore {
 
 declare function useLifecycleTracker(client?: PostHog): 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[];
-    navigation?: PostHogAutocaptureNavigationTrackerOptions;
-};
-
 declare function _useNavigationTracker(options?: PostHogAutocaptureNavigationTrackerOptions, client?: PostHog): void;
 declare const useNavigationTracker: typeof _useNavigationTracker;
 
@@ -232,4 +273,4 @@ interface PostHogProviderProps {
 }
 declare const PostHogProvider: ({ children, client, options, apiKey, autocapture, style, }: PostHogProviderProps) => JSX.Element;
 
-export { PostHog, PostHogAutocaptureNavigationTrackerOptions, PostHogAutocaptureOptions, PostHogOptions, PostHogProvider, PostHogProviderProps, PostHog as default, useFeatureFlag, useFeatureFlags, useLifecycleTracker, useNavigationTracker, usePostHog };
+export { PostHog, PostHogAutocaptureNavigationTrackerOptions, PostHogAutocaptureOptions, PostHogCustomAppProperties, PostHogCustomAsyncStorage, PostHogOptions, PostHogProvider, PostHogProviderProps, PostHog as default, useFeatureFlag, useFeatureFlags, useLifecycleTracker, useNavigationTracker, usePostHog };