hypertrack-sdk-react-native 10.0.3 → 11.0.0

package/src/HyperTrack/data_types/HyperTrackError.ts

@@ -1,22 +1,77 @@
 // enum naming convention is ignored to make datatype sync
 // across platforms easier
 export enum HyperTrackError {
-  gpsSignalLost = "gpsSignalLost",
-  locationMocked = "locationMocked",
-  locationPermissionsDenied = "locationPermissionsDenied",
-  locationPermissionsInsufficientForBackground = "locationPermissionsInsufficientForBackground",
-  locationPermissionsNotDetermined = "locationPermissionsNotDetermined",
-  locationPermissionsReducedAccuracy = "locationPermissionsReducedAccuracy",
-  locationPermissionsProvisional = "locationPermissionsProvisional",
-  locationPermissionsRestricted = "locationPermissionsRestricted",
-  locationServicesDisabled = "locationServicesDisabled",
-  locationServicesUnavailable = "locationServicesUnavailable",
-  motionActivityPermissionsNotDetermined = "motionActivityPermissionsNotDetermined",
-  motionActivityPermissionsDenied = "motionActivityPermissionsDenied",
-  motionActivityServicesDisabled = "motionActivityServicesDisabled",
-  motionActivityServicesUnavailable = "motionActivityServicesUnavailable",
-  motionActivityPermissionsRestricted = "motionActivityPermissionsRestricted",
-  networkConnectionUnavailable = "networkConnectionUnavailable",
-  invalidPublishableKey = "invalidPublishableKey",
-  blockedFromRunning = "blockedFromRunning"
+  /**
+   * The SDK was remotely blocked from running.
+   */
+  blockedFromRunning = 'blockedFromRunning',
+
+  /**
+   * The publishable key is invalid.
+   */
+  invalidPublishableKey = 'invalidPublishableKey',
+
+  /**
+   * The user enabled mock location app while mocking locations is prohibited.
+   */
+  locationMocked = 'location.mocked',
+
+  /**
+   * The user disabled location services systemwide.
+   */
+  locationServicesDisabled = 'location.servicesDisabled',
+
+  /**
+   * [Android only] The device doesn't have location services.
+   */
+  locationServicesUnavailable = 'location.servicesUnavailable',
+
+  /**
+   * GPS satellites are not in view.
+   */
+  locationSignalLost = 'location.signalLost',
+
+  /**
+   * [Android only] The SDK wasn't able to start tracking because of the limitations imposed by the OS.
+   * The exempt from background execution conditions weren't met.
+   * {@link https://developer.android.com/guide/components/foreground-services#background-start-restriction-exemptions}
+   */
+  noExemptionFromBackgroundStartRestrictions = 'noExemptionFromBackgroundStartRestrictions',
+
+  /**
+   * The user denied location permissions.
+   */
+  permissionsLocationDenied = 'permissions.location.denied',
+
+  /**
+   * Can’t start tracking in background with When In Use location permissions.
+   * SDK will automatically start tracking when app will return to foreground.
+   */
+  permissionsLocationInsufficientForBackground = 'permissions.location.insufficientForBackground',
+
+  /**
+   * [iOS only] The user has not chosen whether the app can use location services.
+   */
+  permissionsLocationNotDetermined = 'permissions.location.notDetermined',
+
+  /**
+   * [iOS only] The app is in Provisional Always authorization state, which stops sending locations when app is in background.
+   */
+  permissionsLocationProvisional = 'permissions.location.provisional',
+
+  /**
+   * The user didn't grant precise location permissions or downgraded permissions to imprecise.
+   */
+  permissionsLocationReducedAccuracy = 'permissions.location.reducedAccuracy',
+
+  /**
+   * [iOS only] The app is not authorized to use location services.
+   */
+  permissionsLocationRestricted = 'permissions.location.restricted',
+
+  /**
+   * [Android only] The user denied notification permissions needed to display a persistent notification
+   * needed for foreground location tracking.
+   */
+  permissionsNotificationsDenied = 'permissions.notifications.denied',
 }

package/src/HyperTrack/data_types/internal/HyperTrackErrorInternal.ts

@@ -1,4 +1,4 @@
 export type HyperTrackErrorInternal = {
-    type: "hyperTrackError",
-    value: string
-}
+  type: 'error';
+  value: string;
+};

package/src/HyperTrack/data_types/internal/Metadata.ts

@@ -0,0 +1,4 @@
+export type Metadata = {
+  type: 'metadata';
+  value: Object;
+};

package/src/HyperTrack/data_types/internal/Name.ts

@@ -0,0 +1,7 @@
+/**
+ * Device name
+ */
+export type Name = {
+  type: 'name';
+  value: string;
+};

package/src/index.tsx

