hypertrack-sdk-react-native 8.2.2 → 9.0.0

package/CHANGELOG.md

@@ -1,9 +1,31 @@
 # Changelog
-All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [9.0.0] - 2023-02-17
+
+### Changed
+- Updated HyperTrack iOS SDK to 4.14.0
+- Updated HyperTrack Android SDK to 6.4.0
+- `createInstance()` renamed to `initialize()`
+- `getDeviceID()` renamed to `getDeviceId()`
+- `syncDeviceSettings()` renamed to `sync()`
+- `setDeviceName()` renamed to `setName()`
+- `subscribeToErrors()` callback now has param type (`HyperTrackError`)
+- `LocationError` now has different structure
+
+### Added
+- `initialize()` configuration params for
+  - Debug logging
+  - Background location permissions request for Android
+  - Mock locations
+- `subscribeToAvailability()`
+
+### Removed
+- `enableDebugLogging()` (use `initialize()` param `loggingEnabled` istead)
+- `setTripMarker()` (use `addGeotag` instead)
+
 ## [8.2.2] - 2022-10-10
 ### Fixed
 - Deployment target for iOS changed to 11, to comply with native iOS SDK.

package/CONTRIBUTING.md

@@ -1,6 +1,37 @@
 # Contributing
 
-We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
+## FAQ
+
+### How to update the HyperTrack SDK version and make a release?
+
+1. Update SDK version constant
+   - android
+     - android/gradle.properties - HyperTrackSdk_HyperTrackSDKVersion
+   - ios
+     - hypertrack-sdk-react-native.podspec
+       - s.dependency 'HyperTrack/Objective-C', '**version**'
+
+2. Increment wrapper version
+   
+   - package.json
+     - version
+  
+3. Update CHANGELOG.md
+4. Update badge in README.md
+5. Commit
+5. Create a version tag
+6. Push branch and tags
+7. Create a Github repo release
+   - Release title should be the current version tag
+8. `yarn release`
+   - will generate docs
+9. `yarn npm publish`
+
+### How to change build config
+
+#### Android
+
+Change Android build config in `android/gradle.properties`
 
 ## Development workflow
 
