hypertrack-sdk-react-native 13.7.1 → 14.0.0

package/src/HyperTrack/HyperTrack.ts

@@ -27,6 +27,7 @@ import type { Order } from './data_types/Order';
 import type { OrdersInternal } from './data_types/internal/OrdersInternal';
 import type { OrderInternal } from './data_types/internal/OrderInternal';
 import type { IsInsideGeofence } from './data_types/internal/IsInsideGeofence';
+import type { AllowMockLocation } from './data_types/internal/AllowMockLocation';
 
 const EVENT_ERRORS = 'errors';
 const EVENT_IS_AVAILABLE = 'isAvailable';
@@ -212,6 +213,19 @@ export default class HyperTrack {
     throw new Error(`Invalid addGeotag() arguments: ${JSON.stringify(args)}`);
   }
 
+  /**
+   * If disallowed, the HyperTrack platform will display and outage if mocked location is detected.
+   *
+   * @param {boolean} true if mock location is allowed
+   */
+  static async getAllowMockLocation(): Promise<boolean> {
+    return HyperTrackSdk.getAllowMockLocation().then(
+      (allowMockLocation: AllowMockLocation) => {
+        return this.deserializeAllowMockLocation(allowMockLocation);
+      }
+    );
+  }
+
   /**
    * Returns a string that is used to uniquely identify the device
    *
@@ -299,7 +313,7 @@ export default class HyperTrack {
   }
 
   /**
-   * Gets the active orders for the worker. The orders are sorted with the ordering in 
+   * Gets the active orders for the worker. The orders are sorted with the ordering in
    * which the worker should complete them.
    *
    * @returns {Map<string, Order>} Map of orders
@@ -359,6 +373,23 @@ export default class HyperTrack {
     return this.locateSubscription;
   }
 
+  /**
+   * Allows mocking location data.
+   *
+   * Check the [Test with mock locations](https://hypertrack.com/docs/mock-location) guide for more information.
+   *
+   * To avoid issues related to race conditions in your code use this API **only if** modifying the compiled `HyperTrackAllowMockLocation` AndroidManifest.xml/Info.plist value is insufficient for your needs.
+   * Example: if for some reason you aren't able to recompile with `HyperTrackAllowMockLocation` set to `YES`/`true` for your prod app QA mock location tests and need to set up the value in runtime.
+   *
+   * @param true if mock location is allowed
+   */
+  static async setAllowMockLocation(allow: boolean): Promise<void> {
+    HyperTrackSdk.setAllowMockLocation({
+      type: 'allowMockLocation',
+      value: allow,
+    } as AllowMockLocation);
+  }
+
   static setDynamicPublishableKey(dynamicPublishableKey: string) {
     HyperTrackSdk.setDynamicPublishableKey({
       type: 'dynamicPublishableKey',
@@ -563,6 +594,18 @@ export default class HyperTrack {
     });
   }
 
+  /** @ignore */
+  private static deserializeAllowMockLocation(
+    allowMockLocation: AllowMockLocation
+  ): boolean {
+    if (allowMockLocation.type !== 'allowMockLocation') {
+      throw new Error(
+        `Invalid allowMockLocation: ${JSON.stringify(allowMockLocation)}`
+      );
+    }
+    return allowMockLocation.value;
+  }
+
   /** @ignore */
   private static deserializeDynamicPublishableKey(
     dynamicPublishableKey: DynamicPublishableKey
@@ -595,13 +638,15 @@ export default class HyperTrack {
 
   /** @ignore */
   private static deserializeIsInsideGeofence(
-    isInsideGeofence: Result<IsInsideGeofence, LocationErrorInternal>,
+    isInsideGeofence: Result<IsInsideGeofence, LocationErrorInternal>
   ): Result<boolean, LocationError> {
     switch (isInsideGeofence.type) {
       case 'success':
         let successValue = isInsideGeofence.value;
         if (successValue.type !== 'isInsideGeofence') {
-          throw new Error(`Invalid isInsideGeofence: ${JSON.stringify(successValue)}`);
+          throw new Error(
+            `Invalid isInsideGeofence: ${JSON.stringify(successValue)}`
+          );
         }
         return {
           type: 'success',
@@ -719,16 +764,27 @@ export default class HyperTrack {
       .map(([_, value]: [string, OrderInternal]) => {
         return value;
       })
-      .sort(
-        (first: OrderInternal, second: OrderInternal) =>
-          first.index - second.index
-      )
+      .sort((first: OrderInternal, second: OrderInternal) => {
+        if (first.index === undefined || second.index === undefined) {
+          throw new Error(
+            `Invalid order index: ${JSON.stringify(first)} ${JSON.stringify(
+              second
+            )}`
+          );
+        }
+        return first.index - second.index;
+      })
       .forEach((orderInternal: OrderInternal) => {
         result.set(orderInternal.orderHandle, {
           orderHandle: orderInternal.orderHandle,
-          isInsideGeofence: this.deserializeIsInsideGeofence(
-            orderInternal.isInsideGeofence
-          ),
+          isInsideGeofence: async () => {
+            const isInsideGeofence =
+              await HyperTrackSdk.getOrderIsInsideGeofence({
+                type: 'orderHandle',
+                value: orderInternal.orderHandle,
+              });
+            return this.deserializeIsInsideGeofence(isInsideGeofence);
+          },
         } as Order);
       });
     return result;

package/src/HyperTrack/data_types/Order.ts

@@ -3,5 +3,5 @@ import type { LocationError } from './LocationError';
 
 export type Order = {
   orderHandle: string;
-  isInsideGeofence: Result<boolean, LocationError>;
+  isInsideGeofence: () => Promise<Result<boolean, LocationError>>;
 };

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

@@ -0,0 +1,4 @@
+export type AllowMockLocation = {
+    type: 'allowMockLocation';
+    value: boolean;
+};

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

@@ -1,9 +1,4 @@
-import type { Result } from '../Result';
-import type { IsInsideGeofence } from './IsInsideGeofence';
-import type { LocationErrorInternal } from './LocationErrorInternal';
-
 export type OrderInternal = {
   orderHandle: string;
-  isInsideGeofence: Result<IsInsideGeofence, LocationErrorInternal>;
   index: number;
 };