react-native-okhi 1.2.31 → 1.2.32-beta.2

package/src/OkCollect/types.ts

@@ -1,154 +0,0 @@
-import type { ViewStyle } from 'react-native';
-import type { JSX } from 'react';
-import type { OkHiException } from '../OkCore/OkHiException';
-import type { OkHiUser, OkHiLocation, UsageType } from '../OkCore/types';
-
-/**
- * The OkCollect Success Response object contains information about the newly created user and location once an address has been successfully created.
- * It can be used to extract information about the address and/or start address verification process.
- */
-export interface OkCollectSuccessResponse {
-  /**
-   * The [OkHiUser](https://okhi.github.io/react-native-core/interfaces/okhiuser.html) object containing information about the newly created user.
-   */
-  user: OkHiUser;
-  /**
-   * The [OkHiLocation](https://okhi.github.io/react-native-core/interfaces/okhilocation.html) object containing information about the newly created user.
-   */
-  location: OkHiLocation;
-
-  /**
-   * Starts address verification
-   */
-  startVerification: () => Promise<string>;
-}
-
-/**
- * The OkHiLocationManager exposes props that you can use to customise it's functionality and appearance.
- */
-export interface OkHiLocationManagerProps {
-  /**
-   * **Required:** A boolean flag that determines whether or not to show the Location Manager.
-   */
-  launch: boolean;
-  /**
-   * **Required:** A defined [OkHiUser](https://okhi.github.io/react-native-core/interfaces/okhiuser.html) object, with a mandatory "phone" key property.
-   */
-  user: OkHiUser;
-  /**
-   * **Optional:** A custom JSX.Element that'll be used as a loading indicator.
-   */
-  loader?: JSX.Element;
-  /**
-   * **Optional:** Used to customise the appearance of the Container that wraps the location manager.
-   */
-  style?: ViewStyle;
-  /**
-   * **Required:** A callback that'll be invoked with an {@link OkCollectSuccessResponse} once an accurate OkHi address has been successfully created.
-   */
-  onSuccess: (response: OkCollectSuccessResponse) => any;
-  /**
-   * **Required:** A callback that'll be invoked whenever an error occurs during the address creation process.
-   */
-  onError: (error: OkHiException) => any;
-  /**
-   * **Required:** A callback that'll be invoked whenever a user taps on the close button.
-   */
-  onCloseRequest: () => any;
-  /**
-   * **Optional:** An object that'll be used to customise the appearance of the Location Manager to better match your branding requirements.
-   */
-  theme?: {
-    appBar?: {
-      backgroundColor?: string;
-      logo?: string;
-    };
-    colors?: {
-      primary?: string;
-    };
-  };
-  /**
-   * **Optional:** An object that'll be used to customise the functionality of the Location Manager. This object dictates whether you want some features on or off.
-   */
-  config?: {
-    streetView?: boolean;
-    appBar?: {
-      visible?: boolean;
-    };
-    addressTypes?: {
-      home?: boolean;
-      work?: boolean;
-    };
-    usageTypes?: UsageType;
-  };
-
-  /**
-   * **Optional:** Enable a user to either select an existing address, or force to create a new one
-   */
-  mode?: 'create' | 'select';
-
-  location?: {
-    id?: string;
-  };
-}
-
-/**
- * @ignore
- */
-export interface OkHiLocationManagerStartDataPayload {
-  style?: {
-    base?: {
-      color?: string;
-      logo?: string;
-      name?: string;
-    };
-  };
-  auth: {
-    authToken: string;
-  };
-  context: {
-    container?: {
-      name?: string;
-      version?: string;
-    };
-    developer: {
-      name: string;
-    };
-    library: {
-      name: string;
-      version: string;
-    };
-    platform: {
-      name: 'react-native';
-    };
-  };
-  config?: {
-    streetView?: boolean;
-    appBar?: {
-      color?: string;
-      visible?: boolean;
-    };
-    usageTypes: UsageType;
-  };
-  user: OkHiUser;
-}
-
-/**
- * @ignore
- */
-export type OkHiLocationManagerStartMessage = 'select_location' | 'start_app';
-
-/**
- * @ignore
- */
-export interface OkHiLocationManagerResponse {
-  message:
-    | 'location_selected'
-    | 'location_created'
-    | 'location_updated'
-    | 'exit_app'
-    | 'request_enable_protected_apps'
-    | 'fatal_exit'
-    | 'request_location_permission';
-  payload: any;
-}