@@ -25,37 +56,12 @@ To fix formatting errors, run the following:
 yarn lint --fix
 ```
 
-Remember to add tests for your change if possible. Run the unit tests by:
-
-```sh
-yarn test
-```
-
 ### Linting and tests
 
 [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
 
 We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
 
-### Publishing to npm
-
-We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
-
-To publish new versions, run the following:
-
-```sh
-yarn release
-```
-
-### Scripts
-
-The `package.json` file contains various scripts for common tasks:
-
-- `yarn bootstrap`: setup project by installing all dependencies.
-- `yarn typescript`: type-check files with TypeScript.
-- `yarn lint`: lint files with ESLint.
-- `yarn test`: run unit tests with Jest.
-
 ### Sending a pull request
 
 > **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
@@ -68,87 +74,3 @@ When you're sending a pull request:
 - Follow the pull request template when opening a pull request.
 - For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
 
-## Code of Conduct
-
-### Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-### Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-### Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-### Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-### Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-### Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-#### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-#### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-#### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-#### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-### Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

package/{LICENSE → LICENSE.md}

@@ -1,3 +1,5 @@
+# License
+
 MIT License
 
 Copyright (c) 2019 HyperTrack

package/README.md

@@ -1,59 +1,39 @@
 # React Native HyperTrack SDK
 
-![GitHub](https://img.shields.io/github/license/hypertrack/sdk-react-native.svg) ![npm](https://img.shields.io/npm/v/hypertrack-sdk-react-native.svg) ![iOS SDK](https://img.shields.io/badge/iOS%20SDK-4.13.0-brightgreen.svg) ![Android SDK](https://img.shields.io/badge/Android%20SDK-6.3.0-brightgreen.svg)
+![GitHub](https://img.shields.io/github/license/hypertrack/sdk-react-native.svg) 
+![npm](https://img.shields.io/npm/v/hypertrack-sdk-react-native.svg) 
+![iOS SDK](https://img.shields.io/badge/iOS%20SDK-4.14.0-brightgreen.svg) 
+![Android SDK](https://img.shields.io/badge/Android%20SDK-6.4.0-brightgreen.svg)
 
 [HyperTrack](https://www.hypertrack.com) lets you add live location tracking to your mobile app. Live location is made available along with ongoing activity, tracking controls and tracking outage with reasons.
 
-React Native HyperTrack SDK is a wrapper around native iOS and Android SDKs that allows to integrate them into React Native apps.
+React Native HyperTrack SDK is a wrapper around native iOS and Android SDKs that allows to integrate HyperTrack into React Native apps.
 
-## Installation
-
-For information about how to get started with React Native SDK, please visit this [HyperTrack Guide](https://www.hypertrack.com/docs/install-sdk-react-native).
-
-## Documentation
-
-[https://hypertrack.github.io/sdk-react-native/](https://hypertrack.github.io/sdk-react-native/)
+For information about how to get started with React Native HyperTrack SDK, please check this [Guide](https://www.hypertrack.com/docs/install-sdk-react-native).
 
-## FAQ
-
-link to FAQ
-
-## Support
+## Installation
 
-Join our [Slack community](https://join.slack.com/t/hypertracksupport/shared_invite/enQtNDA0MDYxMzY1MDMxLTdmNDQ1ZDA1MTQxOTU2NTgwZTNiMzUyZDk0OThlMmJkNmE0ZGI2NGY2ZGRhYjY0Yzc0NTJlZWY2ZmE5ZTA2NjI) for instant responses. You can also email us at help@hypertrack.com.
+[Install from NPM](https://www.npmjs.com/package/hypertrack-sdk-react-native)
 
-#### How to update the HyperTrack SDK version?
+## Sample code
 
-1. Update SDK constant
+[Quickstart React Native app](https://github.com/hypertrack/quickstart-react-native)
 
-   - android
-     - android/gradle.properties - HyperTrackSdk_HyperTrackSDKVersion
-   - ios
-     - hypertrack-sdk-react-native.podspec
-       - s.dependency 'HyperTrack/Objective-C', '**version**'
+## Wrapper API Documentation
 
-2. Increment wrapper version
-   - package.json
-     - version
-3. Update changelog
-4. Update badge in README.md
-5. Create a version tag
-6. Commit and push
-7. Create a release
-   - Release title should be the current version tag
-8. npm publish
+[Wrapper API Documentation](https://hypertrack.github.io/sdk-react-native/)
 
-### How to change build config
+## Requirements
 
-Change Android build config in `android/gradle.properties`
+### Android
 
-### Old React Native versions specifics:
+- Gradle version 6.7.1+
+- compileSdkVersion 31+
 
-#### Android
+### iOS
 
-- Gradle version should be 6.7.1 or higher
-- compileSdkVersion should be 31 or higher
+- iOS version 12.4+
 
-#### iOS
+## Contributing
 
-- Platform version should be 12.4 or higher
+If you want to contribute check [CONTRIBUTING.md](CONTRIBUTING.md)

package/android/build.gradle

@@ -1,141 +1,141 @@
 buildscript {
-  // Buildscript is evaluated before everything else so we can't use getExtOrDefault
-  def kotlin_version = rootProject.ext.has('kotlinVersion') ? rootProject.ext.get('kotlinVersion') : project.properties['HyperTrackSdk_kotlinVersion']
-
-  repositories {
-      google()
-      mavenCentral()
-  }
-
-  dependencies {
-    classpath 'com.android.tools.build:gradle:7.1.2'
-    // noinspection DifferentKotlinGradleVersion
-    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-  }
+    // Buildscript is evaluated before everything else so we can't use getExtOrDefault
+    def kotlin_version = rootProject.ext.has('kotlinVersion') ? rootProject.ext.get('kotlinVersion') : project.properties['HyperTrackSdk_kotlinVersion']
+
+    repositories {
+        google()
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath 'com.android.tools.build:gradle:7.1.2'
+        // noinspection DifferentKotlinGradleVersion
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
 }
 
 def isNewArchitectureEnabled() {
-  return rootProject.hasProperty("newArchEnabled") &&  rootProject.getProperty("newArchEnabled") == "true"
+    return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
 }
 
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
 if (isNewArchitectureEnabled()) {
-  apply plugin: 'com.facebook.react'
+    apply plugin: 'com.facebook.react'
 }
 
 def getExtOrDefault(name) {
-  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['HyperTrackSdk_' + name]
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['HyperTrackSdk_' + name]
 }
 
 def getExtOrIntegerDefault(name) {
-  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties['HyperTrackSdk_' + name]).toInteger()
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties['HyperTrackSdk_' + name]).toInteger()
 }
 
 android {
-  compileSdkVersion getExtOrIntegerDefault('compileSdkVersion')
-
-  defaultConfig {
-    minSdkVersion getExtOrIntegerDefault('minSdkVersion')
-    targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
-    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
-  }
-  buildTypes {
-    release {
-      minifyEnabled false
+    compileSdkVersion getExtOrIntegerDefault('compileSdkVersion')
+
+    defaultConfig {
+        minSdkVersion getExtOrIntegerDefault('minSdkVersion')
+        targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
+        buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
     }
-  }
-
-  lintOptions {
-    disable 'GradleCompatible'
-  }
-
-  compileOptions {
-    sourceCompatibility JavaVersion.VERSION_1_8
-    targetCompatibility JavaVersion.VERSION_1_8
-  }
-
-  packagingOptions {
-      pickFirst 'lib/x86/libc++_shared.so'
-      pickFirst 'lib/x86_64/libc++_shared.so'
-      pickFirst 'lib/armeabi-v7a/libc++_shared.so'
-      pickFirst 'lib/arm64-v8a/libc++_shared.so'
-  }
-}
 
-repositories {
-  mavenCentral()
-  google()
-  maven {
-        name 'hypertrack'
-        url 'https://s3-us-west-2.amazonaws.com/m2.hypertrack.com/'
+    lintOptions {
+        disable 'GradleCompatible'
     }
 
-  def found = false
-  def defaultDir = null
-  def androidSourcesName = 'React Native sources'
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
 
-  if (rootProject.ext.has('reactNativeAndroidRoot')) {
-    defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
-  } else {
-    defaultDir = new File(
-      projectDir,
-      '/../../../node_modules/react-native/android'
-    )
-  }
+    packagingOptions {
+        pickFirst 'lib/x86/libc++_shared.so'
+        pickFirst 'lib/x86_64/libc++_shared.so'
+        pickFirst 'lib/armeabi-v7a/libc++_shared.so'
+        pickFirst 'lib/arm64-v8a/libc++_shared.so'
+    }
+}
 
-  if (defaultDir.exists()) {
+repositories {
+    mavenCentral()
+    google()
     maven {
-      url defaultDir.toString()
-      name androidSourcesName
+        name 'hypertrack'
+        url 'https://s3-us-west-2.amazonaws.com/m2.hypertrack.com/'
     }
 
-    logger.info(":${project.name}:reactNativeAndroidRoot ${defaultDir.canonicalPath}")
-    found = true
-  } else {
-    def parentDir = rootProject.projectDir
-
-    1.upto(5, {
-      if (found) return true
-      parentDir = parentDir.parentFile
-
-      def androidSourcesDir = new File(
-        parentDir,
-        'node_modules/react-native'
-      )
-
-      def androidPrebuiltBinaryDir = new File(
-        parentDir,
-        'node_modules/react-native/android'
-      )
+    def found = false
+    def defaultDir = null
+    def androidSourcesName = 'React Native sources'
+
+    if (rootProject.ext.has('reactNativeAndroidRoot')) {
+        defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
+    } else {
+        defaultDir = new File(
+                projectDir,
+                '/../../../node_modules/react-native/android'
+        )
+    }
 
-      if (androidPrebuiltBinaryDir.exists()) {
+    if (defaultDir.exists()) {
         maven {
-          url androidPrebuiltBinaryDir.toString()
-          name androidSourcesName
+            url defaultDir.toString()
+            name androidSourcesName
         }
 
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidPrebuiltBinaryDir.canonicalPath}")
+        logger.info(":${project.name}:reactNativeAndroidRoot ${defaultDir.canonicalPath}")
         found = true
-      } else if (androidSourcesDir.exists()) {
-        maven {
-          url androidSourcesDir.toString()
-          name androidSourcesName
-        }
+    } else {
+        def parentDir = rootProject.projectDir
+
+        1.upto(5, {
+            if (found) return true
+            parentDir = parentDir.parentFile
+
+            def androidSourcesDir = new File(
+                    parentDir,
+                    'node_modules/react-native'
+            )
+
+            def androidPrebuiltBinaryDir = new File(
+                    parentDir,
+                    'node_modules/react-native/android'
+            )
+
+            if (androidPrebuiltBinaryDir.exists()) {
+                maven {
+                    url androidPrebuiltBinaryDir.toString()
+                    name androidSourcesName
+                }
+
+                logger.info(":${project.name}:reactNativeAndroidRoot ${androidPrebuiltBinaryDir.canonicalPath}")
+                found = true
+            } else if (androidSourcesDir.exists()) {
+                maven {
+                    url androidSourcesDir.toString()
+                    name androidSourcesName
+                }
+
+                logger.info(":${project.name}:reactNativeAndroidRoot ${androidSourcesDir.canonicalPath}")
+                found = true
+            }
+        })
+    }
 
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidSourcesDir.canonicalPath}")
-        found = true
-      }
-    })
-  }
-
-  if (!found) {
-    throw new GradleException(
-      "${project.name}: unable to locate React Native android sources. " +
-      "Ensure you have you installed React Native as a dependency in your project and try again."
-    )
-  }
+    if (!found) {
+        throw new GradleException(
+                "${project.name}: unable to locate React Native android sources. " +
+                        "Ensure you have you installed React Native as a dependency in your project and try again."
+        )
+    }
 }
 
 def kotlin_version = getExtOrDefault('kotlinVersion')
@@ -143,16 +143,15 @@ def hyperTrackSdk_version = getExtOrDefault('HyperTrackSDKVersion')
 
 dependencies {
     //noinspection GradleDynamicVersion
-  implementation "com.facebook.react:react-native:+"
-  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation "com.hypertrack:hypertrack:$hyperTrackSdk_version"
-// From node_modules
+    implementation "com.facebook.react:react-native:+"
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+    implementation "com.hypertrack:hypertrack:$hyperTrackSdk_version"
 }
 
 if (isNewArchitectureEnabled()) {
-  react {
-    jsRootDir = file("../src/")
-    libraryName = "HyperTrackSdk"
-    codegenJavaPackageName = "com.reactnativehypertracksdk"
-  }
+    react {
+        jsRootDir = file("../src/")
+        libraryName = "HyperTrackSdk"
+        codegenJavaPackageName = "com.reactnativehypertracksdk"
+    }
 }

package/android/gradle.properties

@@ -2,5 +2,5 @@ HyperTrackSdk_kotlinVersion=1.7.0
 HyperTrackSdk_minSdkVersion=23
 HyperTrackSdk_targetSdkVersion=30
 HyperTrackSdk_compileSdkVersion=31
-HyperTrackSdk_HyperTrackSDKVersion=6.3.0
+HyperTrackSdk_HyperTrackSDKVersion=6.4.0
 android.useAndroidX=true