react-native-okhi 1.2.32-beta.6 → 2.0.1

package/lib/typescript/module/src/index.d.ts

@@ -1,10 +1,256 @@
+/**
+ * @packageDocumentation
+ * React Native OkHi SDK
+ *
+ * A comprehensive React Native library for address verification using OkHi's
+ * digital and physical verification methods.
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * // 1. Login
+ * await OkHi.login({
+ *   auth: { branchId: 'xxx', clientKey: 'xxx' },
+ *   user: { firstName: 'John', lastName: 'Doe', phone: '+254...', email: '...' },
+ * });
+ *
+ * // 2. Start verification
+ * const result = await OkHi.startDigitalAddressVerification();
+ * console.log('Verified address:', result.location.formattedAddress);
+ * ```
+ */
 import type { OkCollect, OkHiLogin, OkHiSuccessResponse } from './types';
-export type * from './types';
-export declare function multiply(a: number, b: number): number;
+export * from './types';
+/**
+ * Authenticates a user with the OkHi platform.
+ *
+ * @remarks
+ * This must be called before any verification functions. It establishes
+ * the user session and validates your API credentials.
+ *
+ * **When to call login:** The login function should be called once you have
+ * an authenticated user in your app. A common place to call login is immediately
+ * after the app dashboard is rendered, for example in a banking app after a user
+ * successfully signs in.
+ *
+ * It initializes OkHi and enables your users to resume verification if they
+ * switch devices, as well as enables re-verification of previously unknown addresses.
+ *
+ * The login persists for the duration of the app session.
+ *
+ * @param credentials - The login configuration containing auth credentials and user info
+ * @returns A promise that resolves with an array of permission strings that were granted,
+ *          or `null` if `withPermissionsRequest` was not enabled
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ * import type { OkHiLogin } from 'react-native-okhi';
+ *
+ * const credentials: OkHiLogin = {
+ *   auth: {
+ *     branchId: 'your_branch_id',
+ *     clientKey: 'your_client_key',
+ *   },
+ *   user: {
+ *     firstName: 'John',
+ *     lastName: 'Doe',
+ *     phone: '+254712345678',
+ *     email: 'john.doe@example.com',
+ *   },
+ * };
+ *
+ * try {
+ *   await OkHi.login(credentials);
+ *   console.log('Login successful');
+ * } catch (error) {
+ *   console.error('Login failed:', error);
+ * }
+ * ```
+ *
+ * @see {@link OkHiLogin} - Configuration type
+ * @see {@link startDigitalAddressVerification} - Call after login to verify addresses
+ */
 export declare function login(credentials: OkHiLogin): Promise<string[] | null>;
+/**
+ * @remarks
+ * Starts the digital address verification flow.
+ *
+ * **Prerequisites:**
+ * - Must call {@link login} first
+ *
+ * @param okcollect - Optional configuration for styling and behavior
+ * @returns A promise that resolves with the user and location data
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * // Basic usage with defaults
+ * const result = await OkHi.startDigitalAddressVerification();
+ * console.log('Address:', result.location.formattedAddress);
+ * console.log('Location ID:', result.location.id);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ * import type { OkCollect } from 'react-native-okhi';
+ *
+ * // With custom styling
+ * const config: OkCollect = {
+ *   style: {
+ *     color: '#FF5722',
+ *     logo: 'https://example.com/logo.png',
+ *   },
+ *   configuration: {
+ *     streetView: true,
+ *   },
+ * };
+ *
+ * const result = await OkHi.startDigitalAddressVerification(config);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * // Start verification on previously created address
+ * const locationId: string = await fetchLocationIDFromMyDB()
+ * const result = await OkHi.startDigitalAddressVerification({
+ *   locationId: locationId,
+ * });
+ * ```
+ *
+ * @see {@link OkCollect} - Configuration options
+ * @see {@link OkHiSuccessResponse} - Return type
+ * @see {@link startPhysicalAddressVerification} - For physical verification
+ * @see {@link startDigitalAndPhysicalAddressVerification} - For combined verification
+ */
 export declare function startDigitalAddressVerification(okcollect?: OkCollect): Promise<OkHiSuccessResponse>;
+/**
+ * Starts the physical address verification flow.
+ *
+ * @remarks
+ * Physical verification requires an agent to visit the user's location
+ * in person.
+ *
+ * **Prerequisites:**
+ * - Must call {@link login} first
+ *
+ * @param okcollect - Optional configuration for styling and behavior
+ * @returns A promise that resolves with the user and location data
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * const result = await OkHi.startPhysicalAddressVerification();
+ * console.log('Verification requested for:', result.location.formattedAddress);
+ * console.log('Location ID for tracking:', result.location.id);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * // With custom configuration
+ * const result = await OkHi.startPhysicalAddressVerification({
+ *   style: { color: '#2196F3' },
+ * });
+ * ```
+ *
+ * @see {@link OkCollect} - Configuration options
+ * @see {@link OkHiSuccessResponse} - Return type
+ * @see {@link startDigitalAddressVerification} - For instant digital verification
+ * @see {@link startDigitalAndPhysicalAddressVerification} - For combined verification
+ */
 export declare function startPhysicalAddressVerification(okcollect?: OkCollect): Promise<OkHiSuccessResponse>;
