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

package/src/OkCore/OkHiException.ts

@@ -1,93 +0,0 @@
-import type { OkHiError } from './types';
-
-/**
- * The OkHiException class extends the Error class to provide additional information regarding the type of errors thrown while running any OkHiLibraries.
- * It contains static string properties that can be used to evaluate the kind of errors being thrown and handle them appropriately.
- */
-export class OkHiException extends Error {
-  /**
-   * Error is thrown when location services is unavailable.
-   */
-  static LOCATION_SERVICES_UNAVAILABLE_CODE = 'location_services_unavailable';
-
-  /**
-   * Error is thrown when play services is unavailable.
-   */
-  static PLAY_SERVICES_UNAVAILABLE_CODE = 'play_services_unavailable';
-  /**
-   * Error is thrown when the device can't connect to OkHi's servers.
-   */
-  static NETWORK_ERROR_CODE = 'network_error';
-  /**
-   * Error is thrown when the device can't connect to OkHi's servers.
-   */
-  static NETWORK_ERROR_MESSAGE =
-    'Unable to establish a connection with OkHi servers';
-  /**
-   * Error is thrown whenever there's an unknown error that occured during the usage of one of OkHi's services.
-   */
-  static UNKNOWN_ERROR_CODE = 'unknown_error';
-  /**
-   * Error is thrown whenever there's an unknown error that occured during the usage of one of OkHi's services.
-   */
-  static UNKNOWN_ERROR_MESSAGE =
-    'Unable to process the request. Something went wrong';
-  /**
-   * Error is thrown whenever an invalid phone number is provided to a service that requires a user's phone number.
-   */
-  static INVALID_PHONE_CODE = 'invalid_phone';
-  /**
-   * Error is thrown whenever an invalid phone number is provided to a service that requires a user's phone number.
-   */
-  static INVALID_PHONE_MESSAGE =
-    'Invalid phone number provided. Please make sure its in MSISDN standard format';
-  /**
-   * Error is thrown whenever there's an issue with the credentials provided.
-   */
-  static UNAUTHORIZED_CODE = 'unauthorized';
-  /**
-   * Error is thrown whenever there's an issue with the credentials provided.
-   */
-  static UNAUTHORIZED_MESSAGE = 'Invalid credentials provided';
-  /**
-   * Error is thrown whenever a particular permission is required for a service to run and isn't granted by the user.
-   */
-  static PERMISSION_DENIED_CODE = 'permission_denied';
-  /**
-   * Error is thrown whenever a particular device service is required for a library to run and isn't granted by the user.
-   */
-  static SERVICE_UNAVAILABLE_CODE = 'service_unavailable';
-  /**
-   * Error is thrown whenever an OkHi service is run on an unsupported platform.
-   */
-  static UNSUPPORTED_PLATFORM_CODE = 'unsupported_platform';
-  /**
-   * Error is thrown whenever an OkHi service is run on an unsupported platform.
-   */
-  static UNSUPPORTED_PLATFORM_MESSAGE = 'Current platform is not supported';
-  /**
-   * Error is thrown whenever bad configuration is provided to an OkHi service.
-   */
-  static BAD_REQUEST_CODE = 'bad_request';
-  /**
-   * Error is thrown whenever bad configuration is provided to an OkHi service.
-   */
-  static BAD_REQUEST_MESSAGE = 'Invalid parameters provided';
-
-  /**
-   * Specific error code string detailing the kind of error being thrown.
-   */
-  code: string;
-
-  /**
-   * @param error An error object with code and respective message.
-   * @param error.code Specific error code string detailing the kind of error being thrown.
-   * @param error.message Specific error message string detailing the kind of error being thrown.
-   */
-  constructor(error: OkHiError) {
-    super(error.message);
-    this.name = 'OkHiException';
-    this.message = error.message;
-    this.code = error.code;
-  }
-}

package/src/OkCore/OkHiMode.ts

@@ -1,7 +0,0 @@
-/**
- * Sets the current mode that you'd like to use OkHi's services.
- */
-export const OkHiMode: { SANDBOX: string; PROD: string } = Object.freeze({
-  SANDBOX: 'sandbox',
-  PROD: 'prod',
-});

package/src/OkCore/_helpers.ts

