@snowplow/react-native-tracker 1.3.0 → 2.0.0

package/.npmignore

@@ -0,0 +1,60 @@
+# Demo app
+#
+example/
+
+# Local testing workflow
+#
+.scripts/
+tmp/
+
+# OSX
+#
+.DS_Store
+
+# node.js
+#
+node_modules/
+npm-debug.log
+yarn-error.log
+
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+*.xcworkspace/
+
+# CocoaPods
+/ios/Pods/
+
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+android/.project
+android/.settings/org.eclipse.buildship.core.prefs
+example/android/.settings/org.eclipse.buildship.core.prefs
+example/android/.project
+
+# BUCK
+buck-out/
+\.buckd/
+*.keystore

package/.nvmrc

@@ -0,0 +1 @@
+v18

package/.watchmanconfig

@@ -0,0 +1 @@
+{}

package/.yarnrc

@@ -0,0 +1,3 @@
+# Override Yarn command so we can automatically setup the repo on running `yarn`
+
+yarn-path "scripts/bootstrap.js"

package/CHANGELOG

@@ -0,0 +1,166 @@
+Version 2.0.0 (2023-09-29)
+--------------------------
+Upgrade project structure and update native trackers to version 5 (#199)
+Disable automatic screen view tracking in the iOS and Android tracker by default (#198)
+Fix buffer option in emitter configuration on Android to set correct value for large setting (#197)
+
+Version 1.4.0 (2022-02-04)
+--------------------------
+Add JavaScript tracker core to be used in Expo managed workflow when native trackers are not available (#188)
+Bump Snowplow native tracker dependency to 4.1 (#186)
+Update year in copyright headers to 2023 (#187)
+
+Version 1.3.0 (2022-10-03)
+--------------------------
+Upgrade Snowplow mobile trackers to v4 (#167)
+Add anonymous tracking features (#168)
+Add interface to subscribe for events tracked in Web views (#169)
+Add option to add custom headers (#165)
+Enable setting custom path for POST requests (#178)
+Upgrade internal and demo app dependencies (#172)
+Remove circular imports of demo app dependencies when running in demo apps (#174)
+
+Version 1.2.1 (2022-04-12)
+--------------------------
+Fix import of non-published NSDictionary helpers from SnowplowTracker on iOS (#161)
+
+Version 1.2.0 (2022-03-25)
+--------------------------
+Add support for React Native for tvOS (#154)
+Bump min RN version supported to v0.65+ (#153)
+Add generic type for SelfDescribing event data (#156)
+
+Version 1.1.0 (2022-02-07)
+--------------------------
+Update mobile tracker dependencies to v3 (#141)
+Add deep link and message notification events (#142)
+Update demo app to show accessing tracker instance from platform native code (#136)
+Fix compilation error for iOS build on ARM macs (#140)
+Fix check for byteLimitGet when reading emitter configuration (#138)
+Fix check for Android version in GitHub Actions (#134) 
+Update year in all copyright notices (#148) 
+Update dependencies (#150) 
+
+Version 1.0.0 (2021-08-09)
+--------------------------
+Fix action-gh-release to specific commit (#133)
+Update devDependencies (#132)
+Publish sourcemaps (#131)
+Lint DemoApp separately (#130)
+Get Session Context Data (#53)
+Update version in podspec (#110)
+Set amended v_tracker indicating react-native (#18)
+Add global contexts (#104)
+Upgrade iOS Tracker and Android Tracker to v2 (#113)
+Add test suite (#60)
+
+Version 0.2.0 (2021-06-21)
+--------------------------
+Bump dependencies in DemoApp (#114)
+Port to TypeScript (#115)
+Handle asyncronous issues internally (#78)
+Use ESLint (#126)
+Add homepage and repository in package.json (#125)
+Remove unused files (#124)
+
+Version 0.1.7 (2021-05-24)
+--------------------------
+Remove waitForEventStore method and upgrade Android tracker (#92)
+Automate deploy process (#61)
+Fix null transitionType resulting in screen view event failing validation for ios (#122)
+Fix Xcode 12.5 build breaks (#119)
+Fix typo in CHANGELOG (#116)
+Remove JCenter and add MavenCentral (#121)
+Update build.gradle to match rootProject extra properties (#120)
+Fix assembleAndroidTest builds (#118)
+
+Version 0.1.6 (2021-04-06)
+--------------------------
+Bump iOS Tracker to 1.7.0 (#111)
+
+Version 0.1.5 (2021-03-22)
+--------------------------
+Update DemoApp versions (#106)
+Loosen peer dependency requirements (#105)
+
+Note: v0.1.4 was skipped due to an error in publishing process.
+---------------------------------------------------------------
+
+Version 0.1.3 (2021-02-12)
+--------------------------
+Fix Xcode 12 compatibility (#102)
+
+Version 0.1.2 (2021-01-15)
+--------------------------
+Upgrade obj-c tracker to 1.6.2 (#98)
+
+Version 0.1.1 (2020-09-03)
+--------------------------
+Fix Android tracker version to 1.5.x (#91)
+
+Version 0.1.0 (2020-07-10)
+--------------------------
+Add issue templates (#89)
+Add CONTRIBUTING.md (#80)
+Use recommended config as defaults (#86)
+Fix iOS null comparison warnings (#85)
+Return after promise rejection on Android (#84)
+Update arguments and var names for consistency (#83)
+Update DemoApp (#82)
+Use fast fail on iOS (#87)
+Update README (#77)
+Dynamically use latest minor version of native tracker (#19)
+Cleanup code formatting (#75)
+Add Snyk Github Action (#71)
+Add license (#62)
+Handle setSubjectData values appropriately (#70)
+Return promise on intialize() (#66)
+Remove deprecated options (#69)
+Expand testing scripts (#72)
+Refactor method instrumentation (#58)
+Fix compile warnings caused by unsafe comparison (#73)
+Fix double self calls (#74)
+Remove screen_id workaround (#57)
+
+Version 0.1.0-alpha.17 (2020-05-04)
+-----------------------------------
+Use yarn everywhere for testing (#55)
+Update ios tracker version to 1.3.0 (#54)
+
+Version 0.1.0-alpha.16 (2020-04-16)
+-----------------------------------
+Update .npmignore and .gitignore (#51)
+Update README (#50)
+Update Demo App (#48)
+Add trackPageView (#33)
+Add script for clean build (#47)
+Add setSubjectData method (#46)
+Update android tracker version (#45)
+Add Standard Settings (#34)
+
+Version 0.1.0-alpha.15 (2020-02-06)
+-----------------------------------
+Cleanup Repo (#29)
+Update DemoApp (#21)
+Update ios Tracker dependency to remove mandatory dynamic build (#22)
+
+Version 0.1.0-alpha.14 (2019-10-22)
+----------------------------------
+Update iOS to incorporate patch release (#23)
+
+Version 0.1.0-alpha.13 (2019-10-14)
+-----------------------------------
+Make optional StructEvent parameters nullable for iOS (#12)
+Add ScreenViews (#14)
+Fix bug in android getContexts (#16)
+Add mobile context (#13)
+Update README.md (#5)
+Fix path in Android package export (#8)
+Fix high severity vulnerabilities in DemoApp (#7)
+Bump DemoApp react-native version (#6)
+Fix import in Demo Application (#3)
+Fix Android Numeric type bug (#4)
+
+Version 0.1.0-alpha.9 (2019-08-08)
+----------------------------------
+Initial Release

package/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing
+
+The Snowplow React Native Tracker is maintained by the Engineering team at Snowplow Analytics. We welcome suggestions for improvements and bug fixes to all Snowplow Trackers.  
+
+We are extremely grateful for all contributions we receive, whether that is reporting an issue or a change to the code which can be made in the form of a pull request.
+
+For support requests, please use our community support Discourse forum: https://discourse.snowplowanalytics.com/.
+
+## Setting up an Environment
+
+Instructions on how to build and run tests are available in the [README.md](README.md). The README will also list any requirements that you will need to install first before being able to build and run the tests.
+
+You should ensure you are comfortable building and testing the existing release before adding new functionality or fixing issues.
+
+## Issues
+
+### Creating an issue
+
+The project contains an issue template which should help guiding you through the process. However, please keep in mind that support requests should go to our Discourse forum: https://discourse.snowplowanalytics.com/ and not GitHub issues.
+
+It's also a good idea to log an issue before starting to work on a pull request to discuss it with the maintainers. A pull request is just one solution to a problem and it is often a good idea to talk about the problem with the maintainers first.
+
+### Working on an issue
+
+If you see an issue you would like to work on, please let us know in the issue! That will help us in terms of scheduling and
+not doubling the amount of work.
+
+If you don't know where to start contributing, you can look at
+[the issues labeled `good first issue`](https://github.com/snowplow-incubator/snowplow-react-native-tracker/labels/good%20first%20issue).
+
+## Pull requests
+
+These are a few guidelines to keep in mind when opening pull requests.
+
+### Guidelines
+
+Please supply a good PR description. These are very helpful and help the maintainers to understand _why_ the change has been made, not just _what_ changes have been made.  
+
+Please try and keep your PR to a single feature of fix. This might mean breaking up a feature into multiple PRs but this makes it easier for the maintainers to review and also reduces the risk in each change.
+
+Please review your own PR as you would do it you were a reviewer first. This is a great way to spot any mistakes you made when writing the change. Additionally, ensure your code compiles and all tests pass.
+
+### Commit hygiene
+
+We keep a strict 1-to-1 correspondance between commits and issues, as such our commit messages are formatted in the following
+fashion:
+
+`Issue Description (closes #1234)`
+
+for example:
+
+`Fix Issue with Tracker (closes #1234)`
+
+### Writing tests
+
+Whenever necessary, it's good practice to add the corresponding tests to whichever feature you are working on.  
+Any non-trivial PR must have tests and will not be accepted without them.
+
+### Feedback cycle
+
+Reviews should happen fairly quickly during weekdays.  
+If you feel your pull request has been forgotten, please ping one or more maintainers in the pull request.
+
+### Getting your pull request merged
+
+If your pull request is fairly chunky, there might be a non-trivial delay between the moment the pull request is approved and the moment it gets merged. This is because your pull request will have been scheduled for a specific milestone which might or might not be actively worked on by a maintainer at the moment.
+
+### Contributor license agreement
+
+We require outside contributors to sign a Contributor license agreement (or CLA) before we can merge their pull requests.  
+You can find more information on the topic in [the dedicated wiki page](https://github.com/snowplow/snowplow/wiki/CLA).  
+The @snowplowcla bot will guide you through the process.
+
+## Getting in touch
+
+### Community support requests
+
+Please do not log an issue if you are asking for support, all of our community support requests go through our Discourse forum: https://discourse.snowplowanalytics.com/.
+
+Posting your problem there ensures more people will see it and you should get support faster than creating a new issue on GitHub. Please do create a new issue on GitHub if you think you've found a bug though!

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (c) 2020-2022 Snowplow Analytics Ltd, 2019 DataCamp.
+   Copyright (c) 2020-2023 Snowplow Analytics Ltd, 2019 DataCamp.
    All rights reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");

package/README.md

@@ -1,4 +1,3 @@
-
 # @snowplow/react-native-tracker
 
 [![actively-maintained]][tracker-classification]
@@ -9,28 +8,31 @@
 [![RN version][react-native-v-image]][react-native-v]
 [![downloads][downloads-dm-image]][downloads-dm]
 
-
 Snowplow is a scalable open-source platform for rich, high quality, low-latency data collection. It is designed to collect high quality, complete behavioral data for enterprise business.
 
 **To find out more, please check out the [Snowplow website][website] and our [documentation][docs].**
 
-
 ## Snowplow React-Native Tracker Overview
 
 The Snowplow React Native Tracker allows you to add analytics to your React Native apps when using a [Snowplow][snowplow] pipeline.
 
 With this library you can collect granular event-level data as your users interact with your React Native applications. It is build on top of Snowplow's [Mobile Native][native-trackers] [iOS][objc-tracker] and [Android][android-tracker] Trackers, in order to support the full range of out-of-the-box Snowplow events and tracking capabilities.
 
-
 ## Quick start
 
 From the root of your [React Native][react-native] project:
 
-```
+```sh
 npm install --save @snowplow/react-native-tracker
 npx pod-install
 ```
 
+In your `ios/Podfile` file (unless using Expo Go), please add the `FMDB` dependency with `modular_headers` set to `true`. This is necessary to make the `FMDB` package generate module maps so that it can be used by the tracker:
+
+```rb
+pod 'FMDB', :modular_headers => true
+```
+
 Then, instrument the tracker in your app and start tracking events. For example:
 
 ```javascript
@@ -48,7 +50,6 @@ The Snowplow React Native Tracker also provides first-class support for TypeScri
 
 See also our [DemoApp][demoapp] for an example implementation.
 
-
 ## Find out more
 
 | Technical Docs                    | Setup Guide                 |
@@ -56,135 +57,50 @@ See also our [DemoApp][demoapp] for an example implementation.
 | [![i1][techdocs-image]][techdocs] | [![i2][setup-image]][setup] |
 | [Technical Docs][techdocs]        | [Setup Guide][setup]        |
 
-
-
 ## Maintainer quick start
 
-### Launching the DemoApp
-
 Assuming a [react-native environment][react-native-environment] is set up, from the root of the repository:
 
 ```bash
-npm install
-npm run bootstrap
-cd DemoApp
-```
-
-Replace "placeholder" with the URI for your Snowplow Mini or other Snowplow collector in `DemoApp/App.js`.
-
-**For Android:**
-
-```bash
-yarn android
-```
-_Note_: Linux users who want to run the DemoApp for Android, would also need to run `yarn start` in a separate terminal.
-
-**For iOS:**
-
-```bash
-yarn pods && yarn ios
+yarn
 ```
 
-During development, to quickly test changes, the `.scripts/quickTest.sh` bash script can be used.
+### Unit tests
 
-```bash
-# android
-bash .scripts/quickTest.sh android
-# ios
-bash .scripts/quickTest.sh ios
-# both
-bash .scripts/quickTest.sh both
-```
+To run the unit tests, simply execute:
 
-Similarly, the `.scripts/cleanBuildAndRun.sh` script offers a naive way to clean-rebuild the entire project with your changes.
-
-```bash
-# android
-bash .scripts/cleanBuildAndRun.sh android
-# ios
-bash .scripts/cleanBuildAndRun.sh ios
-# both
-bash .scripts/cleanBuildAndRun.sh both
+```sh
+yarn test
 ```
 
-### Launching the Demo App for Apple TV and Android TV
-
-Assuming a [react-native environment][react-native-environment] is set up, from the root of the repository:
-
-```bash
-npm install
-npm run bootstrap
-cd DemoAppTV
-yarn
-```
+### Launching the example app
 
-Replace "placeholder" with the URI for your Snowplow Mini or other Snowplow collector in `DemoAppTV/App.js`.
+Replace "placeholder" with the URI for your Snowplow Mini or other Snowplow collector in `DemoApp/App.js`.
 
-**For Android TV:**
+**For Android:**
 
 ```bash
-yarn android
+yarn example android
 ```
-
 _Note_: Linux users who want to run the DemoApp for Android, would also need to run `yarn start` in a separate terminal.
 
-**For tvOS:**
+**For iOS:**
 
 ```bash
-yarn pods && yarn tvos
+yarn example ios
 ```
 
-Note: If you are using simulator with a name different than "Apple TV", you will need to update the `--simulator` parameter in the "tvos" script call in `DemoAppTV/package.json`.
-
 ### End-to-end tests
 
 Snowplow React-Native Tracker is being end-to-end tested using [Snowplow Micro][snowplow-micro] and [Detox][detox]. To run these tests locally:
 
-#### Prerequisites
-
-1. **Docker**: Used to launch Snowplow Micro and expose its collector endpoint on `http://0.0.0.0:9090`.
-2. **Perl**: Used to substitute the endpoint placeholders in `DemoApp/App.js` with Micro's endpoint for respective emulator/simulator.
-3. **Detox** platform-specific development environment setup:
-    - [For Android][detox-android-env]. Namely:
-      - Java 8
-      - Android SDK
-      - Android Open-Source Project emulator
-    - [For iOS][detox-ios-env]. Namely:
-      - applesimutils
-
 #### Testing
 
-Once the prerequisites are in place:
-
-```
-npm install
-npm run bootstrap
-cd DemoApp
-```
-
- - **e2e-android**
-```
-yarn e2e:android:micro
-```
-
- - **e2e-ios**
-```
-yarn e2e:ios:micro
-```
-
-The above commands will take care to kill Micro's running container before exiting. If you'd prefer to keep Micro running in order to inspect the tracked events through Micro's REST API, you can alternatively control Micro through:
-
-```
-yarn micro:run
-yarn micro:stop
-```
-and run the e2e-tests on their own:
-```
-yarn e2e:android
-# or
-yarn e2e:ios
-```
-
+1. Start your [Snowplow Micro][snowplow-micro] instance locally.
+2. Replace the `placeholder` value for the `collectorEndpoint` variable in `example/src/App.js` (use the network IP address of your computer or ngrok).
+3. Start the end-to-end tests:
+   * On Android, run `yarn e2e:android`
+   * On iOS, run `yarn e2e:ios`
 
 ## Contributing
 
@@ -195,11 +111,9 @@ Feedback and contributions are welcome - if you have identified a bug, please lo
 | [![i3][contributing-image]][contributing] |
 | [Contributing][contributing]              |
 
-
-
 ## Copyright and license
 
-The Snowplow React Native Tracker is copyright 2020-2022 Snowplow Analytics Ltd, 2019 DataCamp.
+The Snowplow React Native Tracker is copyright 2020-2023 Snowplow Analytics Ltd, 2019 DataCamp.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.
@@ -210,7 +124,6 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
-
 [tracker-classification]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/
 [actively-maintained]: https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Actively%20Maintained&color=6638b8&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC
 [gh-actions]: https://github.com/snowplow-incubator/snowplow-react-native-tracker/actions