@doorstepai/dropoff-sdk-capacitor 1.0.1 → 1.0.3

package/android/build.gradle

@@ -43,6 +43,6 @@ dependencies {
     implementation "com.capacitorjs:core:$capacitorAndroidVersion"
     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3"
     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3"
-    implementation "ai.doorstep.com:doorstepai-dropoff-sdk:2.0.9"
+    implementation "ai.doorstep.com:doorstepai-dropoff-sdk:2.1.0"
     testImplementation "org.junit.jupiter:junit-jupiter-api:5.10.0"
 }

package/android/src/main/java/ai/doorstep/dropoffsdk/capacitor/DoorstepAIDropoffSDKPlugin.kt

@@ -2,6 +2,7 @@ package ai.doorstep.dropoffsdk.capacitor
 
 import android.Manifest
 import android.util.Log
+import com.getcapacitor.JSArray
 import com.getcapacitor.JSObject
 import com.getcapacitor.Plugin
 import com.getcapacitor.PluginCall
@@ -13,13 +14,17 @@ import com.doorstepai.sdks.tracking.AddressType
 import com.doorstepai.sdks.tracking.DoorstepAI
 import com.doorstepai.sdks.tracking.DropoffType
 import com.doorstepai.sdks.tracking.LatLngObject
+import com.doorstepai.sdks.tracking.DeliveryStop
+import com.doorstepai.sdks.tracking.RouteGeofenceOptions
 
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
+import kotlinx.coroutines.flow.collect
 
 @CapacitorPlugin(
     name = "DoorstepAIDropoffSDK",
@@ -35,15 +40,35 @@ import kotlinx.coroutines.withContext
             alias = "activity",
             strings = [Manifest.permission.ACTIVITY_RECOGNITION],
         ),