@@ -1,47 +0,0 @@
-import { Platform, PlatformOSType } from 'react-native';
-import { OkHiException } from './OkHiException';
-
-const SUPPORTED_PLATFORMS = ['ios', 'android'];
-
-export function isValidPlatform<T>(
-  fn: () => Promise<T>,
-  platform?: PlatformOSType
-) {
-  return new Promise<T>((resolve, reject) => {
-    const error = new OkHiException({
-      code: OkHiException.UNSUPPORTED_PLATFORM_CODE,
-      message: 'function is not supported in ' + Platform.OS,
-    });
-    if (platform && Platform.OS !== platform) {
-      reject(error);
-    } else if (!SUPPORTED_PLATFORMS.includes(Platform.OS)) {
-      reject(error);
-    } else {
-      fn()
-        .then(resolve)
-        .catch((error) => {
-          reject(
-            new OkHiException({
-              code: error.code || OkHiException.UNKNOWN_ERROR_CODE,
-              message: error.message || OkHiException.UNKNOWN_ERROR_MESSAGE,
-            })
-          );
-        });
-    }
-  });
-}
-
-export function errorHandler<T>(fn: () => Promise<T>) {
-  return new Promise<T>((resolve, reject) => {
-    fn()
-      .then(resolve)
-      .catch((error) => {
-        reject(
-          new OkHiException({
-            code: error.code || OkHiException.UNKNOWN_ERROR_CODE,
-            message: error.message || OkHiException.UNKNOWN_ERROR_MESSAGE,
-          })
-        );
-      });
-  });
-}

package/src/OkCore/_types.ts

@@ -1,37 +0,0 @@
-/**
- * @ignore
- */
-export type OkHiAccessScope = 'verify' | 'address' | 'checkout' | 'profile';
-
-export type OkHiInitializationConfiguration = {
-  credentials: { branchId: string; clientKey: string };
-  context: {
-    mode: string;
-    platform: 'react-native';
-    developer: 'okhi' | 'external';
-  };
-  app?: {
-    name?: string | null;
-    version?: string | null;
-    build?: number | null;
-  };
-};
-
-export type AuthApplicationConfig = {
-  auth: {
-    token: string;
-  };
-  credentials: {
-    branchId: string;
-    clientKey: string;
-  };
-  context: {
-    mode: 'sandbox' | 'prod';
-    developer?: 'okhi' | 'external';
-  };
-  app?: {
-    name?: string;
-    version?: string;
-    build?: string;
-  };
-};

package/src/OkCore/index.ts

@@ -1,87 +0,0 @@
-import { Platform, AppState } from 'react-native';
-import { OkHiNativeModule } from '../OkHiNativeModule';
-import type { OkHiApplicationConfiguration } from './types';
-import { errorHandler } from './_helpers';
-import type { AuthApplicationConfig } from './_types';
-import { OkHiException } from './OkHiException';
-
-export * from './types';
-export * from './OkHiException';
-export * from './OkHiMode';
-export * from './Helpers';
-
-let okhiApplicationConfiguration: OkHiApplicationConfiguration | undefined;
-
-function validateConfiguration(config: OkHiApplicationConfiguration) {
-  if (
-    typeof config !== 'object' ||
-    config === null ||
-    !config.credentials ||
-    typeof config.credentials.branchId !== 'string' ||
-    config.credentials.branchId.trim().length === 0 ||
-    typeof config.credentials.clientKey !== 'string' ||
-    config.credentials.clientKey.trim().length === 0
-  ) {
-    return false;
-  }
-  return true;
-}
-/**
- * Initializes the OkHi library with provided API keys
- * @param {Object} configuration A configuration object with your OkHi credentials as well as library settings
- * @returns {Promise<void>} A promise that resolves when initialization is successful
- */
-export function initialize(
-  configuration: OkHiApplicationConfiguration
-): Promise<void> {
-  if (!configuration.user || !configuration.user.phone) {
-    console.warn(
-      '[OkHi] Missing user in configuration object. Providing a user helps verify previous addresses. See https://docs.okhi.com'
-    );
-  }
-  return errorHandler(async () => {
-    const isValidConfig = validateConfiguration(configuration);
-    if (!isValidConfig) {
-      throw new OkHiException({
-        code: OkHiException.UNAUTHORIZED_CODE,
-        message: 'Invalid OkHi configuration provided.',
-      });
-    }
-    okhiApplicationConfiguration = configuration;
-    if (Platform.OS === 'ios') {
-      await OkHiNativeModule.initializeIOS(
-        configuration.credentials.branchId,
-        configuration.credentials.clientKey,
-        configuration.context.mode
-      );
-      if (AppState.currentState !== 'background') {
-        await OkHiNativeModule.onStart();
-      }
-    } else {
-      await OkHiNativeModule.initialize(JSON.stringify(configuration));
-    }
-  });
-}
-
-/**
- * Obtains your current running configuration
- * @returns {Promise<void>} A promise that resolves with your application configuration
- */
-export async function getApplicationConfiguration(): Promise<AuthApplicationConfig | null> {
-  try {
-    if (typeof okhiApplicationConfiguration === 'object') {
-      return {
-        ...okhiApplicationConfiguration,
-        auth: {
-          token: await OkHiNativeModule.getAuthToken(
-            okhiApplicationConfiguration?.credentials.branchId || '',
-            okhiApplicationConfiguration?.credentials.clientKey || ''
-          ),
-        },
-      };
-    }
-    return null;
-  } catch (error) {
-    throw error;
-  }
-}

