react-native-okhi 1.2.4 → 1.2.5-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-okhi",
-  "version": "1.2.4",
+  "version": "1.2.5-beta.1",
   "description": "The OkHi React Native library enables you to collect and verify addresses from your users",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/react-native-okhi.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "OkHi", "1.9.9"
+  s.dependency "OkHi", "1.9.17-beta"
 
   # Don't install the dependencies when we run `pod install` in the old architecture.
   if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then

package/src/OkCollect/OkHiLocationManager.tsx

@@ -20,7 +20,13 @@ import { start as sv } from '../OkVerify';
 import type { OkVerifyStartConfiguration } from '../OkVerify/types';
 import {
   getApplicationConfiguration,
+  isBackgroundLocationPermissionGranted,
+  isLocationPermissionGranted,
+  isLocationServicesEnabled,
+  openAppSettings,
   openProtectedAppsSettings,
+  requestBackgroundLocationPermission,
+  requestLocationPermission,
 } from '../OkCore';
 import { OkHiNativeModule } from '../OkHiNativeModule';
 
@@ -38,10 +44,12 @@ export const OkHiLocationManager = (props: OkHiLocationManagerProps) => {
     ? { ...props.style, ...defaultStyle }
     : defaultStyle;
 
-  const { user, onSuccess, onCloseRequest, onError, loader, launch } = props;
+  const { user, onSuccess, onCloseRequest, onError, loader, launch, config } =
+    props;
   const webViewRef = useRef<WebView | null>(null);
   const startMessage =
     props.mode === 'create' ? 'start_app' : 'select_location';
+  const [ready, setReady] = useState(false);
 
   useEffect(() => {
     if (applicationConfiguration == null && token == null && user.phone) {
@@ -92,21 +100,131 @@ export const OkHiLocationManager = (props: OkHiLocationManagerProps) => {
     }
   }, [applicationConfiguration, props, token]);
 
+  useEffect(() => {
+    if (launch) {
+      if (
+        typeof config?.permissionsOnboarding === 'boolean' &&
+        !config.permissionsOnboarding
+      ) {
+        isBackgroundLocationPermissionGranted().then((result) => {
+          if (!result) {
+            onError(
+              new OkHiException({
+                code: OkHiException.PERMISSION_DENIED_CODE,
+                message:
+                  'Always location permission must be granted to launch OkCollect',
+              })
+            );
+          } else {
+            setReady(true);
+          }
+        });
+      } else {
+        setReady(true);
+      }
+    } else {
+      setReady(false);
+    }
+  }, [launch, config?.permissionsOnboarding]);
+
+  const runWebViewCallback = (value: string) => {
+    if (webViewRef.current) {
+      const jsString = `(function (){ if (typeof runOkHiLocationManagerCallback === "function") { runOkHiLocationManagerCallback("${value}") } })()`;
+      webViewRef.current.injectJavaScript(jsString);
+    }
+  };
+
+  const handleAndroidRequestLocationPermission = async (
+    level: 'whenInUse' | 'always'
+  ) => {
+    if (level === 'whenInUse') {
+      const result = await requestLocationPermission();
+      runWebViewCallback(result ? 'whenInUse' : 'denied');
+    } else if (level === 'always') {
+      const result = await requestBackgroundLocationPermission();
+      if (result) {
+        runWebViewCallback('always');
+      } else {
+        const isWhenInUseGranted = await isLocationPermissionGranted();
+        runWebViewCallback(isWhenInUseGranted ? 'whenInUse' : 'denied');
+      }
+    }
+  };
+
+  const handleIOSRequestLocationPermission = async (
+    level: 'whenInUse' | 'always'
+  ) => {
+    const unknownError = new OkHiException({
+      code: OkHiException.UNKNOWN_ERROR_CODE,
+      message:
+        'Something went wrong while requesting permissions. Please try again later.',
+    });
+    try {
+      const isServiceAvailable = await isLocationServicesEnabled();
+      if (!isServiceAvailable) {
+        openAppSettings();
+      } else if (level === 'whenInUse') {
+        const result = await requestLocationPermission();
+        runWebViewCallback(result ? level : 'denied');
+      } else if (level === 'always') {
+        const granted = await isBackgroundLocationPermissionGranted();
+        if (granted) {
+          runWebViewCallback(level);
+        } else {
+          openAppSettings();
+        }
+      }
+    } catch (error) {
+      onError(unknownError);
+    }
+  };
+
+  const handleRequestLocationPermission = async ({
+    level,
+  }: {
+    level: 'whenInUse' | 'always';
+  }) => {
+    if (Platform.OS === 'android') {
+      handleAndroidRequestLocationPermission(level);
+    } else if (Platform.OS === 'ios') {
+      handleIOSRequestLocationPermission(level);
+    }
+  };
+
+  const handleOpenAppSettings = async () => {
+    try {
+      const granted = await isBackgroundLocationPermissionGranted();
+      if (granted) {
+        runWebViewCallback('always');
+      } else {
+        await openAppSettings();
+      }
+    } catch (error) {
+      const err = error as OkHiException;
+      onError(err);
+    }
+  };
+
   const handleOnMessage = ({ nativeEvent: { data } }: WebViewMessageEvent) => {
     try {
       const response: OkHiLocationManagerResponse = JSON.parse(data);
+
       if (response.message === 'fatal_exit') {
         onError(
           new OkHiException({
             code: OkHiException.UNKNOWN_ERROR_CODE,
-            message: response.payload.toString(),
+            message: 'Something went wrong, please try again later.',
           })
         );
       } else if (response.message === 'exit_app') {
         onCloseRequest();
       } else if (response.message === 'request_enable_protected_apps') {
         openProtectedAppsSettings();
-      } else {
+      } else if (
+        response.message === 'location_created' ||
+        response.message === 'location_selected' ||
+        response.message === 'location_updated'
+      ) {
         onSuccess({
           user: {
             ...response.payload.user,
@@ -139,6 +257,10 @@ export const OkHiLocationManager = (props: OkHiLocationManagerProps) => {
             });
           },
         });
+      } else if (response.message === 'request_location_permission') {
+        handleRequestLocationPermission(response.payload);
+      } else if (response.message === 'open_app_settings') {
+        handleOpenAppSettings();
       }
     } catch (error) {
       let errorMessage = 'Something went wrong';
@@ -204,10 +326,10 @@ export const OkHiLocationManager = (props: OkHiLocationManagerProps) => {
     <Modal
       animationType="slide"
       transparent={false}
-      visible={launch}
+      visible={ready}
       onRequestClose={handleModalRequestClose}
     >
-      {launch ? renderContent() : null}
+      {ready ? renderContent() : null}
     </Modal>
   );
 };

package/src/OkCollect/Util.ts

@@ -34,6 +34,8 @@ export const generateStartDataPayload = async (
   applicationConfiguration: AuthApplicationConfig
 ): Promise<OkHiLocationManagerStartDataPayload> => {
   const payload: any = {};
+  const { manufacturer, model, osVersion, platform } =
+    await OkHiNativeModule.retrieveDeviceInfo();
   payload.style = !props.theme
     ? undefined
     : {
@@ -67,6 +69,12 @@ export const generateStartDataPayload = async (
     platform: {
       name: 'react-native',
     },
+    device: {
+      manufacturer,
+      model,
+      platform,
+      osVersion,
+    },
   };
   payload.config = {
     streetView:
@@ -89,34 +97,39 @@ export const generateStartDataPayload = async (
     },
     protectedApps:
       Platform.OS === 'android' && (await canOpenProtectedAppsSettings()),
+    permissionsOnboarding:
+      typeof props.config?.permissionsOnboarding === 'boolean'
+        ? props.config.permissionsOnboarding
+        : true,
   };
 
   if (Platform.OS === 'ios') {
     const status = await OkHiNativeModule.fetchIOSLocationPermissionStatus();
-    if (status !== 'notDetermined') {
-      payload.context.permissions = {
-        location:
-          status === 'authorizedWhenInUse'
-            ? 'whenInUse'
-            : status === 'authorizedAlways' || status === 'authorized'
-            ? 'always'
-            : 'denided',
-      };
-      if (
-        status === 'authorized' ||
-        status === 'authorizedWhenInUse' ||
-        status === 'authorizedAlways'
-      ) {
-        const location = await fetchCurrentLocation();
-        if (location) {
-          payload.context.coordinates = {
-            currentLocation: {
-              lat: location.lat,
-              lng: location.lng,
-              accuracy: location.accuracy,
-            },
-          };
-        }
+    const locationPermission =
+      status === 'notDetermined'
+        ? 'notDetermined'
+        : status === 'authorizedWhenInUse'
+        ? 'whenInUse'
+        : status === 'authorizedAlways'
+        ? 'always'
+        : 'denied';
+    payload.context.permissions = {
+      location: locationPermission,
+    };
+    if (
+      status === 'authorized' ||
+      status === 'authorizedWhenInUse' ||
+      status === 'authorizedAlways'
+    ) {
+      const location = await fetchCurrentLocation();
+      if (location) {
+        payload.context.coordinates = {
+          currentLocation: {
+            lat: location.lat,
+            lng: location.lng,
+            accuracy: location.accuracy,
+          },
+        };
       }
     }
   } else if (Platform.OS === 'android') {
@@ -147,11 +160,6 @@ export const generateStartDataPayload = async (
           : 'denied',
       };
     }
-    const { manufacturer, model } = await OkHiNativeModule.retrieveDeviceInfo();
-    payload.context.device = {
-      manufacturer,
-      model,
-    };
   } else {
     throw new OkHiException({
       code: OkHiException.UNSUPPORTED_PLATFORM_CODE,

package/src/OkCollect/types.ts

@@ -79,6 +79,7 @@ export interface OkHiLocationManagerProps {
       home?: boolean;
       work?: boolean;
     };
+    permissionsOnboarding?: boolean;
   };
 
   /**
@@ -142,6 +143,7 @@ export interface OkHiLocationManagerResponse {
     | 'location_updated'
     | 'exit_app'
     | 'request_enable_protected_apps'
-    | 'fatal_exit';
-  payload: { user: any; location: any };
+    | 'fatal_exit'
+    | 'request_location_permission';
+  payload: any;
 }

package/src/OkCore/index.ts

@@ -30,6 +30,7 @@ export function initialize(
           configuration.credentials.clientKey,
           configuration.context.mode
         );
+        await OkHiNativeModule.onStart();
       }
     }
   });

package/src/OkCore/types.ts

@@ -1,3 +1,5 @@
+import type { OkHiException } from './OkHiException';
+
 /**
  * Defines the structure of the user object requried by OkHi services and libraries.
  */
@@ -209,5 +211,5 @@ export type LocationRequestPermissionType = 'whenInUse' | 'always';
 
 export type LocationPermissionCallback = (
   status: LocationPermissionStatusCallback | null,
-  error: OkHiError | null
+  error: OkHiException | null
 ) => any;

package/src/OkHiNativeModule/index.ts

@@ -44,7 +44,12 @@ type OkHiNativeModuleType = {
   requestTrackingAuthorization(): Promise<string | null>;
   canOpenProtectedAppsSettings(): Promise<boolean>;
   openProtectedAppsSettings(): Promise<boolean>;
-  retrieveDeviceInfo(): Promise<{ manufacturer: string; model: string }>;
+  retrieveDeviceInfo(): Promise<{
+    manufacturer: string;
+    model: string;
+    osVersion: string;
+    platform: 'android' | 'ios';
+  }>;
   setItem(key: string, value: string): Promise<boolean>;
   onNewToken(fcmPushNotificationToken: string): Promise<boolean>;
   onMessageReceived(): Promise<boolean>;
@@ -64,6 +69,7 @@ type OkHiNativeModuleType = {
     | 'authorized'
     | 'unknown'
   >;
+  onStart(): Promise<boolean>;
 };
 
 export const OkHiNativeModule: OkHiNativeModuleType = NativeModules.Okhi