@@ -10,5 +10,4 @@ export {
 export { LocationError, Errors } from './HyperTrack/data_types/LocationError';
 export { LocationWithDeviation } from './HyperTrack/data_types/LocationWithDeviation';
 export { Location } from './HyperTrack/data_types/Location';
-export { SdkInitParams } from './HyperTrack/data_types/SdkInitParams';
 export { Result, Success, Failure } from './HyperTrack/data_types/Result';

package/android/src/main/java/com/reactnativehypertracksdk/common/HyperTrackError.kt

@@ -1,28 +0,0 @@
-package com.reactnativehypertracksdk.common
-
-/**
- * Check HyperTrack SDK docs for HyperTrackError.
- * Enum naming convention is ignored to make datatype sync across platforms easier.
- * Using Swift naming convention.
- */
-@Suppress("EnumEntryName")
-internal enum class HyperTrackError {
-    gpsSignalLost,
-    locationMocked,
-    locationPermissionsDenied,
-    locationPermissionsInsufficientForBackground,
-    locationPermissionsNotDetermined,
-    locationPermissionsReducedAccuracy,
-    locationPermissionsProvisional,
-    locationPermissionsRestricted,
-    locationServicesDisabled,
-    locationServicesUnavailable,
-    motionActivityPermissionsNotDetermined,
-    motionActivityPermissionsDenied,
-    motionActivityServicesDisabled,
-    motionActivityServicesUnavailable,
-    motionActivityPermissionsRestricted,
-    networkConnectionUnavailable,
-    invalidPublishableKey,
-    blockedFromRunning
-}

package/android/src/main/java/com/reactnativehypertracksdk/common/LocationError.kt

@@ -1,9 +0,0 @@
-package com.reactnativehypertracksdk.common
-
-/**
- * Check HyperTrack SDK docs for LocationError
- */
-internal sealed class LocationError
-internal object NotRunning : LocationError()
-internal object Starting : LocationError()
-internal data class Errors(val errors: Set<HyperTrackError>) : LocationError()

package/android/src/main/java/com/reactnativehypertracksdk/common/SdkInitParams.kt

@@ -1,44 +0,0 @@
-package com.reactnativehypertracksdk.common
-
-import com.reactnativehypertracksdk.common.Serialization.parse
-
-/**
- * SDK config params
- */
-internal data class SdkInitParams(
-    val publishableKey: String,
-    val requireBackgroundTrackingPermission: Boolean,
-    val loggingEnabled: Boolean,
-    val allowMockLocations: Boolean
-) {
-
-    companion object {
-        fun fromMap(map: Map<String, Any?>): Result<SdkInitParams> {
-            return parse(map) {
-                SdkInitParams(
-                    publishableKey = it
-                        .get<String>(KEY_PUBLISHABLE_KEY)
-                        .getOrThrow(),
-                    requireBackgroundTrackingPermission = it
-                        .get<Boolean>(KEY_REQUIRE_BACKGROUND_TRACKING_PERMISSION)
-                        .getOrThrow(),
-                    loggingEnabled = it
-                        .get<Boolean>(KEY_LOGGING_ENABLED)
-                        .getOrThrow(),
-                    allowMockLocations = it
-                        .get<Boolean>(KEY_ALLOW_MOCK_LOCATIONS)
-                        .getOrThrow()
-                )
-            }
-        }
-
-        private const val KEY_PUBLISHABLE_KEY =
-            "publishableKey"
-        private const val KEY_REQUIRE_BACKGROUND_TRACKING_PERMISSION =
-            "requireBackgroundTrackingPermission"
-        private const val KEY_LOGGING_ENABLED =
-            "loggingEnabled"
-        private const val KEY_ALLOW_MOCK_LOCATIONS =
-            "allowMockLocations"
-    }
-}

package/ios/common/HyperTrackError.swift

@@ -1,20 +0,0 @@
-enum HyperTrackError: String {
-    case gpsSignalLost
-    case locationMocked
-    case locationPermissionsDenied
-    case locationPermissionsInsufficientForBackground
-    case locationPermissionsNotDetermined
-    case locationPermissionsReducedAccuracy
-    case locationPermissionsProvisional
-    case locationPermissionsRestricted
-    case locationServicesDisabled
-    case locationServicesUnavailable
-    case motionActivityPermissionsNotDetermined
-    case motionActivityPermissionsDenied
-    case motionActivityServicesDisabled
-    case motionActivityServicesUnavailable
-    case motionActivityPermissionsRestricted
-    case networkConnectionUnavailable
-    case invalidPublishableKey
-    case blockedFromRunning
-}

package/ios/common/SDKInitParams.swift

@@ -1,13 +0,0 @@
-public struct SDKInitParams {
-    let publishableKey: String
-    let loggingEnabled: Bool
-    let allowMockLocations: Bool
-    let automaticallyRequestPermissions: Bool
-    
-    init?(_ map: Dictionary<String, Any>) {
-        self.publishableKey = (map["publishableKey"] as! String)
-        self.loggingEnabled = (map["loggingEnabled"] as! Bool)
-        self.allowMockLocations = (map["allowMockLocations"] as! Bool)
-        self.automaticallyRequestPermissions = (map["automaticallyRequestPermissions"] as! Bool)
-    }
-}

package/lib/commonjs/HyperTrack/data_types/SdkInitParams.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=SdkInitParams.js.map

package/lib/commonjs/HyperTrack/data_types/SdkInitParams.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["SdkInitParams.ts"],"sourcesContent":["/**\n * Parameters for initializing the SDK.\n */\nexport type SdkInitParams = {\n  /**\n   * Enable debug logging.\n   * @default false\n   */\n  loggingEnabled?: boolean;\n\n  /**\n   * Allow mock locations to pass through and don’t send mock location outage.\n   * @default false\n   */\n  allowMockLocations?: boolean;\n\n  /**\n   * Require Background location permissions while requiring permissions on Android.\n   * @default false\n   */\n  requireBackgroundTrackingPermission?: boolean;\n\n  /**\n   * Automatically request permissions on starting tracking on iOS.\n   * @default true\n   */\n  automaticallyRequestPermissions?: boolean;\n};\n"],"mappings":""}