package/src/OkCore/types.ts

@@ -1,235 +0,0 @@
-import type { OkHiException } from './OkHiException';
-
-/**
- * Defines the structure of the user object requried by OkHi services and libraries.
- */
-export interface OkHiUser {
-  /**
-   * The user's phone number. Must be MSISDN standard format. e.g +254712345678.
-   */
-  phone: string;
-  /**
-   * The user's first name.
-   */
-  firstName?: string;
-  /**
-   * The user's last name.
-   */
-  lastName?: string;
-  /**
-   * The user's email address.
-   */
-  email?: string;
-  /**
-   * The OkHi's userId. Usually obtained after a user successfully creates an OkHi address.
-   */
-  id?: string;
-
-  /**
-   * @deprecated This field is no longer used.
-   */
-  fcmPushNotificationToken?: string;
-
-  /**
-   * The user's jwt token provided by OkHi after address creation.
-   */
-  token?: string;
-
-  /**
-   * Your assigned user id
-   */
-  appUserId?: string;
-}
-
-/**
- * Defines the current mode you'll be using OkHi's services as well as your application's meta information.
- */
-export interface OkHiAppContext {
-  /**
-   * The current mode you'll be using OkHi services.
-   */
-  mode: 'sandbox' | 'prod' | string;
-  /**
-   * Your application's meta information.
-   */
-  app?: {
-    /**
-     * Your application's name.
-     */
-    name: string;
-    /**
-     * Your application's current version.
-     */
-    version: string;
-    /**
-     * Your application's current build number.
-     */
-    build: number;
-  };
-  /**
-   * Meta information about the current developer.
-   */
-  developer?: string;
-}
-
-/**
- * Defines the structure of the OkHi location object once an address has been successfully created by the user.
- */
-export interface OkHiLocation {
-  /**
-   * The latitude of the location.
-   */
-  lat: number;
-  /**
-   * The longitude of the location.
-   */
-  lon: number;
-  /**
-   * The OkHi's locationId. Usually obtained once an address has been successfully created by the user.
-   */
-  id?: string;
-  /**
-   * The id of a common residential or geological space such as apartment building or office block.
-   */
-  placeId?: string;
-  /**
-   * Geocode system for identifying an area anywhere on the Earth.
-   * See https://plus.codes/
-   */
-  plusCode?: string;
-  /**
-   * The location's property name.
-   */
-  propertyName?: string;
-  /**
-   * The location's street name.
-   */
-  streetName?: string;
-  /**
-   * A string that can be used to render information about the location.
-   */
-  title?: string;
-  /**
-   * A string that can be used to render meta information about the location.
-   */
-  subtitle?: string;
-  /**
-   * User generated directions to the location.
-   */
-  directions?: string;
-  /**
-   * User generated meta information about the location, how to access it and any other relevant notes.
-   */
-  otherInformation?: string;
-  /**
-   * A link to the user's address visible on browser or desktop.
-   */
-  url?: string;
-  /**
-   * A Google's StreetView Panorama Id, if the address was created using Google StreetView.
-   * See: https://developers.google.com/maps/documentation/javascript/streetview
-   */
-  streetViewPanoId?: string;
-  /**
-   * A Google's StreetView Panorama Url, if the address was created using Google StreetView.
-   * See: https://developers.google.com/maps/documentation/javascript/streetview
-   */
-  streetViewPanoUrl?: string;
-  /**
-   * The OkHi's userId. Usually obtained after a user successfully creates an OkHi address.
-   */
-  userId?: string;
-  /**
-   * The location's property number.
-   */
-  propertyNumber?: string;
-  /**
-   * A link to the location's gate photo.
-   */
-  photo?: string;
-
-  /**
-   * A user's country
-   */
-  country?: string;
-
-  /**
-   * A user's city
-   */
-  city?: string;
-
-  /**
-   * A user's state
-   */
-  state?: string;
-
-  /**
-   * A formatted location information
-   */
-  displayTitle?: string;
-
-  /**
-   * A user's country code
-   */
-  countryCode?: string;
-
-  /**
-   * An array of usage types that specifies the mode of verification. Can include "physical_verification" and/or "digital_verification" as valid values.
-   */
-  usageTypes?: UsageType;
-}
-
-/**
- * @ignore
- */
-export interface OkHiError {
-  code: string;
-  message: string;
-}
-
-export type OkHiApplicationConfiguration = {
-  credentials: {
-    branchId: string;
-    clientKey: string;
-  };
-  context: {
-    mode: 'sandbox' | 'prod';
-    developer?: 'okhi' | 'external';
-  };
-  app?: {
-    name?: string;
-    version?: string;
-    build?: string;
-  };
-  notification?: {
-    title: string;
-    text: string;
-    channelId: string;
-    channelName: string;
-    channelDescription: string;
-  };
-  user?: OkHiUser;
-};
-
-export type LocationPermissionStatus =
-  | 'notDetermined'
-  | 'restricted'
-  | 'denied'
-  | 'authorizedAlways'
-  | 'authorizedWhenInUse'
-  | 'authorized'
-  | 'unknown';
-
-export type LocationPermissionStatusCallback =
-  | LocationPermissionStatus
-  | 'rationaleDissmissed';
-export type LocationRequestPermissionType = 'whenInUse' | 'always';
-
-export type LocationPermissionCallback = (
-  status: LocationPermissionStatusCallback | null,
-  error: OkHiException | null
-) => any;
-
-export type UsageType = Array<
-  'physical_verification' | 'digital_verification' | 'address_book'
->;

