hypertrack-sdk-react-native 9.1.1 → 9.2.0

package/src/HyperTrack/HyperTrack.ts

@@ -2,14 +2,18 @@ import { NativeModules, Platform, NativeEventEmitter } from 'react-native';
 import { HyperTrackError } from './data_types/HyperTrackError';
 import type { IsAvailable } from './data_types/internal/IsAvailable';
 import type { IsTracking } from './data_types/internal/IsTracking';
-import type { LocationResponse } from './data_types/internal/LocationResponse';
 import type { Location } from './data_types/Location';
 import type { LocationError } from './data_types/LocationError';
 import type { SdkInitParams } from './data_types/SdkInitParams';
 import type { DeviceId } from './data_types/internal/DeviceId';
-import type { Geotag } from './data_types/internal/Geotag';
+import type { GeotagData } from './data_types/internal/GeotagData';
 import type { DeviceName } from './data_types/internal/DeviceName';
 import type { HyperTrackErrorInternal } from './data_types/internal/HyperTrackErrorInternal';
+import type { Result } from './data_types/Result';
+import type { LocationWithDeviation } from './data_types/LocationWithDeviation';
+import type { LocationErrorInternal } from './data_types/internal/LocationErrorInternal';
+import type { LocationInternal } from './data_types/internal/LocationInternal';
+import type { LocationWithDeviationInternal } from './data_types/internal/LocationWithDeviationInternal';
 
 const EVENT_TRACKING = 'onTrackingChanged';
 const EVENT_AVAILABILITY = 'onAvailabilityChanged';
@@ -24,13 +28,13 @@ const LINKING_ERROR =
 const HyperTrackSdk = NativeModules.HyperTrackReactNativePlugin
   ? NativeModules.HyperTrackReactNativePlugin
   : new Proxy(
-    {},
-    {
-      get() {
-        throw new Error(LINKING_ERROR);
-      },
-    }
-  );
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );
 
 const EventEmitter = new NativeEventEmitter(HyperTrackSdk);
 