package/src/OkCore/Helpers.ts

@@ -1,477 +0,0 @@
-import { OkHiNativeModule, OkHiNativeEvents } from '../OkHiNativeModule';
-import { Alert, Permission, PermissionsAndroid, Platform } from 'react-native';
-import { errorHandler, isValidPlatform } from './_helpers';
-import type {
-  LocationPermissionCallback,
-  LocationPermissionStatus,
-  LocationRequestPermissionType,
-} from './types';
-import { OkHiException } from './OkHiException';
-
-/**
- * Checks whether location services are enabled
- * @returns {Promise<boolean>} A promise that resolves to a boolen value indicating whether the service is available
- */
-export const isLocationServicesEnabled = (): Promise<boolean> => {
-  return isValidPlatform(OkHiNativeModule.isLocationServicesEnabled);
-};
-
-/**
- * Checks whether when in use location permission is granted
- * @returns {Promise<boolean>} A promise that resolves to a boolen value indicating whether the permission is granted
- */
-export const isLocationPermissionGranted = (): Promise<boolean> => {
-  return isValidPlatform(OkHiNativeModule.isLocationPermissionGranted);
-};
-
-const isBackgroundLocationPermissionGrantedAndroid =
-  async (): Promise<boolean> => {
-    const sdkVersion = await OkHiNativeModule.getSystemVersion();
-    if (Number(sdkVersion) < 23) {
-      return true;
-    }
-    if (Number(sdkVersion) < 29) {
-      return await isLocationPermissionGranted();
-    }
-    if (
-      typeof PermissionsAndroid.PERMISSIONS.ACCESS_BACKGROUND_LOCATION !==
-      'undefined'
-    ) {
-      const hasPermission = await PermissionsAndroid.check(
-        PermissionsAndroid.PERMISSIONS.ACCESS_BACKGROUND_LOCATION as Permission
-      );
-      return hasPermission;
-    }
-    console.warn(
-      `PermissionsAndroid.PERMISSIONS.ACCESS_BACKGROUND_LOCATION is undefined, this is an issue with the current version of RN you are running. Please consider upgrading`
-    );
-    return false;
-  };
-
-const isBackgroundLocationPermissionGrantedIOS = (): Promise<boolean> => {
-  return OkHiNativeModule.isBackgroundLocationPermissionGranted();
-};
-
-/**
- * Checks whether background location permission is granted
- * @returns {Promise<boolean>} A promise that resolves to a boolen value indicating whether the permission is granted
- */
-export const isBackgroundLocationPermissionGranted = (): Promise<boolean> => {
-  const fn =
-    Platform.OS === 'android'
-      ? isBackgroundLocationPermissionGrantedAndroid
-      : isBackgroundLocationPermissionGrantedIOS;
-  return isValidPlatform(fn);
-};
-
-const requestLocationPermissionAndroid = async (): Promise<boolean> => {
-  const status: any = await PermissionsAndroid.requestMultiple([
-    PermissionsAndroid.PERMISSIONS.ACCESS_FINE_LOCATION as Permission,
-    PermissionsAndroid.PERMISSIONS.ACCESS_COARSE_LOCATION as Permission,
-  ]);
-  return status['android.permission.ACCESS_FINE_LOCATION'] === 'granted';
-};
-
-const requestLocationPermissionIOS = (): Promise<boolean> => {
-  return OkHiNativeModule.requestLocationPermission();
-};
-
-/**
- * Requests for when in use location permission
- * @returns {Promise<boolean>} A promise that resolves to a boolen value indicating whether the permission is granted
- */
-export const requestLocationPermission = async (): Promise<boolean> => {
-  const isGranted = await isLocationPermissionGranted();
-  if (isGranted) return isGranted;
-  return errorHandler(
-    Platform.OS === 'android'
-      ? requestLocationPermissionAndroid
-      : requestLocationPermissionIOS
-  );
-};
-
-const requestBackgroundLocationPermissionAndroid =
-  async (): Promise<boolean> => {
-    const sdkVersion = await OkHiNativeModule.getSystemVersion();
-    if (Number(sdkVersion) < 23) return true;
-    if (Number(sdkVersion) >= 29) {
-      const permissions: any = [
-        PermissionsAndroid.PERMISSIONS.ACCESS_BACKGROUND_LOCATION,
-      ];
-      const status: any = await PermissionsAndroid.requestMultiple(permissions);
-      return (
-        status['android.permission.ACCESS_BACKGROUND_LOCATION'] === 'granted'
-      );
-    } else {
-      return await requestLocationPermissionAndroid();
-    }
-  };
-
-const requestBackgroundLocationPermissionIOS = (): Promise<boolean> => {
-  return OkHiNativeModule.requestBackgroundLocationPermission();
-};
-
-/**
- * Requests for background location permission
- * @returns {Promise<boolean>} A promise that resolves to a boolen value indicating whether the permission is granted
- */
-export const requestBackgroundLocationPermission =
-  async (): Promise<boolean> => {
-    const isGranted = await isBackgroundLocationPermissionGranted();
-    if (isGranted) return isGranted;
-    return errorHandler(
-      Platform.OS === 'android'
-        ? requestBackgroundLocationPermissionAndroid
-        : requestBackgroundLocationPermissionIOS
-    );
-  };
-
-/**
- * Requests the user to enable location services by showing an in app modal on android and opening location settings on iOS
- * @returns {Promise<boolean>} A promise that resolves to either a boolean value on android or null on iOS
- */
-export const requestEnableLocationServices = (): Promise<boolean | null> => {
-  return isValidPlatform(OkHiNativeModule.requestEnableLocationServices);
-};
-
-/**
- * Android Only - Checks if Google Play Services is available
- * @returns {Promise<boolean>} A promise that resolves to a boolean value indicating whether the service is avaialbe
- */
-export const isGooglePlayServicesAvailable = (): Promise<boolean> => {
-  return isValidPlatform(
-    OkHiNativeModule.isGooglePlayServicesAvailable,
-    'android'
-  );
-};
-
-/**
- * Android Only - Requests user to enable Google Play Services
- * @returns {Promise<boolean>} A promise that resolves to a boolean value indicating whether the service is avaialbe
- */
-export const requestEnableGooglePlayServices = (): Promise<boolean> => {
-  return isValidPlatform(
-    OkHiNativeModule.requestEnableGooglePlayServices,
-    'android'
-  );
-};
-
-/**
- * Returns the system version of the current platform
- * @returns {Promise<boolean>} A promise that resolves either a string on iOS or number on Android
- */
-export const getSystemVersion = (): Promise<string | number> =>
-  isValidPlatform(OkHiNativeModule.getSystemVersion);
-
-/**
- * Requests location permission from the user. It'll also attempt to activate any disbaled services (Android Only)
- */
-export const request = (
-  locationPermissionType: LocationRequestPermissionType,
-  rationale: {
-    title: string;
-    text: string;
-    successButton?: { label: string };
-    denyButton?: { label: string };
-  } | null,
-  callback: LocationPermissionCallback
-) => {
-  const serviceError = new OkHiException({
-    code: OkHiException.SERVICE_UNAVAILABLE_CODE,
-    message:
-      'Location service is currently not available. Please enable in app settings',
-  });
-
-  const googlePlayError = new OkHiException({
-    code: OkHiException.SERVICE_UNAVAILABLE_CODE,
-    message:
-      'Google Play Services is currently unavailable. Please enable in settings',
-  });
-
-  const handleError = (error: OkHiException) => {
-    callback(null, error);
-  };
-
-  const handleGooglePlayServiceRequest = () => {
-    requestEnableGooglePlayServices().then((googlePlayStatus) => {
-      if (!googlePlayStatus) {
-        handleError(googlePlayError);
-      } else {
-        handleRationaleRequest();
-      }
-    });
-  };
-
-  const handleRationaleAlert = (alertRationale: {
-    title: string;
-    text: string;
-    grantButton?: { label: string };
-    denyButton?: { label: string };
-  }) => {
-    return new Promise((resolve, _) => {
-      Alert.alert(
-        alertRationale.title,
-        alertRationale.text,
-        [
-          {
-            text: alertRationale.grantButton
-              ? alertRationale.grantButton.label
-              : 'Grant',
-            onPress: () => {
-              resolve(true);
-            },
-          },
-          {
-            text: alertRationale.denyButton
-              ? alertRationale.denyButton.label
-              : 'Deny',
-            onPress: () => {
-              resolve(false);
-            },
-            style: 'cancel',
-          },
-        ],
-        {
-          onDismiss: () => {
-            resolve(false);
-          },
-        }
-      );
-    });
-  };
-
-  const handlePermissionRequest = () => {
-    if (Platform.OS === 'ios') {
-      OkHiNativeEvents.removeAllListeners('onLocationPermissionStatusUpdate');
-      OkHiNativeEvents.addListener(
-        'onLocationPermissionStatusUpdate',
-        (permissionUpdate) => {
-          callback(permissionUpdate, null);
-        }
-      );
-      if (locationPermissionType === 'whenInUse') {
-        OkHiNativeModule.requestLocationPermission();
-      } else {
-        OkHiNativeModule.requestBackgroundLocationPermission();
-      }
-    } else {
-      if (locationPermissionType === 'whenInUse') {
-        requestLocationPermissionAndroid().then((whenInUseResult) =>
-          callback(whenInUseResult ? 'authorizedWhenInUse' : 'denied', null)
-        );
-      } else {
-        requestLocationPermissionAndroid().then((initialWhenInUseResult) => {
-          if (!initialWhenInUseResult) {
-            callback('denied', null);
-          } else {
-            callback('authorizedWhenInUse', null);
-            requestBackgroundLocationPermission().then((alwaysResult) => {
-              callback(
-                alwaysResult ? 'authorizedAlways' : 'authorizedWhenInUse',
-                null
-              );
-            });
-          }
-        });
-      }
-    }
-  };
-
-  const handleRationaleRequest = async () => {
-    const currentStatus = await retriveLocationPermissionStatus();
-    let showRationale = true;
-    if (
-      locationPermissionType === 'whenInUse' &&
-      (currentStatus === 'authorizedWhenInUse' ||
-        currentStatus === 'authorizedAlways')
-    ) {
-      showRationale = false;
-    }
-    if (
-      locationPermissionType === 'always' &&
-      currentStatus === 'authorizedAlways'
-    ) {
-      showRationale = false;
-    }
-    if (rationale && showRationale) {
-      const result = await handleRationaleAlert(rationale);
-      if (!result) {
-        callback('rationaleDissmissed', null);
-      } else {
-        handlePermissionRequest();
-      }
-    } else {
-      handlePermissionRequest();
-    }
-  };
-
-  isLocationServicesEnabled()
-    .then((serviceStatus) => {
-      if (!serviceStatus && Platform.OS === 'ios') {
-        handleError(serviceError);
-      } else if (!serviceStatus && Platform.OS === 'android') {
-        requestEnableLocationServices()
-          .then((enableResult) => {
-            if (!enableResult) {
-              handleError(serviceError);
-            } else {
-              handleGooglePlayServiceRequest();
-            }
-          })
-          .catch(handleError);
-      } else {
-        if (Platform.OS === 'ios') {
-          handleRationaleRequest();
-        } else {
-          handleGooglePlayServiceRequest();
-        }
-      }
-    })
-    .catch(handleError);
-};
-
-/**
- * Open the device's app settings.
- */
-export const openAppSettings = () => {
-  OkHiNativeModule.openAppSettings();
-};
-
-/**
- * Retrives the location permission status from the device
- */
-export const retriveLocationPermissionStatus =
-  async (): Promise<LocationPermissionStatus> => {
-    if (Platform.OS === 'ios') {
-      return OkHiNativeModule.retriveLocationPermissionStatus() as Promise<LocationPermissionStatus>;
-    }
-    const alwaysPerm = await isBackgroundLocationPermissionGranted();
-    if (alwaysPerm) {
-      return 'authorizedAlways';
-    }
-    const whenInUsePerm = await isLocationPermissionGranted();
-    return whenInUsePerm ? 'authorizedWhenInUse' : 'denied';
-  };
-
-/**
- * Requests tracking authorization from the user. iOS only, iOS version >= 14
- * Read more: https://developer.apple.com/app-store/user-privacy-and-data-use/
- */
-export const requestTrackingAuthorization = async (): Promise<
-  string | null
-> => {
-  return isValidPlatform(async () => {
-    const result = await OkHiNativeModule.requestTrackingAuthorization();
-    return result;
-  }, 'ios');
-};
-
-/**
- * Checks whether current device can open "Protected Apps Settings" available in Transsion Group android devices such as Infinix and Tecno
- * When your application is included in protected apps, verification processes are less likely to be terminated by the OS. Increasing rate of users being verified.
- */
-export const canOpenProtectedAppsSettings = (): Promise<boolean> => {
-  return isValidPlatform(async () => {
-    const result = await OkHiNativeModule.canOpenProtectedAppsSettings();
-    return result;
-  }, 'android');
-};
-
-/**
- * Opens "Protected Apps Settings" available in Transsion Group android devices such as Infinix and Tecno
- * When your application is included in protected apps, verification processes are less likely to be terminated by the OS. Increasing rate of users being verified.
- */
-export const openProtectedAppsSettings = (): Promise<boolean> => {
-  return isValidPlatform(async () => {
-    const result = await OkHiNativeModule.openProtectedAppsSettings();
-    return result;
-  }, 'android');
-};
-
-const isAndroidNotificationGranted = async (): Promise<boolean> => {
-  return isValidPlatform(async () => {
-    const sdkVersion = await OkHiNativeModule.getSystemVersion();
-    if (Number(sdkVersion) < 33) {
-      return true;
-    }
-    const permission =
-      PermissionsAndroid.PERMISSIONS.POST_NOTIFICATIONS ||
-      PermissionsAndroid.PERMISSIONS.POST_NOTIFICATION;
-    if (!permission)
-      throw new Error('Unable to request notification permission');
-    const hasPermission = await PermissionsAndroid.check(
-      PermissionsAndroid.PERMISSIONS.POST_NOTIFICATIONS ||
-        (PermissionsAndroid.PERMISSIONS.POST_NOTIFICATION as Permission)
-    );
-    return hasPermission;
-  }, 'android');
-};
-
-const requestAndroidNotificationPermission = async (): Promise<boolean> => {
-  return isValidPlatform(async () => {
-    const existingPermissionStatus = await isAndroidNotificationGranted();
-    if (existingPermissionStatus) {
-      return true;
-    }
-    const status: any = await PermissionsAndroid.request(
-      PermissionsAndroid.PERMISSIONS.POST_NOTIFICATIONS as Permission
-    );
-    return status === 'granted';
-  }, 'android');
-};
-
-const isIOSNotificationGranted = async (): Promise<boolean> => {
-  return isValidPlatform(async () => {
-    return OkHiNativeModule.isNotificationPermissionGranted();
-  }, 'ios');
-};
-
-const requestIOSNotificationPermission = async (): Promise<boolean> => {
-  return isValidPlatform(async () => {
-    const existingPermissionStatus = await isIOSNotificationGranted();
-    if (existingPermissionStatus) {
-      return true;
-    }
-    return OkHiNativeModule.requestNotificationPermission();
-  }, 'ios');
-};
-
-/**
- * Checks whether notification permission is granted on both android and ios devices
- */
-export const isNotificationPermissionGranted = async (): Promise<boolean> => {
-  if (Platform.OS === 'android') {
-    return isAndroidNotificationGranted();
-  } else if (Platform.OS === 'ios') {
-    return isIOSNotificationGranted();
-  } else {
-    throw new OkHiException({
-      code: OkHiException.UNSUPPORTED_PLATFORM_CODE,
-      message: OkHiException.UNSUPPORTED_PLATFORM_MESSAGE,
-    });
-  }
-};
-
-/**
- * Requests notification permission from both android and ios devices
- */
-export const requestNotificationPermission = async (): Promise<boolean> => {
-  if (Platform.OS === 'android') {
-    return requestAndroidNotificationPermission();
-  } else if (Platform.OS === 'ios') {
-    return requestIOSNotificationPermission();
-  } else {
-    throw new OkHiException({
-      code: OkHiException.UNSUPPORTED_PLATFORM_CODE,
-      message: OkHiException.UNSUPPORTED_PLATFORM_MESSAGE,
-    });
-  }
-};
-
-/**
- * Determines the current location accuracy level of the device
- * @returns "no_permission" | "approximate" | "precise"
- */
-export const getLocationAccuracyLevel = async () => {
-  return OkHiNativeModule.getLocationAccuracyLevel();
-};