package/src/OkHiNativeModule/index.ts

@@ -1,92 +0,0 @@
-import { NativeModules, NativeEventEmitter, Platform } from 'react-native';
-
-const LINKING_ERROR =
-  `The package 'react-native-okhi' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo managed workflow\n';
-
-type OkHiNativeModuleType = {
-  isLocationServicesEnabled(): Promise<boolean>;
-  isLocationPermissionGranted(): Promise<boolean>;
-  isBackgroundLocationPermissionGranted(): Promise<boolean>;
-  requestLocationPermission(): Promise<boolean>;
-  requestBackgroundLocationPermission(): Promise<boolean>;
-  requestEnableLocationServices(): Promise<boolean>;
-  isGooglePlayServicesAvailable(): Promise<boolean>;
-  requestEnableGooglePlayServices(): Promise<boolean>;
-  getSystemVersion(): Promise<number | string>;
-  getAuthToken(branchId: string, clientKey: string): Promise<string>;
-  initialize(configuration: string): Promise<void>;
-  startAddressVerification(
-    token: string,
-    phoneNumber: string,
-    userId: string,
-    locationId: string,
-    lat: Number,
-    lon: Number,
-    usageTypes: string[]
-  ): Promise<string>;
-  stopAddressVerification(
-    phoneNumber: string,
-    locationId: string
-  ): Promise<string>;
-  startForegroundService(): Promise<boolean>;
-  stopForegroundService(): Promise<boolean>;
-  isForegroundServiceRunning(): Promise<boolean>;
-  initializeIOS(
-    branchId: string,
-    clientKey: string,
-    environment: string
-  ): Promise<boolean>;
-  openAppSettings(): Promise<void>;
-  retriveLocationPermissionStatus(): Promise<string>;
-  requestTrackingAuthorization(): Promise<string | null>;
-  canOpenProtectedAppsSettings(): Promise<boolean>;
-  openProtectedAppsSettings(): Promise<boolean>;
-  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>;
-  isNotificationPermissionGranted(): Promise<boolean>;
-  requestNotificationPermission(): Promise<boolean>;
-  fetchCurrentLocation(): Promise<null | {
-    lat: number;
-    lng: number;
-    accuracy: number;
-  }>;
-  fetchIOSLocationPermissionStatus(): Promise<
-    | 'notDetermined'
-    | 'restricted'
-    | 'denied'
-    | 'authorizedAlways'
-    | 'authorizedWhenInUse'
-    | 'authorized'
-    | 'unknown'
-  >;
-  onStart(): Promise<boolean>;
-  fetchRegisteredGeofences(): Promise<string | null>;
-  getLocationAccuracyLevel(): Promise<
-    'no_permission' | 'approximate' | 'precise'
-  >;
-};
-
-export const OkHiNativeModule: OkHiNativeModuleType = NativeModules.Okhi
-  ? NativeModules.Okhi
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
-
-export const OkHiNativeEvents = new NativeEventEmitter(NativeModules.Okhi);
-
-OkHiNativeEvents.addListener('onLocationPermissionStatusUpdate', () => null);