@@ -41,7 +45,7 @@ export default class HyperTrack {
 
   /**
    * Creates an SDK instance
-   * 
+   *
    * @param publishableKey publishable key provided in HyperTrack’s dashboard setup page
    * @param sdkInitParams
    * @returns HyperTrack instance
@@ -55,8 +59,10 @@ export default class HyperTrack {
         publishableKey,
         loggingEnabled: sdkInitParams.loggingEnabled ?? false,
         allowMockLocations: sdkInitParams.allowMockLocations ?? false,
-        requireBackgroundTrackingPermission: sdkInitParams.requireBackgroundTrackingPermission ?? false,
-        automaticallyRequestPermissions: sdkInitParams.automaticallyRequestPermissions ?? true,
+        requireBackgroundTrackingPermission:
+          sdkInitParams.requireBackgroundTrackingPermission ?? false,
+        automaticallyRequestPermissions:
+          sdkInitParams.automaticallyRequestPermissions ?? true,
       });
       return new HyperTrack();
     } catch (error: any) {
@@ -92,13 +98,13 @@ export default class HyperTrack {
   setAvailability(isAvailable: boolean) {
     HyperTrackSdk.setAvailability({
       type: 'isAvailable',
-      value: isAvailable
+      value: isAvailable,
     } as IsAvailable);
   }
 
   /**
    * Reflects the tracking intent for the device
-   * 
+   *
    * @return {boolean} Whether the user's movement data is getting tracked or not.
    */
   isTracking(): Promise<boolean> {
@@ -133,7 +139,7 @@ export default class HyperTrack {
    */
   getLocation(): Promise<LocationError | Location> {
     return HyperTrackSdk.getLocation().then(
-      (locationResponse: LocationResponse) => {
+      (locationResponse: Result<LocationInternal, LocationErrorInternal>) => {
         return this.deserializeLocationResponse(locationResponse);
       }
     );
@@ -146,8 +152,8 @@ export default class HyperTrack {
   setName(name: string) {
     HyperTrackSdk.setName({
       type: 'deviceName',
-      value: name
-    } as DeviceName)
+      value: name,
+    } as DeviceName);
   }
 
   /**
@@ -160,17 +166,66 @@ export default class HyperTrack {
 
   /**
    * Adds a new geotag
+   *
    * @param {Object} data - Geotad data JSON
    * @returns current location if success or LocationError if failure
    */
-  addGeotag(data: Object): Promise<LocationError | Location> {
-    return HyperTrackSdk.addGeotag({
-      data
-    } as Geotag).then(
-      (locationResponse: LocationResponse) => {
-        return this.deserializeLocationResponse(locationResponse);
-      }
-    );
+  async addGeotag(data: Object): Promise<Result<Location, LocationError>>;
+
+  /**
+   * Adds a new geotag with expected location
+   *
+   * @param {Object} data - Geotad data JSON
+   * @param {Location} expectedLocation - Expected location
+   * @returns location with deviation if success or LocationError if failure
+   */
+  async addGeotag(
+    data: Object,
+    expectedLocation: Location
+  ): Promise<Result<Location, LocationError>>;
+
+  async addGeotag(
+    ...args: any[]
+  ): Promise<Result<Location | LocationWithDeviation, LocationError>> {
+    if (args.length === 1 && typeof args[0] === 'object') {
+      return HyperTrackSdk.addGeotag({
+        data: args[0],
+        expectedLocation: undefined,
+      } as GeotagData).then(
+        (locationResponse: Result<LocationInternal, LocationErrorInternal>) => {
+          return this.deserializeLocationResponse(locationResponse);
+        }
+      );
+    } else if (
+      args.length === 2 &&
+      typeof args[0] === 'object' &&
+      this.isLocation(args[1])
+    ) {
+      let expectedLocation = args[1] as Location;
+      return HyperTrackSdk.addGeotag({
+        data: args[0],
+        expectedLocation: {
+          type: 'location',
+          value: {
+            latitude: expectedLocation.latitude,
+            longitude: expectedLocation.longitude,
+          },
+        } as LocationInternal,
+      } as GeotagData).then(
+        (
+          locationResponse: Result<
+            LocationWithDeviationInternal,
+            LocationErrorInternal
+          >
+        ) => {
+          return this.deserializeLocationWithDeviationResponse(
+            locationResponse
+          );
+        }
+      );
+    } else {
+      throw new Error('Invalid arguments');
+    }
   }
 
   /**
@@ -191,9 +246,12 @@ export default class HyperTrack {
    * ```
    */
   subscribeToErrors(listener: (errors: HyperTrackError[]) => void) {
-    return EventEmitter.addListener(EVENT_ERROR, (rawErrors: HyperTrackErrorInternal[]) => {
-      listener(this.deserializeHyperTrackErrors(rawErrors))
-    });
+    return EventEmitter.addListener(
+      EVENT_ERROR,
+      (rawErrors: HyperTrackErrorInternal[]) => {
+        listener(this.deserializeHyperTrackErrors(rawErrors));
+      }
+    );
   }
 
   /**
@@ -249,26 +307,82 @@ export default class HyperTrack {
   }
 
   /** @ignore */
-  private deserializeHyperTrackErrors(errors: HyperTrackErrorInternal[]): HyperTrackError[] {
-    return errors.map((error: HyperTrackErrorInternal) => HyperTrackError[error.value as keyof typeof HyperTrackError])
+  private deserializeHyperTrackErrors(
+    errors: HyperTrackErrorInternal[]
+  ): HyperTrackError[] {
+    return errors.map(
+      (error: HyperTrackErrorInternal) =>
+        HyperTrackError[error.value as keyof typeof HyperTrackError]
+    );
   }
 
   /** @ignore */
-  private deserializeLocationResponse(response: LocationResponse): Location | LocationError {
-    switch(response.type) {
-      case "success":
-        return response.value
-      case "failure":
-        switch(response.value.type) {
-          case "notRunning":
-          case "starting":
-            return response.value
-          case "errors":
-            return {
-              type: "errors",
-              value: this.deserializeHyperTrackErrors(response.value.value)
-            }
-        }
-    };
+  private deserializeLocationResponse(
+    response: Result<LocationInternal, LocationErrorInternal>
+  ): Result<Location, LocationError> {
+    switch (response.type) {
+      case 'success':
+        return {
+          type: 'success',
+          value: response.value.value,
+        };
+      case 'failure':
+        return {
+          type: 'failure',
+          value: this.deserializeLocationError(response.value),
+        };
+    }
+  }
+
+  /** @ignore */
+  private deserializeLocationWithDeviationResponse(
+    response: Result<LocationWithDeviationInternal, LocationErrorInternal>
+  ): Result<LocationWithDeviation, LocationError> {
+    switch (response.type) {
+      case 'success':
+        const locationWithDeviationInternal: LocationWithDeviationInternal =
+          response.value;
+        const locationInternal: LocationInternal =
+          locationWithDeviationInternal.value.location;
+
+        return {
+          type: 'success',
+          value: {
+            location: locationInternal.value,
+            deviation: locationWithDeviationInternal.value.deviation,
+          } as LocationWithDeviation,
+        };
+      case 'failure':
+        return {
+          type: 'failure',
+          value: this.deserializeLocationError(response.value),
+        };
+    }
+  }
+
+  /** @ignore */
+  private deserializeLocationError(
+    locationError: LocationErrorInternal
+  ): LocationError {
+    switch (locationError.type) {
+      case 'notRunning':
+      case 'starting':
+        return locationError;
+      case 'errors':
+        return {
+          type: 'errors',
+          value: this.deserializeHyperTrackErrors(locationError.value),
+        };
+    }
+  }
+
+  /** @ignore */
+  private isLocation(obj: Location): obj is Location {
+    return (
+      'latitude' in obj &&
+      typeof obj.latitude == 'number' &&
+      'longitude' in obj &&
+      typeof obj.longitude == 'number'
+    );
   }
 }

package/src/HyperTrack/data_types/Location.ts

@@ -1,7 +1,4 @@
 export type Location = {
-  type: 'location';
-  value: {
-    latitude: number;
-    longitude: number;
-  };
+  latitude: number;
+  longitude: number;
 };

package/src/HyperTrack/data_types/LocationWithDeviation.ts

@@ -0,0 +1,6 @@
+import type { Location } from './Location';
+
+export type LocationWithDeviation = {
+  location: Location;
+  deviation: number;
+};

package/src/HyperTrack/data_types/Result.ts

@@ -0,0 +1,11 @@
+export type Success<S> = {
+  type: 'success';
+  value: S;
+};
+
+export type Failure<F> = {
+  type: 'failure';
+  value: F;
+};
+
+export type Result<S, F> = Success<S> | Failure<F>;

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

@@ -0,0 +1,6 @@
+import type { LocationInternal } from './LocationInternal';
+
+export type GeotagData = {
+  data: Object;
+  expectedLocation?: LocationInternal;
+};

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

@@ -0,0 +1,7 @@
+export type LocationInternal = {
+  type: 'location';
+  value: {
+    latitude: number;
+    longitude: number;
+  };
+};

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

@@ -0,0 +1,9 @@
+import type { LocationInternal } from './LocationInternal';
+
+export type LocationWithDeviationInternal = {
+  type: 'locationWithDeviation';
+  value: {
+    location: LocationInternal;
+    deviation: number;
+  };
+};

package/src/index.tsx

@@ -3,7 +3,11 @@ export default HyperTrack;
 export { HyperTrack };
 
 export { HyperTrackError } from './HyperTrack/data_types/HyperTrackError';
-export { NotRunning, Starting } from './HyperTrack/data_types/internal/LocationErrorInternal';
+export {
+  NotRunning,
+  Starting,
+} from './HyperTrack/data_types/internal/LocationErrorInternal';
 export { LocationError, Errors } from './HyperTrack/data_types/LocationError';
 export { Location } from './HyperTrack/data_types/Location';
-export { SdkInitParams } from './HyperTrack/data_types/SdkInitParams'
+export { SdkInitParams } from './HyperTrack/data_types/SdkInitParams';
+export { Result, Success, Failure } from './HyperTrack/data_types/Result';

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

@@ -1,9 +0,0 @@
-package com.reactnativehypertracksdk.common
-
-/**
- * The data that represents geotag to create. Now it contains only payload data but
- * can have other params like expectedLocation in future
- *
- * @param data Geotag payload
- */
-internal data class Geotag(val data: Map<String, Any?>)

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

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

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

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["Geotag.ts"],"sourcesContent":["export type Geotag = {\n    data: Object\n}\n"],"mappings":""}

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

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["LocationResponse.ts"],"sourcesContent":["import type { Location } from '../Location';\nimport type { LocationErrorInternal } from './LocationErrorInternal';\n\nexport type LocationSuccess = {\n  type: 'success';\n  value: Location;\n};\n\nexport type LocationFailure = {\n  type: 'failure';\n  value: LocationErrorInternal;\n};\n\nexport type LocationResponse = LocationSuccess | LocationFailure;\n"],"mappings":""}

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

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

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

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["Geotag.ts"],"sourcesContent":["export type Geotag = {\n    data: Object\n}\n"],"mappings":""}

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

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=LocationResponse.js.map

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

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["LocationResponse.ts"],"sourcesContent":["import type { Location } from '../Location';\nimport type { LocationErrorInternal } from './LocationErrorInternal';\n\nexport type LocationSuccess = {\n  type: 'success';\n  value: Location;\n};\n\nexport type LocationFailure = {\n  type: 'failure';\n  value: LocationErrorInternal;\n};\n\nexport type LocationResponse = LocationSuccess | LocationFailure;\n"],"mappings":""}

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

@@ -1,3 +0,0 @@
-export type Geotag = {
-    data: Object;
-};

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

@@ -1,11 +0,0 @@
-import type { Location } from '../Location';
-import type { LocationErrorInternal } from './LocationErrorInternal';
-export type LocationSuccess = {
-    type: 'success';
-    value: Location;
-};
-export type LocationFailure = {
-    type: 'failure';
-    value: LocationErrorInternal;
-};
-export type LocationResponse = LocationSuccess | LocationFailure;

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

@@ -1,3 +0,0 @@
-export type Geotag = {
-    data: Object
-}

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

@@ -1,14 +0,0 @@
-import type { Location } from '../Location';
-import type { LocationErrorInternal } from './LocationErrorInternal';
-
-export type LocationSuccess = {
-  type: 'success';
-  value: Location;
-};
-
-export type LocationFailure = {
-  type: 'failure';
-  value: LocationErrorInternal;
-};
-
-export type LocationResponse = LocationSuccess | LocationFailure;