posthog-react-native 2.0.0-alpha9 → 2.0.0

package/lib/index.d.ts

@@ -9,13 +9,13 @@ declare type PosthogCoreOptions = {
     enable?: boolean;
     sendFeatureFlagEvent?: boolean;
     preloadFeatureFlags?: boolean;
-    decidePollInterval?: number;
     fetchRetryCount?: number;
     fetchRetryDelay?: number;
     sessionExpirationTimeSeconds?: number;
     captureMode?: 'json' | 'form';
 };
 declare enum PostHogPersistedProperty {
+    AnonymousId = "anonymous_id",
     DistinctId = "distinct_id",
     Props = "props",
     FeatureFlags = "feature_flags",
@@ -37,6 +37,7 @@ declare type PostHogFetchOptions = {
 declare type PostHogFetchResponse = {
     status: number;
     text: () => Promise<string>;
+    json: () => Promise<any>;
 };
 declare type PostHogEventProperties = {
     [key: string]: any;
@@ -75,10 +76,10 @@ interface RetriableOptions {
 
 declare class SimpleEventEmitter {
     events: {
-        [key: string]: ((e: any) => void)[];
+        [key: string]: ((...args: any[]) => void)[];
     };
     constructor();
-    on(event: string, listener: (e: any) => void): () => void;
+    on(event: string, listener: (...args: any[]) => void): () => void;
     emit(event: string, payload: any): void;
 }
 
@@ -90,11 +91,10 @@ declare abstract class PostHogCore {
     private captureMode;
     private sendFeatureFlagEvent;
     private flagCallReported;
+    private removeDebugCallback?;
     protected _events: SimpleEventEmitter;
     protected _flushTimer?: any;
     protected _decideResponsePromise?: Promise<PostHogDecideResponse>;
-    protected _decideTimer?: any;
-    protected _decidePollInterval: number;
     protected _retryOptions: RetriableOptions;
     protected _sessionExpirationTimeSeconds: number;
     abstract fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
@@ -112,10 +112,13 @@ declare abstract class PostHogCore {
     get optedOut(): boolean;
     optIn(): void;
     optOut(): void;
-    on(event: string, cb: (e: any) => void): () => void;
+    on(event: string, cb: (...args: any[]) => void): () => void;
     reset(): void;
+    debug(enabled?: boolean): void;
     private buildPayload;
     getSessionId(): string | undefined;
+    resetSessionId(): void;
+    getAnonymousId(): string;
     getDistinctId(): string;
     register(properties: {
         [key: string]: any;
@@ -148,6 +151,7 @@ declare abstract class PostHogCore {
     isFeatureEnabled(key: string, defaultResult?: boolean): boolean;
     reloadFeatureFlagsAsync(): 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;
     /***
      *** QUEUEING AND FLUSHING
@@ -160,8 +164,12 @@ declare abstract class PostHogCore {
     shutdown(): void;
 }
 
-declare type PostHogOptions = PosthogCoreOptions;
+declare type PostHogOptions = PosthogCoreOptions & {
+    persistence?: 'memory' | 'file';
+};
 declare class PostHog extends PostHogCore {
+    private _persistence;
+    private _memoryStorage;
     static initAsync(): Promise<void>;
     constructor(apiKey: string, options?: PostHogOptions);
     getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
@@ -186,6 +194,7 @@ declare type PostHogAutocaptureOptions = {
     noCaptureProp?: string;
     maxElementsCaptured?: number;
     ignoreLabels?: string[];
+    propsToCapture?: string[];
     navigation?: PostHogAutocaptureNavigationTrackerOptions;
 };
 

package/lib/index.esm.js

@@ -1,6 +1,7 @@
 import { Platform, Dimensions, AppState, View } from 'react-native';
 import * as ExpoApplication from 'expo-application';
 import * as ExpoDevice from 'expo-device';
+import * as ExpoLocalization from 'expo-localization';
 import * as FileSystem from 'expo-file-system';
 import React, { useRef, useEffect, useState, useCallback } from 'react';
 
@@ -137,6 +138,7 @@ function __generator(thisArg, body) {
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
+    PostHogPersistedProperty["AnonymousId"] = "anonymous_id";
     PostHogPersistedProperty["DistinctId"] = "distinct_id";
     PostHogPersistedProperty["Props"] = "props";
     PostHogPersistedProperty["FeatureFlags"] = "feature_flags";
@@ -162,7 +164,7 @@ function retriable(fn, props) {
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
-                    _a = props.retryCount, retryCount = _a === void 0 ? 3 : _a, _b = props.retryDelay, retryDelay = _b === void 0 ? 1000 : _b, _c = props.retryCheck, retryCheck = _c === void 0 ? function () { return true; } : _c;
+                    _a = props.retryCount, retryCount = _a === void 0 ? 3 : _a, _b = props.retryDelay, retryDelay = _b === void 0 ? 5000 : _b, _c = props.retryCheck, retryCheck = _c === void 0 ? function () { return true; } : _c;
                     lastError = null;
                     i = 0;
                     _d.label = 1;
@@ -676,13 +678,14 @@ var SimpleEventEmitter = /** @class */ (function () {
         };
     };
     SimpleEventEmitter.prototype.emit = function (event, payload) {
-        if (!this.events[event]) {
-            return;
-        }
-        for (var _i = 0, _a = this.events[event]; _i < _a.length; _i++) {
+        for (var _i = 0, _a = this.events[event] || []; _i < _a.length; _i++) {
             var listener = _a[_i];
             listener(payload);
         }
+        for (var _b = 0, _c = this.events['*'] || []; _b < _c.length; _b++) {
+            var listener = _c[_b];
+            listener(event, payload);
+        }
     };
     return SimpleEventEmitter;
 }());
@@ -690,7 +693,7 @@ var SimpleEventEmitter = /** @class */ (function () {
 var PostHogCore = /** @class */ (function () {
     function PostHogCore(apiKey, options) {
         var _this = this;
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         this.flagCallReported = {};
         // internal
         this._events = new SimpleEventEmitter();
@@ -701,14 +704,13 @@ var PostHogCore = /** @class */ (function () {
         this.flushInterval = (_a = options === null || options === void 0 ? void 0 : options.flushInterval) !== null && _a !== void 0 ? _a : 10000;
         this.captureMode = (options === null || options === void 0 ? void 0 : options.captureMode) || 'form';
         this.sendFeatureFlagEvent = (_b = options === null || options === void 0 ? void 0 : options.sendFeatureFlagEvent) !== null && _b !== void 0 ? _b : true;
-        this._decidePollInterval = Math.max(0, (_c = options === null || options === void 0 ? void 0 : options.decidePollInterval) !== null && _c !== void 0 ? _c : 30000);
         // If enable is explicitly set to false we override the optout
         this._optoutOverride = (options === null || options === void 0 ? void 0 : options.enable) === false;
         this._retryOptions = {
-            retryCount: (_d = options === null || options === void 0 ? void 0 : options.fetchRetryCount) !== null && _d !== void 0 ? _d : 3,
-            retryDelay: (_e = options === null || options === void 0 ? void 0 : options.fetchRetryDelay) !== null && _e !== void 0 ? _e : 3000,
+            retryCount: (_c = options === null || options === void 0 ? void 0 : options.fetchRetryCount) !== null && _c !== void 0 ? _c : 3,
+            retryDelay: (_d = options === null || options === void 0 ? void 0 : options.fetchRetryDelay) !== null && _d !== void 0 ? _d : 3000,
         };
-        this._sessionExpirationTimeSeconds = (_f = options === null || options === void 0 ? void 0 : options.sessionExpirationTimeSeconds) !== null && _f !== void 0 ? _f : 1800; // 30 minutes
+        this._sessionExpirationTimeSeconds = (_e = options === null || options === void 0 ? void 0 : options.sessionExpirationTimeSeconds) !== null && _e !== void 0 ? _e : 1800; // 30 minutes
         // NOTE: It is important we don't initiate anything in the constructor as some async IO may still be underway on the parent
         if ((options === null || options === void 0 ? void 0 : options.preloadFeatureFlags) !== false) {
             safeSetTimeout(function () {
@@ -760,7 +762,14 @@ var PostHogCore = /** @class */ (function () {
         for (var key in PostHogPersistedProperty) {
             this.setPersistedProperty(PostHogPersistedProperty[key], null);
         }
-        this.setPersistedProperty(PostHogPersistedProperty.DistinctId, generateUUID(globalThis));
+    };
+    PostHogCore.prototype.debug = function (enabled) {
+        var _a;
+        if (enabled === void 0) { enabled = true; }
+        (_a = this.removeDebugCallback) === null || _a === void 0 ? void 0 : _a.call(this);
+        if (enabled) {
+            this.removeDebugCallback = this.on('*', function (event, payload) { return console.log('PostHog Debug', event, payload); });
+        }
     };
     PostHogCore.prototype.buildPayload = function (payload) {
         return {
@@ -779,13 +788,19 @@ var PostHogCore = /** @class */ (function () {
         this.setPersistedProperty(PostHogPersistedProperty.SessionLastTimestamp, Date.now());
         return sessionId;
     };
-    PostHogCore.prototype.getDistinctId = function () {
-        var distinctId = this.getPersistedProperty(PostHogPersistedProperty.DistinctId);
-        if (!distinctId) {
-            distinctId = generateUUID(globalThis);
-            this.setPersistedProperty(PostHogPersistedProperty.DistinctId, distinctId);
+    PostHogCore.prototype.resetSessionId = function () {
+        this.setPersistedProperty(PostHogPersistedProperty.SessionId, null);
+    };
+    PostHogCore.prototype.getAnonymousId = function () {
+        var anonId = this.getPersistedProperty(PostHogPersistedProperty.AnonymousId);
+        if (!anonId) {
+            anonId = generateUUID(globalThis);
+            this.setPersistedProperty(PostHogPersistedProperty.AnonymousId, anonId);
         }
-        return distinctId;
+        return anonId;
+    };
+    PostHogCore.prototype.getDistinctId = function () {
+        return this.getPersistedProperty(PostHogPersistedProperty.DistinctId) || this.getAnonymousId();
     };
     PostHogCore.prototype.register = function (properties) {
         this.props = __assign(__assign({}, this.props), properties);
@@ -799,27 +814,28 @@ var PostHogCore = /** @class */ (function () {
      *** TRACKING
      ***/
     PostHogCore.prototype.identify = function (distinctId, properties) {
-        distinctId = distinctId || this.getDistinctId();
+        var previousDistinctId = this.getDistinctId();
+        distinctId = distinctId || previousDistinctId;
         if (properties === null || properties === void 0 ? void 0 : properties.$groups) {
             this.groups(properties.$groups);
         }
         var payload = __assign(__assign({}, this.buildPayload({
             distinct_id: distinctId,
             event: '$identify',
-            properties: __assign(__assign({}, (properties || {})), { $anon_distinct_id: this.getDistinctId() }),
+            properties: __assign(__assign({}, (properties || {})), { $anon_distinct_id: this.getAnonymousId() }),
         })), { $set: properties });
-        if (distinctId !== this.getDistinctId()) {
+        if (distinctId !== previousDistinctId) {
+            // We keep the AnonymousId to be used by decide calls and identify to link the previousId
+            this.setPersistedProperty(PostHogPersistedProperty.AnonymousId, previousDistinctId);
             this.setPersistedProperty(PostHogPersistedProperty.DistinctId, distinctId);
+            if (this.getFeatureFlags()) {
+                void this.reloadFeatureFlagsAsync();
+            }
         }
         this.enqueue('identify', payload);
         return this;
     };
     PostHogCore.prototype.capture = function (event, properties) {
-        // NOTE: Legacy nodejs implementation uses groups
-        if (properties && properties['groups']) {
-            properties.$groups = properties.groups;
-            delete properties.groups;
-        }
         if (properties === null || properties === void 0 ? void 0 : properties.$groups) {
             this.groups(properties.$groups);
         }
@@ -858,7 +874,7 @@ var PostHogCore = /** @class */ (function () {
         this.register({
             $groups: __assign(__assign({}, existingGroups), groups),
         });
-        if (Object.keys(groups).find(function (type) { return existingGroups[type] !== groups[type]; }) && this._decideResponsePromise) {
+        if (Object.keys(groups).find(function (type) { return existingGroups[type] !== groups[type]; }) && this.getFeatureFlags()) {
             void this.reloadFeatureFlagsAsync();
         }
         return this;
@@ -902,16 +918,24 @@ var PostHogCore = /** @class */ (function () {
                 fetchOptions = {
                     method: 'POST',
                     headers: { 'Content-Type': 'application/json' },
-                    body: JSON.stringify({ groups: groups, distinct_id: distinctId, token: this.apiKey }),
+                    body: JSON.stringify({
+                        token: this.apiKey,
+                        distinct_id: distinctId,
+                        $anon_distinct_id: this.getAnonymousId(),
+                        groups: groups,
+                    }),
                 };
                 this._decideResponsePromise = this.fetchWithRetry(url, fetchOptions)
                     .then(function (r) { return r.json(); })
                     .then(function (res) {
                     if (res.featureFlags) {
                         _this.setPersistedProperty(PostHogPersistedProperty.FeatureFlags, res.featureFlags);
+                        _this._events.emit('featureflags', res.featureFlags);
                     }
-                    _this._events.emit('featureflags', res.featureFlags);
                     return res;
+                })
+                    .finally(function () {
+                    _this._decideResponsePromise = undefined;
                 });
                 return [2 /*return*/, this._decideResponsePromise];
             });
@@ -960,27 +984,16 @@ var PostHogCore = /** @class */ (function () {
     };
     PostHogCore.prototype.reloadFeatureFlagsAsync = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        clearTimeout(this._decideTimer);
-                        if (this._decidePollInterval) {
-                            this._decideTimer = safeSetTimeout(function () { return _this.reloadFeatureFlagsAsync(); }, this._decidePollInterval);
-                        }
-                        this._decideResponsePromise = undefined;
-                        return [4 /*yield*/, this.decideAsync()];
+                    case 0: return [4 /*yield*/, this.decideAsync()];
                     case 1: return [2 /*return*/, (_a.sent()).featureFlags];
                 }
             });
         });
     };
-    // When listening to feature flags polling is active
     PostHogCore.prototype.onFeatureFlags = function (cb) {
         var _this = this;
-        if (!this._decideTimer) {
-            void this.reloadFeatureFlagsAsync();
-        }
         return this.on('featureflags', function () { return __awaiter(_this, void 0, void 0, function () {
             var flags;
             return __generator(this, function (_a) {
@@ -992,6 +1005,19 @@ var PostHogCore = /** @class */ (function () {
             });
         }); });
     };
+    PostHogCore.prototype.onFeatureFlag = function (key, cb) {
+        var _this = this;
+        return this.on('featureflags', function () { return __awaiter(_this, void 0, void 0, function () {
+            var flagResponse;
+            return __generator(this, function (_a) {
+                flagResponse = this.getFeatureFlag(key);
+                if (flagResponse !== undefined) {
+                    cb(flagResponse);
+                }
+                return [2 /*return*/];
+            });
+        }); });
+    };
     PostHogCore.prototype.overrideFeatureFlag = function (flags) {
         if (flags === null) {
             return this.setPersistedProperty(PostHogPersistedProperty.OverrideFeatureFlags, null);
@@ -1099,7 +1125,6 @@ var PostHogCore = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        clearTimeout(this._decideTimer);
                         clearTimeout(this._flushTimer);
                         return [4 /*yield*/, this.flushAsync()];
                     case 1:
@@ -1115,6 +1140,19 @@ var PostHogCore = /** @class */ (function () {
     return PostHogCore;
 }());
 
+var PostHogMemoryStorage = /** @class */ (function () {
+    function PostHogMemoryStorage() {
+        this._memoryStorage = {};
+    }
+    PostHogMemoryStorage.prototype.getProperty = function (key) {
+        return this._memoryStorage[key];
+    };
+    PostHogMemoryStorage.prototype.setProperty = function (key, value) {
+        this._memoryStorage[key] = value !== null ? value : undefined;
+    };
+    return PostHogMemoryStorage;
+}());
+
 var getLegacyValues = function () {
   return __awaiter(void 0, void 0, void 0, function () {
     var posthogFileDirectory, posthogDistinctIdFile, posthogAnonymousIdFile, res, _a, _b, _c, _d, _e, _f;
@@ -1299,36 +1337,7 @@ var preloadSemiAsyncStorage = function () {
   return _preloadSemiAsyncStoragePromise;
 };
 
-var _OptionalReactNativeNavigation = undefined;
-var _OptionalExpoLocalization = undefined;
-var _OptionalExpoNetwork = undefined;
-
-var warn = function (name) {
-  console.warn("PostHog: Missing ".concat(name, " optional dependency. Some functions may not work as expected..."));
-};
-
-try {
-  _OptionalReactNativeNavigation = require('@react-navigation/native');
-} catch (e) {
-  warn('@react-navigation/native');
-}
-
-try {
-  _OptionalExpoLocalization = require('expo-localization');
-} catch (e) {
-  warn('expo-localization');
-}
-
-try {
-  _OptionalExpoNetwork = require('expo-network');
-} catch (e) {
-  warn('expo-network');
-}
-
-var OptionalReactNativeNavigation = _OptionalReactNativeNavigation;
-var OptionalExpoLocalization = _OptionalExpoLocalization;
-
-var version = "2.0.0-alpha9";
+var version = "2.0.0";
 
 var PostHog =
 /** @class */
@@ -1338,16 +1347,19 @@ function (_super) {
   function PostHog(apiKey, options) {
     var _this = _super.call(this, apiKey, options) || this;
 
+    _this._memoryStorage = new PostHogMemoryStorage();
+    _this._persistence = options === null || options === void 0 ? void 0 : options.persistence;
     AppState.addEventListener('change', function () {
       _this.flush();
     }); // Ensure the async storage has been preloaded (this call is cached)
     // It is possible that the old library was used so we try to get the legacy distinctID
 
     void preloadSemiAsyncStorage().then(function () {
-      if (!SemiAsyncStorage.getItem(PostHogPersistedProperty.DistinctId)) {
+      if (!SemiAsyncStorage.getItem(PostHogPersistedProperty.AnonymousId)) {
         getLegacyValues().then(function (legacyValues) {
           if (legacyValues === null || legacyValues === void 0 ? void 0 : legacyValues.distinctId) {
             SemiAsyncStorage.setItem(PostHogPersistedProperty.DistinctId, legacyValues.distinctId);
+            SemiAsyncStorage.setItem(PostHogPersistedProperty.AnonymousId, legacyValues.anonymousId);
           }
         });
       }
@@ -1360,10 +1372,18 @@ function (_super) {
   };
 
   PostHog.prototype.getPersistedProperty = function (key) {
+    if (this._persistence === 'memory') {
+      return this._memoryStorage.getProperty(key);
+    }
+
     return SemiAsyncStorage.getItem(key) || undefined;
   };
 
   PostHog.prototype.setPersistedProperty = function (key, value) {
+    if (this._persistence === 'memory') {
+      return this._memoryStorage.getProperty(key);
+    }
+
     return value !== null ? SemiAsyncStorage.setItem(key, value) : SemiAsyncStorage.removeItem(key);
   };
 
@@ -1380,29 +1400,24 @@ function (_super) {
   };
 
   PostHog.prototype.getCustomUserAgent = function () {
-    // TODO
     return;
   };
 
   PostHog.prototype.getCommonEventProperties = function () {
     return __assign(__assign({}, _super.prototype.getCommonEventProperties.call(this)), {
       $app_build: '1',
-      $app_name: ExpoApplication === null || ExpoApplication === void 0 ? void 0 : ExpoApplication.applicationName,
-      $app_namespace: ExpoApplication === null || ExpoApplication === void 0 ? void 0 : ExpoApplication.applicationId,
-      $app_version: ExpoApplication === null || ExpoApplication === void 0 ? void 0 : ExpoApplication.nativeApplicationVersion,
-      // "$device_id": "F31C35E8-5B28-4626-8AFC-213D1C655FF9",
-      $device_manufacturer: ExpoDevice === null || ExpoDevice === void 0 ? void 0 : ExpoDevice.manufacturer,
-      //     "$device_model": "x86_64",
-      $device_name: ExpoDevice === null || ExpoDevice === void 0 ? void 0 : ExpoDevice.modelName,
-      // "$device_type": "ios",
-      $locale: OptionalExpoLocalization === null || OptionalExpoLocalization === void 0 ? void 0 : OptionalExpoLocalization.locale,
-      //     "$network_cellular": false,
-      //     "$network_wifi": true,
-      $os_name: ExpoDevice === null || ExpoDevice === void 0 ? void 0 : ExpoDevice.osName,
-      $os_version: ExpoDevice === null || ExpoDevice === void 0 ? void 0 : ExpoDevice.osVersion,
+      $app_name: ExpoApplication.applicationName,
+      $app_namespace: ExpoApplication.applicationId,
+      $app_version: ExpoApplication.nativeApplicationVersion,
+      $device_manufacturer: ExpoDevice.manufacturer,
+      $device_name: ExpoDevice.modelName,
+      $device_type: Platform.OS,
+      $locale: ExpoLocalization.locale,
+      $os_name: ExpoDevice.osName,
+      $os_version: ExpoDevice.osVersion,
       $screen_height: Dimensions.get('screen').height,
       $screen_width: Dimensions.get('screen').width,
-      $timezone: OptionalExpoLocalization === null || OptionalExpoLocalization === void 0 ? void 0 : OptionalExpoLocalization.timezone
+      $timezone: ExpoLocalization.timezone
     });
   }; // Custom methods
 
@@ -1460,6 +1475,20 @@ function useLifecycleTracker(client) {
   }, [posthog]);
 }
 
+var _OptionalReactNativeNavigation = undefined;
+
+var warn = function (name) {
+  console.warn("PostHog: Missing ".concat(name, " optional dependency. Some functions may not work as expected..."));
+};
+
+try {
+  _OptionalReactNativeNavigation = require('@react-navigation/native');
+} catch (e) {
+  warn('@react-navigation/native');
+}
+
+var OptionalReactNativeNavigation = _OptionalReactNativeNavigation;
+
 function _useNavigationTrackerDisabled() {
   return;
 }
@@ -1606,7 +1635,9 @@ var autocaptureFromTouchEvent = function (e, posthog, options) {
       _e = options.maxElementsCaptured,
       maxElementsCaptured = _e === void 0 ? 20 : _e,
       _f = options.ignoreLabels,
-      ignoreLabels = _f === void 0 ? [] : _f;
+      ignoreLabels = _f === void 0 ? [] : _f,
+      _g = options.propsToCapture,
+      propsToCapture = _g === void 0 ? ['style', 'testID', 'accessibilityLabel', 'ph-label'] : _g;
 
   if (!e._targetInst) {
     return;
@@ -1621,8 +1652,19 @@ var autocaptureFromTouchEvent = function (e, posthog, options) {
     };
     var props = currentInst.memoizedProps;
 
+    if (props === null || props === void 0 ? void 0 : props[noCaptureProp]) {
+      return {
+        value: void 0
+      };
+    }
+
     if (props) {
+      // Capture only props we have said to capture. By default this is only "safe" props
       Object.keys(props).forEach(function (key) {
+        if (!propsToCapture.includes(key)) {
+          return;
+        }
+
         var value = props[key];
 
         if (key === 'style') {
@@ -1635,12 +1677,6 @@ var autocaptureFromTouchEvent = function (e, posthog, options) {
           }
         }
       });
-    }
-
-    if (props === null || props === void 0 ? void 0 : props[noCaptureProp]) {
-      return {
-        value: void 0
-      };
     } // Try and find a sensible label