hypertrack-sdk-react-native 13.2.3 → 13.3.1

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

@@ -4,9 +4,30 @@ import type { Location } from './data_types/Location';
 import type { LocationError } from './data_types/LocationError';
 import type { LocationWithDeviation } from './data_types/LocationWithDeviation';
 import type { Result } from './data_types/Result';
+import type { OrderStatus } from './data_types/OrderStatus';
 export default class HyperTrack {
     private static locateSubscription;
     /**
+     * Adds a new geotag. Check [Shift tracking](https://hypertrack.com/docs/shift-tracking) and [Clock In/Out tagging](https://hypertrack.com/docs/clock-inout-tracking) docs to learn how to use Order handle and Order status params.
+     *
+     * @param {string} orderHandle - Order handle
+     * @param {OrderStatus} orderStatus - Order status
+     * @param {Object} data - Geotag data JSON
+     * @returns current location if success or LocationError if failure
+     */
+    static addGeotag(orderHandle: string, orderStatus: OrderStatus, data: Object): Promise<Result<Location, LocationError>>;
+    /**
+     * Adds a new geotag with expected location. Check [Shift tracking](https://hypertrack.com/docs/shift-tracking) and [Clock In/Out tagging](https://hypertrack.com/docs/clock-inout-tracking) docs to learn how to use Order handle and Order status params.
+     *
+     * @param {string} orderHandle - Order handle
+     * @param {OrderStatus} orderStatus - Order status
+     * @param {Object} data - Geotag data JSON
+     * @param {Location} expectedLocation - Expected location
+     * @returns location with deviation if success or LocationError if failure
+     */
+    static addGeotag(orderHandle: string, orderStatus: OrderStatus, data: Object, expectedLocation: Location): Promise<Result<LocationWithDeviation, LocationError>>;
+    /**
+     * @deprecated
      * Adds a new geotag
      *
      * @param {Object} data - Geotag data JSON
@@ -14,6 +35,7 @@ export default class HyperTrack {
      */
     static addGeotag(data: Object): Promise<Result<Location, LocationError>>;
     /**
+     * @deprecated
      * Adds a new geotag with expected location
      *
      * @param {Object} data - Geotag data JSON
@@ -198,4 +220,6 @@ export default class HyperTrack {
     private static deserializeName;
     /** @ignore */
     private static isLocation;
+    /** @ignore */
+    private static isOrderStatus;
 }

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

@@ -0,0 +1,8 @@
+export type OrderStatus = {
+    type: 'orderStatusClockIn';
+} | {
+    type: 'orderStatusClockOut';
+} | {
+    type: 'orderStatusCustom';
+    value: string;
+};

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

@@ -1,5 +1,9 @@
+import type { OrderStatus } from '../OrderStatus';
 import type { LocationInternal } from './LocationInternal';
+import type { OrderHandle } from './OrderHandle';
 export type GeotagData = {
+    orderHandle: OrderHandle;
+    orderStatus: OrderStatus;
     data: Object;
     expectedLocation?: LocationInternal;
 };

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

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

package/lib/typescript/index.d.ts

@@ -7,3 +7,4 @@ export { LocationError, Errors } from './HyperTrack/data_types/LocationError';
 export { LocationWithDeviation } from './HyperTrack/data_types/LocationWithDeviation';
 export { Location } from './HyperTrack/data_types/Location';
 export { Result, Success, Failure } from './HyperTrack/data_types/Result';
+export { OrderStatus } from './HyperTrack/data_types/OrderStatus';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypertrack-sdk-react-native",
-  "version": "13.2.3",
+  "version": "13.3.1",
   "description": "React Native HyperTrack SDK is a wrapper around native iOS and Android SDKs that allows to integrate HyperTrack into React Native apps.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/HyperTrack/HyperTrack.ts

@@ -20,6 +20,8 @@ import type { LocationInternal } from './data_types/internal/LocationInternal';
 import type { LocationWithDeviationInternal } from './data_types/internal/LocationWithDeviationInternal';
 import type { Metadata } from './data_types/internal/Metadata';
 import type { DynamicPublishableKey } from './data_types/internal/DynamicPublishableKey';
+import type { OrderStatus } from './data_types/OrderStatus';
+import type { OrderHandle } from './data_types/internal/OrderHandle';
 
 const EVENT_ERRORS = 'errors';
 const EVENT_IS_AVAILABLE = 'isAvailable';
