@doorstepai/dropoff-sdk 1.0.7 → 1.0.9

package/README.md

@@ -1,4 +1,3 @@
-
 # DoorstepAI Dropoff SDK for React Native
 
 The `@doorstepai/dropoff-sdk` provides a set of tools to integrate delivery tracking into your React Native application. This SDK enables seamless coordination between your delivery interface and DoorstepAI's backend systems.
@@ -52,22 +51,35 @@ import { DoorstepAI } from "@doorstepai/dropoff-sdk"
 
 // Start a delivery using a Google Place ID
 <Button title="Start Delivery" onPress={() => {
-  DoorstepAI.startDeliveryByPlaceID("213");
+  DoorstepAI.startDeliveryByPlaceID('destination_place_id', 'delivery_id_1');
+}} />
+
+// Start a delivery using an address
+<Button title="Start Delivery by Address" onPress={() => {
+  const address = {
+    streetNumber: '123',
+    route: 'Main St',
+    subPremise: 'Apt 4B',
+    locality: 'New York',
+    administrativeAreaLevel1: 'NY',
+    postalCode: '10001'
+  };
+  DoorstepAI.startDeliveryByAddress(address, 'delivery_id_1');
 }} />
 
 // Send "taking_pod" event
 <Button title="Taking POD" onPress={() => {
-  DoorstepAI.newEvent("taking_pod");
+  DoorstepAI.newEvent('taking_pod', 'delivery_id_1');
 }} />
 
 // Send "pod_captured" event
 <Button title="POD Captured" onPress={() => {
-  DoorstepAI.newEvent("pod_captured");
+  DoorstepAI.newEvent('pod_captured', 'delivery_id_1');
 }} />
 
 // End the delivery
 <Button title="End Delivery" onPress={() => {
-  DoorstepAI.stopDelivery();
+  DoorstepAI.stopDelivery('delivery_id_1');
 }} />
 ```
 
@@ -89,43 +101,44 @@ Sets the API key to authenticate SDK usage.
 
 ---
 
-### `DoorstepAI.startDeliveryByPlaceID(placeID: string): Promise<void>`
+### `DoorstepAI.startDeliveryByPlaceID(placeID: string, deliveryId: string): Promise<string>`
 
-Starts a delivery using a Google Place ID.
+Starts a delivery using a Google Place ID. Returns a session ID on success.
 
 ---
 
-### `DoorstepAI.startDeliveryByPlusCode(plusCode: string): Promise<void>`
+### `DoorstepAI.startDeliveryByPlusCode(plusCode: string, deliveryId: string): Promise<string>`
 
-Starts a delivery using a Google Plus Code.
+Starts a delivery using a Google Plus Code. Returns a session ID on success.
 
 ---
 
-### `DoorstepAI.startDeliveryByAddress(address: AddressType): Promise<void>`
+### `DoorstepAI.startDeliveryByAddress(address: AddressType, deliveryId: string): Promise<string>`
 
-Starts a delivery using a structured address object.
+Starts a delivery using a structured address object. Returns a session ID on success.
 
 ```ts
 type AddressType = {
   streetNumber: string;
   route: string;
-  locality: string;
-  administrativeAreaLevel1: string;
+  subPremise: string;      // Apartment, suite, unit, etc.
+  locality: string;        // City
+  administrativeAreaLevel1: string;  // State/Province
   postalCode: string;
 }
 ```
 
 ---
 
-### `DoorstepAI.stopDelivery(): Promise<void>`
+### `DoorstepAI.stopDelivery(deliveryId: string): Promise<void>`
 
-Stops the current delivery.
+Stops the specified delivery.
 
 ---
 
-### `DoorstepAI.newEvent(eventName: string): Promise<void>`
+### `DoorstepAI.newEvent(eventName: string, deliveryId: string): Promise<void>`
 
-Sends a delivery-related event. Supported events include:
+Sends a delivery-related event for the specified delivery. Supported events include:
 - `"taking_pod"`
 - `"pod_captured"`
 
@@ -138,6 +151,8 @@ More can be added per vender/customer relationship.
 - Always wrap `DoorstepAI` API calls in `try/catch` or use `.catch()` for better error handling when applicable.
 - Use the `RootDoorstepAI` component only **once** at the **root** of your app.
 - Ensure your API key is securely stored and never hardcoded in production.
+- Always provide a unique `deliveryId` for each delivery session.
+- Keep track of the `deliveryId` throughout the delivery lifecycle as it's required for all operations.
 
 ---
 
@@ -148,8 +163,7 @@ If something isn't working as expected:
 - Check console logs for `DoorstepAI initialized` or error messages.
 - Verify that the API key is valid and accepted by the SDK.
 - Ensure your permissions (e.g., location) are correctly set up on the device.
-
----
+- Verify that you're using the correct `deliveryId` for each operation.
 
 ---
 

package/android/build.gradle

@@ -86,7 +86,7 @@ def kotlin_version = getExtOrDefault("kotlinVersion")
 dependencies {
   implementation "com.facebook.react:react-android"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation("ai.doorstep.com:doorstepai-dropoff-sdk:1.0.0")
+  implementation("ai.doorstep.com:doorstepai-dropoff-sdk:1.0.1")
   api "org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1"
 }
 

package/android/src/main/java/com/doorstepai/dropoffsdk/DoorstepAIModule.kt

@@ -8,6 +8,7 @@ import com.facebook.react.bridge.ReactMethod
 import com.facebook.react.bridge.Promise
 import com.doorstepai.sdks.tracking.DoorstepAI
 import com.doorstepai.sdks.tracking.AddressType
+import com.facebook.react.bridge.ReadableMap
 
 class DoorstepAIModule(private val reactContext: ReactApplicationContext) :
   ReactContextBaseJavaModule(reactContext) {
@@ -32,57 +33,61 @@ class DoorstepAIModule(private val reactContext: ReactApplicationContext) :
   }
 
   @ReactMethod
-  fun startDeliveryByPlaceID(placeID: String, promise: Promise) {
+  fun startDeliveryByPlaceID(placeID: String, deliveryId: String, promise: Promise) {
     try {
-      DoorstepAI.startDeliveryByPlaceID(placeID) { result ->
-        result.onSuccess {
-          promise.resolve(true)
+      DoorstepAI.startDeliveryByPlaceID(placeID, deliveryId) { result ->
+        result.onSuccess { sessionId ->
+          promise.resolve(sessionId)
         }.onFailure { error ->
-          promise.reject("DELIVERY_ERROR", error.message ?: "Promise Rejection: Failed to start delivery")
+          promise.reject("DELIVERY_ERROR", error.message ?: "Promise Rejection: Failed to start delivery by Place ID")
         }
       }
     } catch (e: Exception) {
-      promise.reject("DELIVERY_ERROR", e.message ?: "Failed to start delivery")
+      promise.reject("DELIVERY_ERROR", e.message ?: "Failed to start delivery by Place ID")
     }
   }
 
   @ReactMethod
-  fun startDeliveryByPlusCode(plusCode: String, promise: Promise) {
+  fun startDeliveryByPlusCode(plusCode: String, deliveryId: String, promise: Promise) {
     try {
-      DoorstepAI.startDeliveryByPlusCode(plusCode) { result ->
-        result.onSuccess {
-          promise.resolve(true)
+      DoorstepAI.startDeliveryByPlusCode(plusCode, deliveryId) { result ->
+        result.onSuccess { sessionId ->
+          promise.resolve(sessionId)
         }.onFailure { error ->
-          promise.reject("DELIVERY_ERROR", error.message ?: "Promise Rejection: Failed to start delivery")
+          promise.reject("DELIVERY_ERROR", error.message ?: "Promise Rejection: Failed to start delivery by Plus Code")
         }
       }
     } catch (e: Exception) {
-      promise.reject("DELIVERY_ERROR", e.message ?: "Failed to start delivery")
+      promise.reject("DELIVERY_ERROR", e.message ?: "Failed to start delivery by Plus Code")
     }
   }
 
   @ReactMethod
   fun startDeliveryByAddress(
-    streetNumber: String,
-    route: String,
-    locality: String,
-    administrativeAreaLevel1: String,
-    postalCode: String,
-    subPremise: String,
+    addressMap: ReadableMap,
+    deliveryId: String,
     promise: Promise
   ) {
     try {
+      val streetNumber = addressMap.getString("streetNumber") ?: ""
+      val route = addressMap.getString("route") ?: ""
+      val subPremise = addressMap.getString("subPremise") ?: ""
+      val locality = addressMap.getString("locality") ?: ""
+      val administrativeAreaLevel1 = addressMap.getString("administrativeAreaLevel1") ?: ""
+      val postalCode = addressMap.getString("postalCode") ?: ""
+
       val address = AddressType(
         streetNumber = streetNumber,
         route = route,
+        subPremise = subPremise,
         locality = locality,
         administrativeAreaLevel1 = administrativeAreaLevel1,
-        postalCode = postalCode,
-        subPremise = subPremise
+        postalCode = postalCode
       )
-      DoorstepAI.startDeliveryByAddressType(address) { result ->
-        result.onSuccess {
-          promise.resolve(true)
+
+      DoorstepAI.startDeliveryByAddressType(address, deliveryId) { result ->
+        result.onSuccess { sessionId ->
+          promise.resolve(sessionId)
         }.onFailure { error ->
           promise.reject("DELIVERY_ERROR", error.message ?: "Promise Rejection: Failed to start delivery by address")
         }
@@ -93,27 +98,27 @@ class DoorstepAIModule(private val reactContext: ReactApplicationContext) :
   }
 
   @ReactMethod
-  fun newEvent(eventName: String, promise: Promise) {
+  fun newEvent(eventName: String, deliveryId: String, promise: Promise) {
     try {
-      DoorstepAI.newEvent(eventName) { result ->
-        result.onSuccess {
-          promise.resolve(true)
+      DoorstepAI.newEvent(eventName, deliveryId) { result ->
+        result.onSuccess { eventResponse ->
+          promise.resolve(eventResponse)
         }.onFailure { error ->
-          promise.reject("EVENT CREATION ERROR", error.message ?: "Promise Rejection: Failed to save event")
+          promise.reject("EVENT_CREATION_ERROR", error.message ?: "Promise Rejection: Failed to save event")
         }
       }
     } catch (e: Exception) {
-      promise.reject("EVENT CREATION ERROR", e.message ?: "Failed to save event")
+      promise.reject("EVENT_CREATION_ERROR", e.message ?: "Failed to save event")
     }
   }
 
   @ReactMethod
-  fun stopDelivery(promise: Promise) {
+  fun stopDelivery(deliveryId: String, promise: Promise) {
     try {
-      DoorstepAI.stopDelivery()
+      DoorstepAI.stopDelivery(deliveryId)
       promise.resolve(true)
     } catch (e: Exception) {
-      promise.reject("DELIVERY STOP", e.message ?: "Failed to stop delivery")
+      promise.reject("DELIVERY_STOP_ERROR", e.message ?: "Failed to stop delivery")
     }
   }
 
@@ -122,6 +127,11 @@ class DoorstepAIModule(private val reactContext: ReactApplicationContext) :
     DoorstepAI.setAPIKey(key)
   }
 
+  @ReactMethod
+  fun setDevMode(devModeEnabled: Boolean) {
+    DoorstepAI.devMode = devModeEnabled
+  }
+
   companion object {
     const val NAME = "DoorstepAI"
   }

package/ios/DoorstepAI.mm

@@ -3,19 +3,25 @@
 @interface RCT_EXTERN_MODULE(DoorstepAI, NSObject)
 
 RCT_EXTERN_METHOD(setApiKey:(NSString *)apiKey)
+RCT_EXTERN_METHOD(setDevMode:(BOOL)devModeEnabled)
 RCT_EXTERN_METHOD(startDeliveryByPlaceID:(NSString *)placeID
+                 deliveryId:(NSString *)deliveryId
                  resolver:(RCTPromiseResolveBlock)resolve
                  rejecter:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(startDeliveryByPlusCode:(NSString *)plusCode
+                 deliveryId:(NSString *)deliveryId
                  resolver:(RCTPromiseResolveBlock)resolve
                  rejecter:(RCTPromiseRejectBlock)reject)
-RCT_EXTERN_METHOD(startDeliveryByAddress:(NSString *)addressJSON
+RCT_EXTERN_METHOD(startDeliveryByAddress:(NSDictionary *)address
+                 deliveryId:(NSString *)deliveryId
                  resolver:(RCTPromiseResolveBlock)resolve
                  rejecter:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(newEvent:(NSString *)eventName
+                 deliveryId:(NSString *)deliveryId
                  resolver:(RCTPromiseResolveBlock)resolve
                  rejecter:(RCTPromiseRejectBlock)reject)
-RCT_EXTERN_METHOD(stopDelivery:(RCTPromiseResolveBlock)resolve
+RCT_EXTERN_METHOD(stopDelivery:(NSString *)deliveryId
+                 resolver:(RCTPromiseResolveBlock)resolve
                  rejecter:(RCTPromiseRejectBlock)reject)
 
 @end 

package/ios/DoorstepAI.swift

@@ -10,6 +10,11 @@ class DoorstepAIBridge: NSObject {
     return true
   }
 
+  @objc
+  func setDevMode(_ devModeEnabled: Bool) {
+    DoorstepAI.devMode = devModeEnabled
+  }
+
   @objc
   func setApiKey(_ apiKey: String) {
     DoorstepAI.setApiKey(key: apiKey)
@@ -17,12 +22,13 @@ class DoorstepAIBridge: NSObject {
 
   @objc
   func startDeliveryByPlaceID(_ placeID: NSString,
+                              deliveryId: NSString,
                               resolver resolve: @escaping RCTPromiseResolveBlock,
                               rejecter reject: @escaping RCTPromiseRejectBlock) {
     // Use Swift's concurrency support to call the async method.
     Task {
       do {
-        try await DoorstepAI.startDeliveryByPlaceID(placeID: placeID as String)
+        try await DoorstepAI.startDeliveryByPlaceID(placeID: placeID as String, deliveryId: deliveryId as String)
         resolve(nil)
       } catch {
         reject("E_START_DELIVERY", "Failed to start delivery by Place ID: \(error.localizedDescription)", error)
@@ -32,11 +38,12 @@ class DoorstepAIBridge: NSObject {
 
   @objc
   func startDeliveryByPlusCode(_ plusCode: NSString,
+                               deliveryId: NSString,
                                resolver resolve: @escaping RCTPromiseResolveBlock,
                                rejecter reject: @escaping RCTPromiseRejectBlock) {
     Task {
       do {
-        try await DoorstepAI.startDeliveryByPlusCode(plusCode: plusCode as String)
+        try await DoorstepAI.startDeliveryByPlusCode(plusCode: plusCode as String, deliveryId: deliveryId as String)
         resolve(nil)
       } catch {
         reject("E_START_DELIVERY", "Failed to start delivery by Plus Code: \(error.localizedDescription)", error)
@@ -45,51 +52,48 @@ class DoorstepAIBridge: NSObject {
                                }
 
      @objc
-  func startDeliveryByAddress(_ addressJSON: NSString,
+  func startDeliveryByAddress(_ address: [String: Any],
+                              deliveryId: NSString,
                               resolver resolve: @escaping RCTPromiseResolveBlock,
                               rejecter reject: @escaping RCTPromiseRejectBlock) {
-      guard let data = (addressJSON as String).data(using: .utf8) else {
-          reject("E_INVALID_ADDRESS", "Invalid JSON string format.", nil)
-          return
-      }
-
       Task {
+        print("Starting delivery by address: \(address)")
         do {
-            guard let jsonObject = try JSONSerialization.jsonObject(with: data, options: []) as? [String: Any],
-                  let streetNumber = jsonObject["streetNumber"] as? String,
-                  let route = jsonObject["route"] as? String,
-                  let subPremise = jsonObject["subPremise"] as? String,
-                  let locality = jsonObject["locality"] as? String,
-                  let administrativeAreaLevel1 = jsonObject["administrativeAreaLevel1"] as? String,
-                  let postalCode = jsonObject["postalCode"] as? String else {
-                reject("E_INVALID_ADDRESS", "Missing or invalid fields in address JSON.", nil)
+            guard let streetNumber = address["streetNumber"] as? String,
+                  let route = address["route"] as? String,
+                  let subPremise = address["subPremise"] as? String,
+                  let locality = address["locality"] as? String,
+                  let administrativeAreaLevel1 = address["administrativeAreaLevel1"] as? String,
+                  let postalCode = address["postalCode"] as? String else {
+                reject("E_INVALID_ADDRESS", "Missing or invalid fields in address dictionary.", nil)
                 return
             }
 
-            let address = AddressType(streetNumber: streetNumber,
+            let addressStruct = AddressType(streetNumber: streetNumber,
                                         route: route,
                                         subPremise: subPremise,
                                         locality: locality,
                                         administrativeAreaLevel1: administrativeAreaLevel1,
                                         postalCode: postalCode)
 
-            try await DoorstepAI.startDeliveryByAddressType(address: address)
+            try await DoorstepAI.startDeliveryByAddressType(address: addressStruct, deliveryId: deliveryId as String)
             resolve(nil)
         } catch let error as DoorstepAIError {
              reject("E_START_DELIVERY", "Failed to start delivery by address: \(error.localizedDescription)", error)
         } catch {
-            reject("E_JSON_PARSING", "Failed to parse address JSON: \(error.localizedDescription)", error)
+            reject("E_UNKNOWN", "An unexpected error occurred: \(error.localizedDescription)", error)
         }
       }
   }
 
   @objc
   func newEvent(_ eventName: NSString,
+                deliveryId: NSString,
                 resolver resolve: @escaping RCTPromiseResolveBlock,
                 rejecter reject: @escaping RCTPromiseRejectBlock) {
       Task {
           do {
-              try await DoorstepAI.newEvent(eventName: eventName as String)
+              try await DoorstepAI.newEvent(eventName: eventName as String, deliveryId: deliveryId as String)
               resolve(nil)
           } catch {
               reject("E_NEW_EVENT", "Failed to send event: \(error.localizedDescription)", error)
@@ -98,11 +102,12 @@ class DoorstepAIBridge: NSObject {
   }
 
   @objc
-  func stopDelivery(_ resolve: @escaping RCTPromiseResolveBlock,
+  func stopDelivery(_ deliveryId: NSString,
+                    resolver resolve: @escaping RCTPromiseResolveBlock,
                     rejecter reject: @escaping RCTPromiseRejectBlock) {
     Task {
       // stopDelivery does not throw so we simply await its completion
-      await DoorstepAI.stopDelivery()
+      await DoorstepAI.stopDelivery(deliveryId: deliveryId as String)
       resolve(nil)
     }
   }