@doorstepai/dropoff-sdk-capacitor 1.0.0 → 1.0.2

package/README.md

@@ -131,9 +131,36 @@ await DoorstepAIDropoffSDK.startDeliveryByLatLng({
 });
 ```
 
-> All `startDelivery*` methods accept an optional `timeoutSeconds` to bound the
-> destination resolution step. The address-based methods also accept an optional
+> **Shared optional fields** — every `startDelivery*` method also accepts:
+>
+> - `customerId?: string` — your identifier for the customer on this delivery.
+> - `autoStopAfterDropoffSeconds?: number` — auto-stops tracking the given
+>   number of seconds after `markDropoff` is called. If omitted, the SDK falls
+>   back to zero seconds, effectively no timeout.
+>   _On Android this is honored by `startDeliveryByPlaceID`,
+>   `startDeliveryByAddress(String)` and `startDeliveryByAddressType`; the
+>   (deprecated) `startDeliveryByPlusCode` and `startDeliveryByLatLng` methods
+>   ignore it. iOS honors it everywhere._
+> - `timeoutSeconds?: number` — auto-stops tracking after the given duration, as
+>   a backstop in case an exit geofence is missed.
+>
+> The address-based methods additionally accept an optional
 > `coordinates: { lat, lng }` hint to skip geocoding when you already have it.
+>
+> ```ts
+> await DoorstepAIDropoffSDK.startDeliveryByAddress({
+>   address: {
+>     streetNumber: '123',
+>     route: 'Main St',
+>     locality: 'New York',
+>     administrativeAreaLevel1: 'NY',
+>     postalCode: '10001',
+>   },
+>   deliveryId: 'unique_delivery_id',
+>   customerId: 'customer_42',        // optional
+>   autoStopAfterDropoffSeconds: 120, // optional
+> });
+> ```
 
 ### `newEvent`
 

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.6"
+    implementation "ai.doorstep.com:doorstepai-dropoff-sdk:2.0.9"
     testImplementation "org.junit.jupiter:junit-jupiter-api:5.10.0"
 }

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

@@ -105,12 +105,22 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val placeID = call.getString("placeID")
         val deliveryId = call.getString("deliveryId")
         val timeoutSeconds = call.getDouble("timeoutSeconds")
-        Log.d(TAG, "startDeliveryByPlaceID: placeID=$placeID deliveryId=$deliveryId timeout=$timeoutSeconds")
+        val customerId = call.getString("customerId")
+        val autoStopAfterDropoffSeconds = call.getDouble("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")
         }
         try {
-            DoorstepAI.startDeliveryByPlaceID(placeID, deliveryId, timeoutSeconds) { sdkResult ->
+            DoorstepAI.startDeliveryByPlaceID(
+                placeID = placeID,
+                deliveryId = deliveryId,
+                timeoutSeconds = timeoutSeconds,
+                autoStopAfterDropoffSeconds = autoStopAfterDropoffSeconds,
+                customerId = customerId,
+                manualForeground = manualForeground,
+            ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
                         call.reject(error.message ?: "Failed to start delivery by Place ID", "DELIVERY_ERROR")
@@ -126,11 +136,19 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val plusCode = call.getString("plusCode")
         val deliveryId = call.getString("deliveryId")
         val timeoutSeconds = call.getDouble("timeoutSeconds")
+        val customerId = call.getString("customerId")
+        // Note: the Android SDK's Plus Code method does not accept
+        // autoStopAfterDropoffSeconds, so it is intentionally not forwarded here.
         if (plusCode == null || deliveryId == null) {
             return call.reject("plusCode or deliveryId missing", "BAD_ARGS")
         }
         try {
-            DoorstepAI.startDeliveryByPlusCode(plusCode, deliveryId, timeoutSeconds) { sdkResult ->
+            DoorstepAI.startDeliveryByPlusCode(
+                plusCode = plusCode,
+                deliveryId = deliveryId,
+                timeoutSeconds = timeoutSeconds,
+                customerId = customerId,
+            ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
                         call.reject(error.message ?: "Failed to start delivery by Plus Code", "DELIVERY_ERROR")
@@ -151,6 +169,9 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val addrObj = call.getObject("address")
         val deliveryId = call.getString("deliveryId")
         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
@@ -173,7 +194,15 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
                 administrativeAreaLevel1 = addrObj.getString("administrativeAreaLevel1")!!,
                 postalCode = addrObj.getString("postalCode")!!,
             )
-            DoorstepAI.startDeliveryByAddressType(addressType, deliveryId, coordinates, timeoutSeconds) { sdkResult ->
+            DoorstepAI.startDeliveryByAddressType(
+                address = addressType,
+                deliveryId = deliveryId,
+                coordinates = coordinates,
+                timeoutSeconds = timeoutSeconds,
+                autoStopAfterDropoffSeconds = autoStopAfterDropoffSeconds,
+                customerId = customerId,
+                manualForeground = manualForeground,
+            ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
                         call.reject(error.message ?: "Failed to start delivery by address", "DELIVERY_ERROR")
@@ -189,12 +218,23 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val address = call.getString("address")
         val deliveryId = call.getString("deliveryId")
         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")
         }
         try {
-            DoorstepAI.startDeliveryByAddressString(address, deliveryId, coordinates, timeoutSeconds) { sdkResult ->
+            DoorstepAI.startDeliveryByAddressString(
+                address = address,
+                deliveryId = deliveryId,
+                coordinates = coordinates,
+                timeoutSeconds = timeoutSeconds,
+                autoStopAfterDropoffSeconds = autoStopAfterDropoffSeconds,
+                customerId = customerId,
+                manualForeground = manualForeground,
+            ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
                         call.reject(error.message ?: "Failed to start delivery by address string", "DELIVERY_ERROR")
@@ -212,12 +252,22 @@ class DoorstepAIDropoffSDKPlugin : Plugin() {
         val subUnit = call.getString("subUnit") ?: ""
         val deliveryId = call.getString("deliveryId")
         val timeoutSeconds = call.getDouble("timeoutSeconds")
-        Log.d(TAG, "startDeliveryByLatLng: lat=$latitude lng=$longitude subUnit='$subUnit' deliveryId=$deliveryId timeout=$timeoutSeconds")
+        val customerId = call.getString("customerId")
+        // Note: the Android SDK's LatLng method does not accept
+        // autoStopAfterDropoffSeconds, so it is intentionally not forwarded here.
+        Log.d(TAG, "startDeliveryByLatLng: lat=$latitude lng=$longitude subUnit='$subUnit' deliveryId=$deliveryId timeout=$timeoutSeconds customerId=$customerId")
         if (latitude == null || longitude == null || deliveryId == null) {
             return call.reject("latitude, longitude or deliveryId missing", "BAD_ARGS")
         }
         try {
-            DoorstepAI.startDeliveryByLatLng(latitude, longitude, subUnit, deliveryId, timeoutSeconds) { sdkResult ->
+            DoorstepAI.startDeliveryByLatLng(
+                latitude = latitude,
+                longitude = longitude,
+                subUnit = subUnit,
+                deliveryId = deliveryId,
+                timeoutSeconds = timeoutSeconds,
+                customerId = customerId,
+            ) { sdkResult ->
                 sdkResult.onSuccess { call.resolve() }
                     .onFailure { error ->
                         call.reject(error.message ?: "Failed to start delivery by LatLng", "DELIVERY_ERROR")

package/dist/docs.json

@@ -304,6 +304,13 @@
           "docs": "",
           "complexTypes": [],
           "type": "number | undefined"
+        },
+        {
+          "name": "autoStopAfterDropoffSeconds",
+          "tags": [],
+          "docs": "Auto-stop the delivery this many seconds after a dropoff is detected.\nOptional; if omitted the SDK's remote config value applies.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -334,6 +341,13 @@
           "docs": "",
           "complexTypes": [],
           "type": "number | undefined"
+        },
+        {
+          "name": "autoStopAfterDropoffSeconds",
+          "tags": [],
+          "docs": "Auto-stop the delivery this many seconds after a dropoff is detected.\niOS only — the Android SDK does not accept this on the (deprecated)\nPlus Code method, where it is ignored.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -375,6 +389,13 @@
           "docs": "",
           "complexTypes": [],
           "type": "number | undefined"
+        },
+        {
+          "name": "autoStopAfterDropoffSeconds",
+          "tags": [],
+          "docs": "Auto-stop the delivery this many seconds after a dropoff is detected.\nOptional; if omitted the SDK's remote config value applies.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -488,6 +509,13 @@
           "docs": "",
           "complexTypes": [],
           "type": "number | undefined"
+        },
+        {
+          "name": "autoStopAfterDropoffSeconds",
+          "tags": [],
+          "docs": "Auto-stop the delivery this many seconds after a dropoff is detected.\nOptional; if omitted the SDK's remote config value applies.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -532,6 +560,13 @@
           "docs": "",
           "complexTypes": [],
           "type": "number | undefined"
+        },
+        {
+          "name": "autoStopAfterDropoffSeconds",
+          "tags": [],
+          "docs": "Auto-stop the delivery this many seconds after a dropoff is detected.\niOS only — the Android SDK does not accept this on the (deprecated)\nLatLng method, where it is ignored.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -30,35 +30,80 @@ export interface InitOptions {
 export interface SetApiKeyOptions {
     key: string;
 }
-export interface StartDeliveryByPlaceIDOptions {
+/**
+ * Optional caller-supplied identifier for the customer associated with the
+ * delivery. Forwarded verbatim to the native SDK. Optional on every platform.
+ */
+declare type CustomerIdOption = {
+    customerId?: string;
+};
+/**
+ * Android-only option shared by every `startDelivery*` method.
+ */
+declare type ManualForegroundOption = {
+    /**
+     * Android only: when `true`, the host app is responsible for its own
+     * foreground service/notification and the SDK will not start a second one.
+     * Ignored on iOS. Defaults to `false`.
+     */
+    manualForeground?: boolean;
+};
+export interface StartDeliveryByPlaceIDOptions extends CustomerIdOption, ManualForegroundOption {
     placeID: string;
     deliveryId: string;
     timeoutSeconds?: number;
+    /**
+     * Auto-stop the delivery this many seconds after a dropoff is detected.
+     * Optional; if omitted the SDK's remote config value applies.
+     */
+    autoStopAfterDropoffSeconds?: number;
 }
-export interface StartDeliveryByPlusCodeOptions {
+export interface StartDeliveryByPlusCodeOptions extends CustomerIdOption {
     plusCode: string;
     deliveryId: string;
     timeoutSeconds?: number;
+    /**
+     * Auto-stop the delivery this many seconds after a dropoff is detected.
+     * iOS only — the Android SDK does not accept this on the (deprecated)
+     * Plus Code method, where it is ignored.
+     */
+    autoStopAfterDropoffSeconds?: number;
 }
-export interface StartDeliveryByAddressOptions {
+export interface StartDeliveryByAddressOptions extends CustomerIdOption, ManualForegroundOption {
     address: AddressType;
     deliveryId: string;
     coordinates?: LatLngObject;
     timeoutSeconds?: number;
+    /**
+     * Auto-stop the delivery this many seconds after a dropoff is detected.
+     * Optional; if omitted the SDK's remote config value applies.
+     */
+    autoStopAfterDropoffSeconds?: number;
 }
-export interface StartDeliveryByAddressStringOptions {
+export interface StartDeliveryByAddressStringOptions extends CustomerIdOption, ManualForegroundOption {
     address: string;
     deliveryId: string;
     coordinates?: LatLngObject;
     timeoutSeconds?: number;
+    /**
+     * Auto-stop the delivery this many seconds after a dropoff is detected.
+     * Optional; if omitted the SDK's remote config value applies.
+     */
+    autoStopAfterDropoffSeconds?: number;
 }
-export interface StartDeliveryByLatLngOptions {
+export interface StartDeliveryByLatLngOptions extends CustomerIdOption {
     latitude: number;
     longitude: number;
     /** Apartment / unit. Optional, defaults to `""`. */
     subUnit?: string;
     deliveryId: string;
     timeoutSeconds?: number;
+    /**
+     * Auto-stop the delivery this many seconds after a dropoff is detected.
+     * iOS only — the Android SDK does not accept this on the (deprecated)
+     * LatLng method, where it is ignored.
+     */
+    autoStopAfterDropoffSeconds?: number;
 }
 export interface MarkDropoffOptions {
     deliveryId: string;
@@ -113,3 +158,4 @@ export interface DoorstepAIDropoffSDKPlugin {
      */
     requestPermissions(options?: PermissionRequestOptions): Promise<PermissionStatus>;
 }
+export {};