@@ -50,6 +52,37 @@ export default class HyperTrack {
   private static locateSubscription: EmitterSubscription | undefined;
 
   /**
+   * Adds a new geotag. Check [Shift tracking](https://hypertrack.com/docs/shift-tracking) and [Clock In/Out tagging](https://hypertrack.com/docs/clock-inout-tracking) docs to learn how to use Order handle and Order status params.
+   *
+   * @param {string} orderHandle - Order handle
+   * @param {OrderStatus} orderStatus - Order status
+   * @param {Object} data - Geotag data JSON
+   * @returns current location if success or LocationError if failure
+   */
+  static async addGeotag(
+    orderHandle: string,
+    orderStatus: OrderStatus,
+    data: Object
+  ): Promise<Result<Location, LocationError>>;
+
+  /**
+   * Adds a new geotag with expected location. Check [Shift tracking](https://hypertrack.com/docs/shift-tracking) and [Clock In/Out tagging](https://hypertrack.com/docs/clock-inout-tracking) docs to learn how to use Order handle and Order status params.
+   *
+   * @param {string} orderHandle - Order handle
+   * @param {OrderStatus} orderStatus - Order status
+   * @param {Object} data - Geotag data JSON
+   * @param {Location} expectedLocation - Expected location
+   * @returns location with deviation if success or LocationError if failure
+   */
+  static async addGeotag(
+    orderHandle: string,
+    orderStatus: OrderStatus,
+    data: Object,
+    expectedLocation: Location
+  ): Promise<Result<LocationWithDeviation, LocationError>>;
+
+  /**
+   * @deprecated
    * Adds a new geotag
    *
    * @param {Object} data - Geotag data JSON
@@ -60,6 +93,7 @@ export default class HyperTrack {
   ): Promise<Result<Location, LocationError>>;
 
   /**
+   * @deprecated
    * Adds a new geotag with expected location
    *
    * @param {Object} data - Geotag data JSON
@@ -74,7 +108,64 @@ export default class HyperTrack {
   static async addGeotag(
     ...args: any[]
   ): Promise<Result<Location | LocationWithDeviation, LocationError>> {
+    if (
+      args.length === 3 &&
+      typeof args[0] === 'string' &&
+      HyperTrack.isOrderStatus(args[1]) &&
+      typeof args[2] === 'object'
+    ) {
+      // addGeotag(orderHandle: string, orderStatus: OrderStatus, data: Object)
+      return HyperTrackSdk.addGeotag({
+        orderHandle: {
+          type: 'orderHandle',
+          value: args[0],
+        } as OrderHandle,
+        orderStatus: args[1],
+        data: args[2],
+        expectedLocation: undefined,
+      } as GeotagData).then(
+        (locationResponse: Result<LocationInternal, LocationErrorInternal>) => {
+          return this.deserializeLocationResponse(locationResponse);
+        }
+      );
+    }
+    if (
+      args.length === 4 &&
+      typeof args[0] === 'string' &&
+      HyperTrack.isOrderStatus(args[1]) &&
+      typeof args[2] === 'object' &&
+      HyperTrack.isLocation(args[3])
+    ) {
+      // addGeotag(orderHandle: string, orderStatus: OrderStatus, data: Object, expectedLocation: Location)
+      return HyperTrackSdk.addGeotag({
+        orderHandle: {
+          type: 'orderHandle',
+          value: args[0],
+        } as OrderHandle,
+        orderStatus: args[1],
+        data: args[2],
+        expectedLocation: {
+          type: 'location',
+          value: {
+            latitude: args[3].latitude,
+            longitude: args[3].longitude,
+          },
+        } as LocationInternal,
+      } as GeotagData).then(
+        (
+          locationResponse: Result<
+            LocationWithDeviationInternal,
+            LocationErrorInternal
+          >
+        ) => {
+          return this.deserializeLocationWithDeviationResponse(
+            locationResponse
+          );
+        }
+      );
+    }
     if (args.length === 1 && typeof args[0] === 'object') {
+      // addGeotag(data: Object)
       return HyperTrackSdk.addGeotag({
         data: args[0],
         expectedLocation: undefined,
@@ -83,19 +174,20 @@ export default class HyperTrack {
           return this.deserializeLocationResponse(locationResponse);
         }
       );
-    } else if (
+    }
+    if (
       args.length === 2 &&
       typeof args[0] === 'object' &&
       HyperTrack.isLocation(args[1])
     ) {
-      let expectedLocation = args[1] as Location;
+      // addGeotag(data: Object, expectedLocation: Location)
       return HyperTrackSdk.addGeotag({
         data: args[0],
         expectedLocation: {
           type: 'location',
           value: {
-            latitude: expectedLocation.latitude,
-            longitude: expectedLocation.longitude,
+            latitude: args[1].latitude,
+            longitude: args[1].longitude,
           },
         } as LocationInternal,
       } as GeotagData).then(
@@ -110,9 +202,8 @@ export default class HyperTrack {
           );
         }
       );
-    } else {
-      throw new Error('Invalid arguments');
     }
+    throw new Error(`Invalid addGeotag() arguments: ${JSON.stringify(args)}`);
   }
 
   /**
@@ -535,4 +626,9 @@ export default class HyperTrack {
       typeof obj.longitude === 'number'
     );
   }
+
+  /** @ignore */
+  private static isOrderStatus(obj: OrderStatus): obj is OrderStatus {
+    return 'type' in obj && obj.type.startsWith('orderStatus');
+  }
 }

package/src/HyperTrack/data_types/OrderStatus.ts

@@ -0,0 +1,11 @@
+export type OrderStatus =
+  | {
+      type: 'orderStatusClockIn';
+    }
+  | {
+      type: 'orderStatusClockOut';
+    }
+  | {
+      type: 'orderStatusCustom';
+      value: string;
+    };

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

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

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

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

package/src/index.tsx

@@ -11,3 +11,4 @@ export { LocationError, Errors } from './HyperTrack/data_types/LocationError';
 export { LocationWithDeviation } from './HyperTrack/data_types/LocationWithDeviation';
 export { Location } from './HyperTrack/data_types/Location';
 export { Result, Success, Failure } from './HyperTrack/data_types/Result';
+export { OrderStatus } from './HyperTrack/data_types/OrderStatus';