+/**
+ * Starts both digital and physical address verification flows.
+ *
+ * @remarks
+ * This combines both verification methods for maximum confidence.
+ *
+ * **Prerequisites:**
+ * - Must call {@link login} first
+ *
+ * @param okcollect - Optional configuration for styling and behavior
+ * @returns A promise that resolves with the user and location data
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * const result = await OkHi.startDigitalAndPhysicalAddressVerification();
+ * console.log('Physical + Digital Verification started for:', result.location.id);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * // With full customization
+ * const result = await OkHi.startDigitalAndPhysicalAddressVerification({
+ *   style: {
+ *     color: '#4CAF50',
+ *     logo: 'https://example.com/logo.png',
+ *   },
+ *   configuration: {
+ *     streetView: true,
+ *   },
+ * });
+ * ```
+ *
+ * @see {@link OkCollect} - Configuration options
+ * @see {@link OkHiSuccessResponse} - Return type
+ * @see {@link startDigitalAddressVerification} - For digital-only verification
+ * @see {@link startPhysicalAddressVerification} - For physical-only verification
+ */
 export declare function startDigitalAndPhysicalAddressVerification(okcollect?: OkCollect): Promise<OkHiSuccessResponse>;
+/**
+ * Creates an address without starting verification.
+ *
+ * @remarks
+ * Use this when you want to collect and store an address but defer
+ * verification to a later time. The address can
+ * be verified later using the returned `locationId`.
+ *
+ * **Prerequisites:**
+ * - Must call {@link login} first
+ *
+ * @param okcollect - Optional configuration for styling and behavior
+ * @returns A promise that resolves with the user and location data
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * // Create address without verification
+ * const result = await OkHi.createAddress();
+ * console.log('Address created:', result.location.id);
+ *
+ * // Save the location ID to verify later
+ * const locationId = result.location.id;
+ * await saveToDatabase({ locationId: locationId });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * // Later, verify the saved address
+ * const savedLocationId = await fetchLocationIdFromMyDB();
+ * const result = await OkHi.startDigitalAddressVerification({
+ *   locationId: savedLocationId,
+ * });
+ * ```
+ *
+ * @see {@link OkCollect} - Configuration options
+ * @see {@link OkHiSuccessResponse} - Return type
+ * @see {@link startDigitalAddressVerification} - To verify an address
+ */
 export declare function createAddress(okcollect?: OkCollect): Promise<OkHiSuccessResponse>;
 export declare function isLocationServicesEnabled(): Promise<boolean>;
 export declare function canOpenProtectedApps(): Promise<boolean>;

package/lib/typescript/module/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AACzE,mBAAmB,SAAS,CAAC;AAE7B,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,KAAK,CAAC,WAAW,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAMtE;AAuDD,wBAAgB,+BAA+B,CAC7C,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAED,wBAAgB,gCAAgC,CAC9C,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAED,wBAAgB,0CAA0C,CACxD,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAU9B;AAED,wBAAgB,aAAa,CAC3B,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAkCD,wBAAgB,yBAAyB,IAAI,OAAO,CAAC,OAAO,CAAC,CAM5D;AAED,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,OAAO,CAAC,CAMvD;AAED,wBAAgB,wBAAwB,IAAI,OAAO,CAAC,MAAM,CAAC,CAM1D;AAED,wBAAgB,qCAAqC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMxE;AAED,wBAAgB,iCAAiC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMpE;AAED,wBAAgB,+BAA+B,IAAI,OAAO,CAAC,OAAO,CAAC,CAMlE;AAED,wBAAgB,uBAAuB,IAAI,OAAO,CAAC,OAAO,CAAC,CAM1D;AAED,wBAAgB,mCAAmC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMtE;AAED,wBAAgB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAKjD;AAID,wBAAgB,yBAAyB,IAAI,OAAO,CAAC,OAAO,CAAC,CAM5D;AAED,wBAAgB,mCAAmC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMtE;AAED,wBAAgB,6BAA6B,IAAI,OAAO,CAAC,OAAO,CAAC,CAMhE;AAED,wBAAgB,kCAAkC,IAAI,OAAO,CAAC,OAAO,CAAC,CAarE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEzE,cAAc,SAAS,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAMtE;AAkDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,gCAAgC,CAC9C,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAgB,0CAA0C,CACxD,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAU9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,aAAa,CAC3B,SAAS,CAAC,EAAE,SAAS,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAgCD,wBAAgB,yBAAyB,IAAI,OAAO,CAAC,OAAO,CAAC,CAM5D;AAED,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,OAAO,CAAC,CAMvD;AAED,wBAAgB,wBAAwB,IAAI,OAAO,CAAC,MAAM,CAAC,CAM1D;AAED,wBAAgB,qCAAqC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMxE;AAED,wBAAgB,iCAAiC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMpE;AAED,wBAAgB,+BAA+B,IAAI,OAAO,CAAC,OAAO,CAAC,CAMlE;AAED,wBAAgB,uBAAuB,IAAI,OAAO,CAAC,OAAO,CAAC,CAM1D;AAED,wBAAgB,mCAAmC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMtE;AAED,wBAAgB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAKjD;AAED,wBAAgB,yBAAyB,IAAI,OAAO,CAAC,OAAO,CAAC,CAM5D;AAED,wBAAgB,mCAAmC,IAAI,OAAO,CAAC,OAAO,CAAC,CAMtE;AAED,wBAAgB,6BAA6B,IAAI,OAAO,CAAC,OAAO,CAAC,CAMhE;AAED,wBAAgB,kCAAkC,IAAI,OAAO,CAAC,OAAO,CAAC,CAerE"}