+        // Bluetooth (BLE) — opt-in; request explicitly via
+        // requestPermissions({ permissions: ['bluetooth'] }). BLUETOOTH_SCAN is
+        // declared by the SDK manifest (merged). API 31+; a no-op below S.
+        Permission(
+            alias = "bluetooth",
+            strings = [Manifest.permission.BLUETOOTH_SCAN],
+        ),
     ],
 )
 class DoorstepAIDropoffSDKPlugin : Plugin() {
 
     private val scope = CoroutineScope(SupervisorJob() + Dispatchers.Main.immediate)
+    private var geofenceJob: Job? = null
 
     override fun load() {
         super.load()
         Log.d(TAG, "load(): plugin attached, ready for calls")
+        // Stream native geofence-session events onto the "geofenceSessionEvent" listener.
+        geofenceJob = scope.launch {
+            DoorstepAI.geofenceSessionEvents.collect { ev ->
+                notifyListeners(
+                    "geofenceSessionEvent",
+                    JSObject()
+                        .put("deliveryId", ev.deliveryId)
+                        .put("type", ev.type.name)
+                        .put("reason", ev.reason)
+                )
+            }
+        }
     }
 
     override fun handleOnDestroy() {
@@ -107,7 +132,8 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val timeoutSeconds = call.getDouble("timeoutSeconds")
         val customerId = call.getString("customerId")
         val autoStopAfterDropoffSeconds = call.getDouble("autoStopAfterDropoffSeconds")
-        Log.d(TAG, "startDeliveryByPlaceID: placeID=$placeID deliveryId=$deliveryId timeout=$timeoutSeconds customerId=$customerId autoStop=$autoStopAfterDropoffSeconds")
+        val manualForeground = call.getBoolean("manualForeground", false) ?: false
+        Log.d(TAG, "startDeliveryByPlaceID: placeID=$placeID deliveryId=$deliveryId timeout=$timeoutSeconds customerId=$customerId autoStop=$autoStopAfterDropoffSeconds manualForeground=$manualForeground")
         if (placeID == null || deliveryId == null) {
             return call.reject("placeID or deliveryId missing", "BAD_ARGS")
         }
@@ -118,6 +144,7 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
                 timeoutSeconds = timeoutSeconds,
                 autoStopAfterDropoffSeconds = autoStopAfterDropoffSeconds,
                 customerId = customerId,
+                manualForeground = manualForeground,
             ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
@@ -169,6 +196,7 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val timeoutSeconds = call.getDouble("timeoutSeconds")
         val customerId = call.getString("customerId")
         val autoStopAfterDropoffSeconds = call.getDouble("autoStopAfterDropoffSeconds")
+        val manualForeground = call.getBoolean("manualForeground", false) ?: false
         val coordinates = parseCoordinates(call.getObject("coordinates"))
 
         if (addrObj == null
@@ -198,6 +226,7 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
                 timeoutSeconds = timeoutSeconds,
                 autoStopAfterDropoffSeconds = autoStopAfterDropoffSeconds,
                 customerId = customerId,
+                manualForeground = manualForeground,
             ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
@@ -216,6 +245,7 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val timeoutSeconds = call.getDouble("timeoutSeconds")
         val customerId = call.getString("customerId")
         val autoStopAfterDropoffSeconds = call.getDouble("autoStopAfterDropoffSeconds")
+        val manualForeground = call.getBoolean("manualForeground", false) ?: false
         val coordinates = parseCoordinates(call.getObject("coordinates"))
         if (address == null || deliveryId == null) {
             return call.reject("address or deliveryId missing", "BAD_ARGS")
@@ -228,6 +258,7 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
                 timeoutSeconds = timeoutSeconds,
                 autoStopAfterDropoffSeconds = autoStopAfterDropoffSeconds,
                 customerId = customerId,
+                manualForeground = manualForeground,
             ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
@@ -301,12 +332,13 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
     fun newEvent(call: PluginCall) {
         val eventName = call.getString("eventName")
         val deliveryId = call.getString("deliveryId")
+        val timestamp = call.getDouble("timestamp")
         Log.d(TAG, "newEvent: eventName=$eventName deliveryId=$deliveryId")
         if (eventName == null || deliveryId == null) {
             return call.reject("eventName or deliveryId missing", "BAD_ARGS")
         }
         try {
-            DoorstepAI.newEvent(eventName, deliveryId) { /* result swallowed in Flutter parity */ }
+            DoorstepAI.newEvent(eventName, deliveryId, timestamp) { /* fire-and-forget */ }
             call.resolve()
         } catch (e: Exception) {
             call.reject(e.message ?: "Failed to save event", "EVENT_CREATION_ERROR")
@@ -332,4 +364,110 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         if (lat.isNaN() || lng.isNaN()) return null
         return LatLngObject(lat = lat, lng = lng)
     }
+
+    // ---- Route geofencing ----
+
+    @PluginMethod
+    fun startRouteGeofencing(call: PluginCall) {
+        val stops = parseStops(call.getArray("stops"))
+        if (stops.isEmpty()) {
+            return call.reject("startRouteGeofencing requires at least one valid stop (deliveryId + latitude + longitude)", "ROUTE_GEOFENCING_ERROR")
+        }
+        try {
+            DoorstepAI.startRouteGeofencing(stops, parseRouteOptions(call.getObject("options"))) { r ->
+                r.onSuccess { call.resolve() }
+                    .onFailure { call.reject(it.message ?: "Failed to start route geofencing", "ROUTE_GEOFENCING_ERROR") }
+            }
+        } catch (e: Exception) {
+            call.reject(e.message ?: "Failed to start route geofencing", "ROUTE_GEOFENCING_ERROR")
+        }
+    }
+
+    @PluginMethod
+    fun updateRouteStops(call: PluginCall) {
+        try {
+            DoorstepAI.updateRouteStops(parseStops(call.getArray("stops"))) { r ->
+                r.onSuccess { call.resolve() }
+                    .onFailure { call.reject(it.message ?: "Failed to update route stops", "ROUTE_GEOFENCING_ERROR") }
+            }
+        } catch (e: Exception) {
+            call.reject(e.message ?: "Failed to update route stops", "ROUTE_GEOFENCING_ERROR")
+        }
+    }
+
+    @PluginMethod
+    fun stopRouteGeofencing(call: PluginCall) {
+        try {
+            DoorstepAI.stopRouteGeofencing()
+            call.resolve()
+        } catch (e: Exception) {
+            call.reject(e.message ?: "Failed to stop route geofencing", "ROUTE_GEOFENCING_ERROR")
+        }
+    }
+
+    @PluginMethod
+    fun resumeRouteGeofencingIfNeeded(call: PluginCall) {
+        try {
+            DoorstepAI.resumeRouteGeofencingIfNeeded()
+            call.resolve()
+        } catch (e: Exception) {
+            call.reject(e.message ?: "Failed to resume route geofencing", "ROUTE_GEOFENCING_ERROR")
+        }
+    }
+
+    @PluginMethod
+    fun getMonitoredStops(call: PluginCall) {
+        try {
+            val arr = JSArray()
+            DoorstepAI.monitoredStops.forEach { arr.put(serializeStop(it)) }
+            call.resolve(JSObject().put("stops", arr))
+        } catch (e: Exception) {
+            call.reject(e.message ?: "Failed to get monitored stops", "ROUTE_GEOFENCING_ERROR")
+        }
+    }
+
+    private fun parseStops(arr: JSArray?): List<DeliveryStop> {
+        if (arr == null) return emptyList()
+        val out = ArrayList<DeliveryStop>()
+        for (i in 0 until arr.length()) {
+            val m = arr.optJSONObject(i) ?: continue
+            val deliveryId = m.optString("deliveryId", "")
+            if (deliveryId.isEmpty() || !m.has("latitude") || !m.has("longitude")) continue
+            out.add(
+                DeliveryStop(
+                    deliveryId = deliveryId,
+                    address = m.optString("address", ""),
+                    latitude = m.optDouble("latitude"),
+                    longitude = m.optDouble("longitude"),
+                    radiusMeters = if (m.has("radiusMeters")) m.optDouble("radiusMeters") else null,
+                    customerId = if (m.has("customerId")) m.optString("customerId") else null,
+                    driverId = if (m.has("driverId")) m.optString("driverId") else null,
+                ),
+            )
+        }
+        return out
+    }
+
+    // Android RouteGeofenceOptions carries manualForeground (unlike iOS).
+    private fun parseRouteOptions(o: JSObject?): RouteGeofenceOptions {
+        if (o == null) return RouteGeofenceOptions()
+        return RouteGeofenceOptions(
+            defaultRadiusMeters = if (o.has("defaultRadiusMeters")) o.optDouble("defaultRadiusMeters", 250.0) else 250.0,
+            timeoutSeconds = if (o.has("timeoutSeconds")) o.optDouble("timeoutSeconds") else null,
+            autoStopAfterDropoffSeconds = if (o.has("autoStopAfterDropoffSeconds")) o.optDouble("autoStopAfterDropoffSeconds") else null,
+            manualForeground = o.optBoolean("manualForeground", false),
+        )
+    }
+
+    private fun serializeStop(s: DeliveryStop): JSObject {
+        val o = JSObject()
+        o.put("deliveryId", s.deliveryId)
+        o.put("address", s.address)
+        o.put("latitude", s.latitude)
+        o.put("longitude", s.longitude)
+        s.radiusMeters?.let { o.put("radiusMeters", it) }
+        s.customerId?.let { o.put("customerId", it) }
+        s.driverId?.let { o.put("driverId", it) }
+        return o
+    }
 }

package/dist/docs.json

@@ -203,6 +203,109 @@
         ],
         "slug": "stopdelivery"
       },
+      {
+        "name": "startRouteGeofencing",
+        "signature": "(options: { stops: DeliveryStop[]; options?: RouteGeofenceOptions; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ stops: DeliveryStop[]; options?: RouteGeofenceOptions | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Start route geofencing. ENTER auto-starts a session; EXIT stops it only if a\ndropoff was marked (else the per-session timeout backstops it). Subscribe to\nsession lifecycle via `addListener('geofenceSessionEvent', ...)`.",
+        "complexTypes": [
+          "DeliveryStop",
+          "RouteGeofenceOptions"
+        ],
+        "slug": "startroutegeofencing"
+      },
+      {
+        "name": "updateRouteStops",
+        "signature": "(options: { stops: DeliveryStop[]; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ stops: DeliveryStop[]; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Replace the monitored stops in place without tearing down still-present stops.",
+        "complexTypes": [
+          "DeliveryStop"
+        ],
+        "slug": "updateroutestops"
+      },
+      {
+        "name": "stopRouteGeofencing",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Stop route geofencing and clear all monitored stops.",
+        "complexTypes": [],
+        "slug": "stoproutegeofencing"
+      },
+      {
+        "name": "resumeRouteGeofencingIfNeeded",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Re-arm route geofencing after a process relaunch if a route was active.",
+        "complexTypes": [],
+        "slug": "resumeroutegeofencingifneeded"
+      },
+      {
+        "name": "getMonitoredStops",
+        "signature": "() => Promise<{ stops: DeliveryStop[]; }>",
+        "parameters": [],
+        "returns": "Promise<{ stops: DeliveryStop[]; }>",
+        "tags": [],
+        "docs": "The stops currently registered for route geofencing (empty if none).",
+        "complexTypes": [
+          "DeliveryStop"
+        ],
+        "slug": "getmonitoredstops"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'geofenceSessionEvent', listenerFunc: (event: GeofenceSessionEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'geofenceSessionEvent'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: GeofenceSessionEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Subscribe to route-geofence session STARTED/STOPPED events.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "GeofenceSessionEvent"
+        ],
+        "slug": "addlistenergeofencesessionevent-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Remove all listeners registered for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      },
       {
         "name": "checkPermissions",
         "signature": "() => Promise<PermissionStatus>",
@@ -615,6 +718,13 @@
           "docs": "",
           "complexTypes": [],
           "type": "string"
+        },
+        {
+          "name": "timestamp",
+          "tags": [],
+          "docs": "Epoch seconds; if omitted the SDK stamps the current time.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -634,6 +744,149 @@
         }
       ]
     },
+    {
+      "name": "DeliveryStop",
+      "slug": "deliverystop",
+      "docs": "A stop monitored for route geofencing. Mirrors the native `DeliveryStop`.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "address",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "latitude",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "longitude",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "radiusMeters",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "customerId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "driverId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "RouteGeofenceOptions",
+      "slug": "routegeofenceoptions",
+      "docs": "Options for {@link DoorstepAIDropoffSDKPlugin.startRouteGeofencing}.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "defaultRadiusMeters",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "timeoutSeconds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "autoStopAfterDropoffSeconds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "manualForeground",
+          "tags": [],
+          "docs": "Android only; ignored on iOS (the OS owns background region monitoring).",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "GeofenceSessionEvent",
+      "slug": "geofencesessionevent",
+      "docs": "Payload delivered to the `'geofenceSessionEvent'` listener.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "GeofenceSessionEventType"
+          ],
+          "type": "GeofenceSessionEventType"
+        },
+        {
+          "name": "reason",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
     {
       "name": "PermissionStatus",
       "slug": "permissionstatus",
@@ -658,6 +911,15 @@
             "PermissionState"
           ],
           "type": "PermissionState"
+        },
+        {
+          "name": "bluetooth",
+          "tags": [],
+          "docs": "Bluetooth, needed only for BLE collection (off unless server-enabled).\nAndroid: `BLUETOOTH_SCAN` (API 31+). iOS: `NSBluetoothAlwaysUsageDescription`.\nOpt-in: NOT requested by a no-argument `requestPermissions()` — pass it\nexplicitly (`requestPermissions({ permissions: ['bluetooth'] })`).",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
         }
       ]
     },
@@ -671,7 +933,7 @@
         {
           "name": "permissions",
           "tags": [],
-          "docs": "If omitted, requests all permissions.",
+          "docs": "Which permissions to request. If omitted, requests the default set\n(location + activity) — Bluetooth is opt-in and must be listed explicitly.",
           "complexTypes": [
             "DoorstepPermissionType"
           ],
@@ -697,6 +959,21 @@
         }
       ]
     },
+    {
+      "name": "GeofenceSessionEventType",
+      "slug": "geofencesessioneventtype",
+      "docs": "",
+      "types": [
+        {
+          "text": "'STARTED'",
+          "complexTypes": []
+        },
+        {
+          "text": "'STOPPED'",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "PermissionState",
       "slug": "permissionstate",
@@ -732,6 +1009,10 @@
         {
           "text": "'activity'",
           "complexTypes": []
+        },
+        {
+          "text": "'bluetooth'",
+          "complexTypes": []
         }
       ]
     }