posthog-react-native 2.1.4 → 2.2.0-alpha1

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# 2.1.4 - 2022-10-28
+
+Also include the fix in the compiled `lib` folder.
+
+# 2.1.3 - 2022-10-27
+
+Actually include the fix.
+
+# 2.1.2 - 2022-10-27
+
+Fix bug where all values set while stored data was being loaded would get overwritten once the data was done loading.
+
+# 2.1.1 - 2022-09-09
+
+Support for bootstrapping feature flags and distinctIDs. This allows you to initialise the library with a set of feature flags and distinctID that are immediately available.
+
+# 2.1.0 - 2022-09-02
+
+PosthogProvider `autocapture` can be configured with `captureLifecycleEvents: false` and `captureScreens: false` if you want do disable these autocapture elements. Both of these default to `true`

package/lib/index.cjs.js

@@ -3,36 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var reactNative = require('react-native');
-var ExpoApplication = require('expo-application');
-var ExpoDevice = require('expo-device');
-var ExpoLocalization = require('expo-localization');
-var FileSystem = require('expo-file-system');
 var React = require('react');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-function _interopNamespace(e) {
-    if (e && e.__esModule) return e;
-    var n = Object.create(null);
-    if (e) {
-        Object.keys(e).forEach(function (k) {
-            if (k !== 'default') {
-                var d = Object.getOwnPropertyDescriptor(e, k);
-                Object.defineProperty(n, k, d.get ? d : {
-                    enumerable: true,
-                    get: function () { return e[k]; }
-                });
-            }
-        });
-    }
-    n["default"] = e;
-    return Object.freeze(n);
-}
-
-var ExpoApplication__namespace = /*#__PURE__*/_interopNamespace(ExpoApplication);
-var ExpoDevice__namespace = /*#__PURE__*/_interopNamespace(ExpoDevice);
-var ExpoLocalization__namespace = /*#__PURE__*/_interopNamespace(ExpoLocalization);
-var FileSystem__namespace = /*#__PURE__*/_interopNamespace(FileSystem);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 
 /******************************************************************************
@@ -1277,6 +1251,22 @@ var PostHogMemoryStorage = /** @class */ (function () {
     return PostHogMemoryStorage;
 }());
 
