@doorstepai/dropoff-sdk 2.0.2 → 2.0.5

package/src/DoorstepAI.tsx

@@ -10,10 +10,56 @@ type AddressType = {
   postalCode: string;
 };
 
+type LatLngObject = {
+  lat: number;
+  lng: number;
+};
+
+/**
+ * Per-delivery options shared across both platforms. Fields not supported on a
+ * given platform are silently ignored.
+ */
+type StartDeliveryOptions = {
+  /**
+   * Hard upper bound on the delivery's tracking session in seconds. When the
+   * timer fires the SDK calls `stopDelivery` automatically. Defaults to 7200
+   * (2 hours) when not provided.
+   */
+  timeoutSeconds?: number;
+  /**
+   * Optional countdown (in seconds) to auto-stop the delivery once
+   * `markDropoff` is invoked. Survives backgrounding/process death on both
+   * platforms (UserDefaults on iOS, AlarmManager on Android).
+   */
+  autoStopAfterDropoffSeconds?: number;
+  /**
+   * Android only. When `true`, the SDK will NOT promote its internal
+   * tracking service to the foreground — it expects the host app to already
+   * be running its own foreground service that keeps the process alive.
+   * Ignored on iOS.
+   */
+  manualForeground?: boolean;
+};
+
+/**
+ * Mirrors the iOS SDK's `SDKLogLevel` enum. Only used by
+ * `configureRemoteLogging` (iOS only).
+ */
+type SDKLogLevel = 'debug' | 'info' | 'warning' | 'error' | 'critical';
+
+const SDK_LOG_LEVEL_RAW: Record<SDKLogLevel, number> = {
+  debug: 0,
+  info: 1,
+  warning: 2,
+  error: 3,
+  critical: 4,
+};
+
+const DEFAULT_TIMEOUT_SECONDS = 7200;
+
 class DoorstepAIModule {
   static isInitialized = false;
 
-
   static async init(
     notificationTitle?: string,
     notificationText?: string
@@ -25,7 +71,7 @@ class DoorstepAIModule {
       try {
         await DoorstepAI.init(notificationTitle, notificationText);
         console.log('DOORSTEPAI - DoorstepAI initialized');
-        this.isInitialized = true; // Mark as initialized on success
+        this.isInitialized = true;
       } catch (error) {
         console.error('DOORSTEPAI - Failed to initialize DoorstepAI:', error);
         throw error;
@@ -37,59 +83,154 @@ class DoorstepAIModule {
     DoorstepAI.setApiKey(apiKey);
   }
 
-  // Add deliveryId parameter
+  /**
+   * Triggers iOS Motion/Fitness + Location permission prompts up-front so the
+   * host app does not need to manage them itself. No-op on Android — use
+   * `PermissionsAndroid` (already wired into `RootDoorstepAI`).
+   */
+  static requestAllPermissions(requestAlwaysLocation: boolean = true) {
+    if (Platform.OS === 'ios') {
+      DoorstepAI.requestAllPermissions(requestAlwaysLocation);
+    }
+  }
+
+  /**
+   * Configures the iOS SDK's remote logging pipeline. No-op on Android (the
+   * Android SDK currently configures remote logging via remote config / dev
+   * mode rather than a public host-app entry point).
+   */
+  static configureRemoteLogging(options: {
+    enabled: boolean;
+    minLevel?: SDKLogLevel;
+    flushIntervalSeconds?: number;
+    batchSize?: number;
+    maxQueueSize?: number;
+  }) {
+    if (Platform.OS !== 'ios') return;
+    const minLevelRaw =
+      options.minLevel != null ? SDK_LOG_LEVEL_RAW[options.minLevel] : null;
+    DoorstepAI.configureRemoteLogging(
+      options.enabled,
+      minLevelRaw,
+      options.flushIntervalSeconds ?? null,
+      options.batchSize ?? null,
+      options.maxQueueSize ?? null
+    );
+  }
+
   static async startDeliveryByPlaceID(
     placeID: string,
     deliveryId: string,
-    timeoutSeconds?: number
+    timeoutSeconds?: number,
+    options?: StartDeliveryOptions
   ) {
     try {
-      const result = await DoorstepAI.startDeliveryByPlaceID(
+      const timeout =
+        timeoutSeconds ?? options?.timeoutSeconds ?? DEFAULT_TIMEOUT_SECONDS;
+      const autoStop = options?.autoStopAfterDropoffSeconds ?? null;
+      const result =
+        Platform.OS === 'android'
+          ? await DoorstepAI.startDeliveryByPlaceID(
+              placeID,
+              deliveryId,
+              timeout,
+              autoStop,
+              options?.manualForeground ?? false
+            )
+          : await DoorstepAI.startDeliveryByPlaceID(
+              placeID,
+              deliveryId,
+              timeout,
+              autoStop
+            );
+      console.log(
+        'DOORSTEPAI - Delivery started successfully by Place ID:',
         placeID,
-        deliveryId,
-        timeoutSeconds ?? 7200
+        deliveryId
       );
-      console.log('DOORSTEPAI - Delivery started successfully by Place ID:', placeID, deliveryId);
-      return result; // Return result (e.g., session ID from Android)
+      return result;
     } catch (error: any) {
-      console.error('DOORSTEPAI - Failed to start delivery by Place ID:', error);
-      throw error; // Re-throw error for caller handling
+      console.error(
+        'DOORSTEPAI - Failed to start delivery by Place ID:',
+        error
+      );
+      throw error;
     }
   }
 
-  // Add deliveryId parameter
+  /** @deprecated Use `startDeliveryByAddressString` with coordinates instead. */
   static async startDeliveryByPlusCode(
     plusCode: string,
     deliveryId: string,
-    timeoutSeconds?: number
+    timeoutSeconds?: number,
+    options?: StartDeliveryOptions
   ) {
     try {
-      const result = await DoorstepAI.startDeliveryByPlusCode(
+      const timeout =
+        timeoutSeconds ?? options?.timeoutSeconds ?? DEFAULT_TIMEOUT_SECONDS;
+      // Android's deprecated startDeliveryByPlusCode does not accept the new
+      // options, so we forward only the supported parameters there.
+      const result =
+        Platform.OS === 'ios'
+          ? await DoorstepAI.startDeliveryByPlusCode(
+              plusCode,
+              deliveryId,
+              timeout,
+              options?.autoStopAfterDropoffSeconds ?? null
+            )
+          : await DoorstepAI.startDeliveryByPlusCode(
+              plusCode,
+              deliveryId,
+              timeout
+            );
+      console.log(
+        'DOORSTEPAI - Delivery started successfully by Plus Code:',
         plusCode,
-        deliveryId,
-        timeoutSeconds ?? 7200
+        deliveryId
       );
-      console.log('DOORSTEPAI - Delivery started successfully by Plus Code:', plusCode, deliveryId);
       return result;
     } catch (error: any) {
-      console.error('DOORSTEPAI - Failed to start delivery by Plus Code:', error);
+      console.error(
+        'DOORSTEPAI - Failed to start delivery by Plus Code:',
+        error
+      );
       throw error;
     }
   }
 
-  // Add deliveryId parameter and handle platform difference
   static async startDeliveryByAddress(
     address: AddressType,
     deliveryId: string,
-    timeoutSeconds?: number
+    timeoutSeconds?: number,
+    coordinates?: LatLngObject,
+    options?: StartDeliveryOptions
   ) {
     try {
-      let result = await DoorstepAI.startDeliveryByAddress(
+      const timeout =
+        timeoutSeconds ?? options?.timeoutSeconds ?? DEFAULT_TIMEOUT_SECONDS;
+      const autoStop = options?.autoStopAfterDropoffSeconds ?? null;
+      const result =
+        Platform.OS === 'android'
+          ? await DoorstepAI.startDeliveryByAddress(
+              address,
+              deliveryId,
+              coordinates ?? null,
+              timeout,
+              autoStop,
+              options?.manualForeground ?? false
+            )
+          : await DoorstepAI.startDeliveryByAddress(
+              address,
+              deliveryId,
+              coordinates ?? null,
+              timeout,
+              autoStop
+            );
+      console.log(
+        'DOORSTEPAI - Delivery started successfully by Address:',
         address,
-        deliveryId,
-        timeoutSeconds ?? 7200
+        deliveryId
       );
-      console.log('DOORSTEPAI - Delivery started successfully by Address:', address, deliveryId);
       return result;
     } catch (error: any) {
       console.error('DOORSTEPAI - Failed to start delivery by Address:', error);
@@ -100,38 +241,77 @@ class DoorstepAIModule {
   static async startDeliveryByAddressString(
     address: string,
     deliveryId: string,
-    timeoutSeconds?: number
+    timeoutSeconds?: number,
+    coordinates?: LatLngObject,
+    options?: StartDeliveryOptions
   ) {
     try {
-      const result = await DoorstepAI.startDeliveryByAddressString(
+      const timeout =
+        timeoutSeconds ?? options?.timeoutSeconds ?? DEFAULT_TIMEOUT_SECONDS;
+      const autoStop = options?.autoStopAfterDropoffSeconds ?? null;
+      const result =
+        Platform.OS === 'android'
+          ? await DoorstepAI.startDeliveryByAddressString(
+              address,
+              deliveryId,
+              coordinates ?? null,
+              timeout,
+              autoStop,
+              options?.manualForeground ?? false
+            )
+          : await DoorstepAI.startDeliveryByAddressString(
+              address,
+              deliveryId,
+              coordinates ?? null,
+              timeout,
+              autoStop
+            );
+      console.log(
+        'DOORSTEPAI - Delivery started successfully by Address String:',
         address,
-        deliveryId,
-        timeoutSeconds ?? 7200
+        deliveryId
       );
-      console.log('DOORSTEPAI - Delivery started successfully by Address String:', address, deliveryId);
       return result;
     } catch (error: any) {
-      console.error('DOORSTEPAI - Failed to start delivery by Address String:', error);
+      console.error(
+        'DOORSTEPAI - Failed to start delivery by Address String:',
+        error
+      );
       throw error;
     }
   }
 
-
+  /** @deprecated Use `startDeliveryByAddress` or `startDeliveryByAddressString` with coordinates instead. */
   static async startDeliveryByLatLng(
     latitude: number,
     longitude: number,
     subUnit: string,
     deliveryId: string,
-    timeoutSeconds?: number
+    timeoutSeconds?: number,
+    options?: StartDeliveryOptions
   ) {
     try {
-      const result = await DoorstepAI.startDeliveryByLatLng(
-        latitude,
-        longitude,
-        subUnit,
-        deliveryId,
-        timeoutSeconds ?? 7200
-      );
+      const timeout =
+        timeoutSeconds ?? options?.timeoutSeconds ?? DEFAULT_TIMEOUT_SECONDS;
+      // Android's deprecated startDeliveryByLatLng does not accept the new
+      // options, so we forward only the supported parameters there.
+      const result =
+        Platform.OS === 'ios'
+          ? await DoorstepAI.startDeliveryByLatLng(
+              latitude,
+              longitude,
+              subUnit,
+              deliveryId,
+              timeout,
+              options?.autoStopAfterDropoffSeconds ?? null
+            )
+          : await DoorstepAI.startDeliveryByLatLng(
+              latitude,
+              longitude,
+              subUnit,
+              deliveryId,
+              timeout
+            );
       console.log(
         'DOORSTEPAI - Delivery started successfully by LatLng:',
         latitude,
@@ -148,20 +328,23 @@ class DoorstepAIModule {
 
   static async markDropoff(deliveryId: string, dropoffType: 'pod' | 'non_pod') {
     try {
-      if (Platform.OS === 'android') {
-        const androidDropoffType = dropoffType === 'pod' ? 'POD' : 'NON_POD';
-        await DoorstepAI.markDropoff(deliveryId, androidDropoffType);
-      } else {
-        await DoorstepAI.markDropoff(deliveryId, dropoffType);
-      }
-      console.log('DOORSTEPAI - Dropoff marked successfully:', deliveryId, dropoffType);
+      await DoorstepAI.markDropoff(deliveryId, dropoffType);
+      console.log(
+        'DOORSTEPAI - Dropoff marked successfully:',
+        deliveryId,
+        dropoffType
+      );
     } catch (error: any) {
-      console.error('DOORSTEPAI - Failed to mark dropoff:', deliveryId, dropoffType, error);
+      console.error(
+        'DOORSTEPAI - Failed to mark dropoff:',
+        deliveryId,
+        dropoffType,
+        error
+      );
       throw error;
     }
   }
 
-  // Add deliveryId parameter
   static async stopDelivery(deliveryId: string) {
     try {
       await DoorstepAI.stopDelivery(deliveryId);
@@ -172,18 +355,44 @@ class DoorstepAIModule {
     }
   }
 
-  // Add deliveryId parameter
   static async newEvent(eventName: string, deliveryId: string) {
     try {
       const result = await DoorstepAI.newEvent(eventName, deliveryId);
       console.log('DOORSTEPAI - Event sent successfully:', result);
       return result;
     } catch (error: any) {
-      console.error('DOORSTEPAI - Failed to send event:', eventName, deliveryId, error);
+      console.error(
+        'DOORSTEPAI - Failed to send event:',
+        eventName,
+        deliveryId,
+        error
+      );
       throw error;
     }
   }
-  
+
+  // ---- Dev-mode helpers (Android exposes a richer surface than iOS) ----
+
+  static async enableDevMode(apiKey: string): Promise<boolean> {
+    if (Platform.OS === 'ios') {
+      await DoorstepAI.enableDevMode(apiKey);
+      return true;
+    }
+    return Boolean(await DoorstepAI.enableDevMode());
+  }
+
+  /** Android only. Returns false on iOS. */
+  static async validateDevModeAccess(): Promise<boolean> {
+    if (Platform.OS !== 'android') return false;
+    return Boolean(await DoorstepAI.validateDevModeAccess());
+  }
+
+  /** Android only. No-op on iOS. */
+  static async disableDevMode(): Promise<boolean> {
+    if (Platform.OS !== 'android') return false;
+    return Boolean(await DoorstepAI.disableDevMode());
+  }
 }
 
 export { DoorstepAIModule as DoorstepAI };
+export type { AddressType, LatLngObject, StartDeliveryOptions, SDKLogLevel };

package/src/RootDoorstepAI.tsx

@@ -12,7 +12,6 @@ import { DoorstepAI } from './DoorstepAI';
 
 const DoorstepAIView = requireNativeComponent('RootDoorstepAIView');
 
-
 export function RootDoorstepAI(props: {
   apiKey: string;
   notificationTitle?: string;

package/src/index.tsx

@@ -1,4 +1,10 @@
 import { RootDoorstepAI } from './RootDoorstepAI';
 import { DoorstepAI } from './DoorstepAI';
+export type {
+  AddressType,
+  LatLngObject,
+  StartDeliveryOptions,
+  SDKLogLevel,
+} from './DoorstepAI';
 
 export { DoorstepAI, RootDoorstepAI };