package/lib/commonjs/HyperTrack/data_types/internal/DeviceName.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=DeviceName.js.map

package/lib/commonjs/HyperTrack/data_types/internal/DeviceName.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["DeviceName.ts"],"sourcesContent":["export type DeviceName = {\n  type: 'deviceName';\n  value: string;\n};\n"],"mappings":""}

package/lib/module/HyperTrack/data_types/SdkInitParams.js

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=SdkInitParams.js.map

package/lib/module/HyperTrack/data_types/SdkInitParams.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["SdkInitParams.ts"],"sourcesContent":["/**\n * Parameters for initializing the SDK.\n */\nexport type SdkInitParams = {\n  /**\n   * Enable debug logging.\n   * @default false\n   */\n  loggingEnabled?: boolean;\n\n  /**\n   * Allow mock locations to pass through and don’t send mock location outage.\n   * @default false\n   */\n  allowMockLocations?: boolean;\n\n  /**\n   * Require Background location permissions while requiring permissions on Android.\n   * @default false\n   */\n  requireBackgroundTrackingPermission?: boolean;\n\n  /**\n   * Automatically request permissions on starting tracking on iOS.\n   * @default true\n   */\n  automaticallyRequestPermissions?: boolean;\n};\n"],"mappings":""}

package/lib/module/HyperTrack/data_types/internal/DeviceName.js

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=DeviceName.js.map

package/lib/module/HyperTrack/data_types/internal/DeviceName.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["DeviceName.ts"],"sourcesContent":["export type DeviceName = {\n  type: 'deviceName';\n  value: string;\n};\n"],"mappings":""}

package/lib/typescript/HyperTrack/data_types/SdkInitParams.d.ts

@@ -1,25 +0,0 @@
-/**
- * Parameters for initializing the SDK.
- */
-export type SdkInitParams = {
-    /**
-     * Enable debug logging.
-     * @default false
-     */
-    loggingEnabled?: boolean;
-    /**
-     * Allow mock locations to pass through and don’t send mock location outage.
-     * @default false
-     */
-    allowMockLocations?: boolean;
-    /**
-     * Require Background location permissions while requiring permissions on Android.
-     * @default false
-     */
-    requireBackgroundTrackingPermission?: boolean;
-    /**
-     * Automatically request permissions on starting tracking on iOS.
-     * @default true
-     */
-    automaticallyRequestPermissions?: boolean;
-};

package/lib/typescript/HyperTrack/data_types/internal/DeviceName.d.ts

@@ -1,4 +0,0 @@
-export type DeviceName = {
-    type: 'deviceName';
-    value: string;
-};

package/src/HyperTrack/data_types/SdkInitParams.ts

@@ -1,28 +0,0 @@
-/**
- * Parameters for initializing the SDK.
- */
-export type SdkInitParams = {
-  /**
-   * Enable debug logging.
-   * @default false
-   */
-  loggingEnabled?: boolean;
-
-  /**
-   * Allow mock locations to pass through and don’t send mock location outage.
-   * @default false
-   */
-  allowMockLocations?: boolean;
-
-  /**
-   * Require Background location permissions while requiring permissions on Android.
-   * @default false
-   */
-  requireBackgroundTrackingPermission?: boolean;
-
-  /**
-   * Automatically request permissions on starting tracking on iOS.
-   * @default true
-   */
-  automaticallyRequestPermissions?: boolean;
-};

package/src/HyperTrack/data_types/internal/DeviceName.ts

@@ -1,4 +0,0 @@
-export type DeviceName = {
-  type: 'deviceName';
-  value: string;
-};