+var _OptionalExpoApplication = undefined;
+
+try {
+  _OptionalExpoApplication = require('expo-application');
+} catch (e) {}
+
+var OptionalExpoApplication = _OptionalExpoApplication;
+
+var _OptionalExpoFileSystem = undefined;
+
+try {
+  _OptionalExpoFileSystem = require('expo-file-system');
+} catch (e) {}
+
+var OptionalExpoFileSystem = _OptionalExpoFileSystem;
+
 var getLegacyValues = function () {
   return __awaiter(void 0, void 0, void 0, function () {
     var posthogFileDirectory, posthogDistinctIdFile, posthogAnonymousIdFile, res, _a, _b, _c, _d, _e, _f;
@@ -1284,10 +1274,18 @@ var getLegacyValues = function () {
     return __generator(this, function (_g) {
       switch (_g.label) {
         case 0:
+          // NOTE: The old react-native lib stored data in files on the filesystem.
+          // This function takes care of pulling the legacy IDs to ensure we are using them if already present
+          if (!OptionalExpoFileSystem || !OptionalExpoApplication) {
+            return [2
+            /*return*/
+            ];
+          }
+
           if (!(reactNative.Platform.OS === 'ios')) return [3
           /*break*/
           , 8];
-          posthogFileDirectory = "".concat(FileSystem__namespace.documentDirectory, "../Library/Application%20Support/").concat(ExpoApplication__namespace.applicationId, "/");
+          posthogFileDirectory = "".concat(OptionalExpoFileSystem.documentDirectory, "../Library/Application%20Support/").concat(OptionalExpoApplication.applicationId, "/");
           posthogDistinctIdFile = posthogFileDirectory + 'posthog.distinctId';
           posthogAnonymousIdFile = posthogFileDirectory + 'posthog.anonymousId';
           res = {
@@ -1303,7 +1301,7 @@ var getLegacyValues = function () {
           _c = (_b = JSON).parse;
           return [4
           /*yield*/
-          , FileSystem__namespace.readAsStringAsync(posthogDistinctIdFile)];
+          , OptionalExpoFileSystem.readAsStringAsync(posthogDistinctIdFile)];
 
         case 2:
           _a.distinctId = _c.apply(_b, [_g.sent()])['posthog.distinctId'];
@@ -1324,7 +1322,7 @@ var getLegacyValues = function () {
           _f = (_e = JSON).parse;
           return [4
           /*yield*/
-          , FileSystem__namespace.readAsStringAsync(posthogAnonymousIdFile)];
+          , OptionalExpoFileSystem.readAsStringAsync(posthogAnonymousIdFile)];
 
         case 5:
           _d.anonymousId = _f.apply(_e, [_g.sent()])['posthog.anonymousId'];
@@ -1353,115 +1351,222 @@ var getLegacyValues = function () {
 };
 
 var POSTHOG_STORAGE_KEY = '.posthog-rn.json';
-var POSTHOG_STORAGE_VERSION = 'v1';
+var POSTHOG_STORAGE_VERSION = 'v1'; // NOTE: The core prefers a synchronous storage so we mimic this by pre-loading all keys
 
-var loadStorageAsync = function () {
-  return __awaiter(void 0, void 0, void 0, function () {
-    var uri, stringContent;
-    return __generator(this, function (_a) {
-      switch (_a.label) {
-        case 0:
-          uri = (FileSystem__namespace.documentDirectory || '') + POSTHOG_STORAGE_KEY;
-          _a.label = 1;
-
-        case 1:
-          _a.trys.push([1, 3,, 4]);
+var SemiAsyncStorage =
+/** @class */
+function () {
+  function SemiAsyncStorage(asyncStorage) {
+    this._memoryCache = {};
+    this._asyncStorage = asyncStorage;
+  }
 
-          return [4
-          /*yield*/
-          , FileSystem__namespace.readAsStringAsync(uri)];
+  SemiAsyncStorage.prototype.preloadAsync = function () {
+    var _this = this;
 
-        case 2:
-          stringContent = _a.sent();
-          return [2
-          /*return*/
-          , JSON.parse(stringContent).content];
+    if (this._preloadSemiAsyncStoragePromise) {
+      return this._preloadSemiAsyncStoragePromise;
+    }
 
-        case 3:
-          _a.sent();
-          return [2
-          /*return*/
-          , {}];
+    this._preloadSemiAsyncStoragePromise = this._asyncStorage.getItem(POSTHOG_STORAGE_KEY).then(function (res) {
+      try {
+        var data = res ? JSON.parse(res).content : {};
 
-        case 4:
-          return [2
-          /*return*/
-          ];
+        for (var key in data) {
+          _this._memoryCache[key] = _this._memoryCache[key] === undefined ? data[key] : _this._memoryCache[key];
+        }
+      } catch (e) {
+        console.warn("PostHog failed to load persisted data from storage. This is likely because the storage format is. We'll reset the storage.", e);
       }
     });
-  });
-};
+    return this._preloadSemiAsyncStoragePromise;
+  };
 
-var persistStorageAsync = function (content) {
-  return __awaiter(void 0, void 0, void 0, function () {
-    var uri, data;
-    return __generator(this, function (_a) {
-      switch (_a.label) {
-        case 0:
-          uri = (FileSystem__namespace.documentDirectory || '') + POSTHOG_STORAGE_KEY;
-          data = {
-            version: POSTHOG_STORAGE_VERSION,
-            content: content
-          };
-          return [4
-          /*yield*/
-          , FileSystem__namespace.writeAsStringAsync(uri, JSON.stringify(data)).catch(function (e) {
-            console.error('PostHog failed to persist data to storage', e);
-          })];
+  SemiAsyncStorage.prototype.persist = function () {
+    var payload = {
+      version: POSTHOG_STORAGE_VERSION,
+      content: this._memoryCache
+    };
+    void this._asyncStorage.setItem(POSTHOG_STORAGE_KEY, JSON.stringify(payload));
+  };
 
-        case 1:
-          _a.sent();
+  SemiAsyncStorage.prototype.getItem = function (key) {
+    return this._memoryCache[key];
+  };
 
-          return [2
-          /*return*/
-          ];
-      }
-    });
-  });
-}; // NOTE: The core prefers a synchronous storage so we mimic this by pre-loading all keys
-
-
-var _memoryCache = {};
-var SemiAsyncStorage = {
-  getItem: function (key) {
-    return _memoryCache[key];
-  },
-  setItem: function (key, value) {
-    _memoryCache[key] = value;
-    void persistStorageAsync(_memoryCache);
-  },
-  removeItem: function (key) {
-    delete _memoryCache[key];
-    void persistStorageAsync(_memoryCache);
-  },
-  clear: function () {
-    for (var key in _memoryCache) {
-      delete _memoryCache[key];
+  SemiAsyncStorage.prototype.setItem = function (key, value) {
+    this._memoryCache[key] = value;
+    this.persist();
+  };
+
+  SemiAsyncStorage.prototype.removeItem = function (key) {
+    delete this._memoryCache[key];
+    this.persist();
+  };
+
+  SemiAsyncStorage.prototype.clear = function () {
+    for (var key in this._memoryCache) {
+      delete this._memoryCache[key];
     }
 
-    void persistStorageAsync(_memoryCache);
-  },
-  getAllKeys: function () {
-    return Object.keys(_memoryCache);
-  }
+    this.persist();
+  };
+
+  SemiAsyncStorage.prototype.getAllKeys = function () {
+    return Object.keys(this._memoryCache);
+  };
+
+  return SemiAsyncStorage;
+}();
+
+var version = "2.2.0-alpha1";
+
+var warn = function (name) {
+  console.warn("PostHog: Missing ".concat(name, " optional dependency. Some functions may not work as expected..."));
 };
 
-var _preloadSemiAsyncStoragePromise;
+var _OptionalAsyncStorage = undefined;
 
-var preloadSemiAsyncStorage = function () {
-  if (_preloadSemiAsyncStoragePromise) {
-    return _preloadSemiAsyncStoragePromise;
+try {
+  _OptionalAsyncStorage = require('@react-native-async-storage/async-storage').default;
+} catch (e) {
+  warn('@react-native-async-storage/async-storage');
+}
+
+var OptionalAsyncStorage = _OptionalAsyncStorage;
+
+var _OptionalExpoDevice = undefined;
+
+try {
+  _OptionalExpoDevice = require('expo-device');
+} catch (e) {}
+
+var OptionalExpoDevice = _OptionalExpoDevice;
+
+var _OptionalExpoLocalization = undefined;
+
+try {
+  _OptionalExpoLocalization = require('expo-localization');
+} catch (e) {}
+
+var OptionalExpoLocalization = _OptionalExpoLocalization;
+
+var _OptionalReactNativeDeviceInfo = undefined;
+
+try {
+  _OptionalReactNativeDeviceInfo = require('react-native-device-info');
+} catch (e) {
+  warn('react-native-device-info');
+}
+
+var OptionalReactNativeDeviceInfo = _OptionalReactNativeDeviceInfo;
+
+var getAppProperties = function () {
+  var properties = {};
+
+  if (OptionalExpoApplication) {
+    properties.$app_build = OptionalExpoApplication.nativeBuildVersion;
+    properties.$app_name = OptionalExpoApplication.applicationName;
+    properties.$app_namespace = OptionalExpoApplication.applicationId;
+    properties.$app_version = OptionalExpoApplication.nativeApplicationVersion;
   }
 
-  _preloadSemiAsyncStoragePromise = loadStorageAsync().then(function (res) {
-    for (var key in res) {
-      _memoryCache[key] = _memoryCache[key] === undefined ? res[key] : _memoryCache[key];
-    }
-  });
-  return _preloadSemiAsyncStoragePromise;
+  if (OptionalExpoDevice) {
+    properties.$device_manufacturer = OptionalExpoDevice.manufacturer;
+    properties.$device_name = OptionalExpoDevice.modelName;
+    properties.$os_name = OptionalExpoDevice.osName;
+    properties.$os_version = OptionalExpoDevice.osVersion;
+  }
+
+  if (OptionalExpoLocalization) {
+    properties.$locale = OptionalExpoLocalization.locale;
+    properties.$timezone = OptionalExpoLocalization.timezone;
+  }
+
+  if (OptionalReactNativeDeviceInfo) {
+    properties.$app_build = OptionalReactNativeDeviceInfo.getBuildIdSync();
+    properties.$app_name = OptionalReactNativeDeviceInfo.getApplicationName();
+    properties.$app_namespace = OptionalReactNativeDeviceInfo.getBundleId();
+    properties.$app_version = OptionalReactNativeDeviceInfo.getVersion();
+    properties.$device_manufacturer = OptionalReactNativeDeviceInfo.getManufacturerSync();
+    properties.$device_name = OptionalReactNativeDeviceInfo.getDeviceNameSync();
+    properties.$os_name = OptionalReactNativeDeviceInfo.getSystemName();
+    properties.$os_version = OptionalReactNativeDeviceInfo.getSystemVersion();
+  }
+
+  return properties;
 };
+var buildOptimisiticAsyncStorage = function () {
+  if (OptionalExpoFileSystem) {
+    var filesystem_1 = OptionalExpoFileSystem;
+    return {
+      getItem: function (key) {
+        return __awaiter(this, void 0, void 0, function () {
+          var uri, stringContent;
+          return __generator(this, function (_a) {
+            switch (_a.label) {
+              case 0:
+                uri = (filesystem_1.documentDirectory || '') + key;
+                _a.label = 1;
+
+              case 1:
+                _a.trys.push([1, 3,, 4]);
+
+                return [4
+                /*yield*/
+                , filesystem_1.readAsStringAsync(uri)];
+
+              case 2:
+                stringContent = _a.sent();
+                return [2
+                /*return*/
+                , stringContent];
+
+              case 3:
+                _a.sent();
+                return [2
+                /*return*/
+                , null];
+
+              case 4:
+                return [2
+                /*return*/
+                ];
+            }
+          });
+        });
+      },
+      setItem: function (key, value) {
+        return __awaiter(this, void 0, void 0, function () {
+          var uri;
+          return __generator(this, function (_a) {
+            switch (_a.label) {
+              case 0:
+                uri = (filesystem_1.documentDirectory || '') + key;
+                return [4
+                /*yield*/
+                , filesystem_1.writeAsStringAsync(uri, value)];
+
+              case 1:
+                _a.sent();
+
+                return [2
+                /*return*/
+                ];
+            }
+          });
+        });
+      }
+    };
+  }
 
-var version = "2.1.4";
+  if (OptionalAsyncStorage) {
+    return OptionalAsyncStorage;
+  }
+
+  console.log(OptionalAsyncStorage);
+  throw new Error('PostHog: No storage available. Please install expo-filesystem or react-native-async-storage OR implement a custom storage provider.');
+};
 
 var PostHog =
 /** @class */
@@ -1472,29 +1577,51 @@ function (_super) {
     var _this = _super.call(this, apiKey, options) || this;
 
     _this._memoryStorage = new PostHogMemoryStorage();
+    _this._appProperties = {};
     _this._persistence = options === null || options === void 0 ? void 0 : options.persistence;
+    _this._appProperties = (options === null || options === void 0 ? void 0 : options.customAppProperties) || getAppProperties();
+    _this._semiAsyncStorage = new SemiAsyncStorage((options === null || options === void 0 ? void 0 : options.customAsyncStorage) || buildOptimisiticAsyncStorage());
     reactNative.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 () {
+    void _this._semiAsyncStorage.preloadAsync().then(function () {
       _this.setupBootstrap(options);
 
-      if (!SemiAsyncStorage.getItem(PostHogPersistedProperty.AnonymousId)) {
+      if (!_this._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);
+            _this._semiAsyncStorage.setItem(PostHogPersistedProperty.DistinctId, legacyValues.distinctId);
+
+            _this._semiAsyncStorage.setItem(PostHogPersistedProperty.AnonymousId, legacyValues.anonymousId);
           }
         });
       }
     });
     return _this;
   }
+  /** Await this method to ensure that all state has been loaded from the async provider */
+
 
-  PostHog.initAsync = function () {
-    return preloadSemiAsyncStorage();
+  PostHog.prototype.initAsync = function () {
+    return __awaiter(this, void 0, void 0, function () {
+      return __generator(this, function (_a) {
+        switch (_a.label) {
+          case 0:
+            return [4
+            /*yield*/
+            , this._semiAsyncStorage];
+
+          case 1:
+            _a.sent();
+
+            return [2
+            /*return*/
+            ];
+        }
+      });
+    });
   };
 
   PostHog.prototype.getPersistedProperty = function (key) {
@@ -1502,7 +1629,7 @@ function (_super) {
       return this._memoryStorage.getProperty(key);
     }
 
-    return SemiAsyncStorage.getItem(key) || undefined;
+    return this._semiAsyncStorage.getItem(key) || undefined;
   };
 
   PostHog.prototype.setPersistedProperty = function (key, value) {
@@ -1510,7 +1637,7 @@ function (_super) {
       return this._memoryStorage.setProperty(key, value);
     }
 
-    return value !== null ? SemiAsyncStorage.setItem(key, value) : SemiAsyncStorage.removeItem(key);
+    return value !== null ? this._semiAsyncStorage.setItem(key, value) : this._semiAsyncStorage.removeItem(key);
   };
 
   PostHog.prototype.fetch = function (url, options) {
@@ -1530,20 +1657,10 @@ function (_super) {
   };
 
   PostHog.prototype.getCommonEventProperties = function () {
-    return __assign(__assign({}, _super.prototype.getCommonEventProperties.call(this)), {
-      $app_build: '1',
-      $app_name: ExpoApplication__namespace.applicationName,
-      $app_namespace: ExpoApplication__namespace.applicationId,
-      $app_version: ExpoApplication__namespace.nativeApplicationVersion,
-      $device_manufacturer: ExpoDevice__namespace.manufacturer,
-      $device_name: ExpoDevice__namespace.modelName,
+    return __assign(__assign(__assign({}, _super.prototype.getCommonEventProperties.call(this)), this._appProperties), {
       $device_type: reactNative.Platform.OS,
-      $locale: ExpoLocalization__namespace.locale,
-      $os_name: ExpoDevice__namespace.osName,
-      $os_version: ExpoDevice__namespace.osVersion,
       $screen_height: reactNative.Dimensions.get('screen').height,
-      $screen_width: reactNative.Dimensions.get('screen').width,
-      $timezone: ExpoLocalization__namespace.timezone
+      $screen_width: reactNative.Dimensions.get('screen').width
     });
   }; // Custom methods
 
@@ -1556,9 +1673,6 @@ function (_super) {
 
   return PostHog;
 }(PostHogCore);
-// is used
-
-void PostHog.initAsync();
 
 var PostHogContext = /*#__PURE__*/React__default["default"].createContext({
   client: undefined
@@ -1603,10 +1717,6 @@ function useLifecycleTracker(client) {
 
 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) {