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

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

@@ -1,81 +1,617 @@
+/**
+ * Authentication credentials for the OkHi platform.
+ *
+ * @remarks
+ * These credentials are provided by OkHi when you register your application.
+ * You can find them in your OkHi dashboard under API Keys.
+ *
+ * @example
+ * ```typescript
+ * const auth: OkHiAuth = {
+ *   branchId: 'your_branch_id',
+ *   clientKey: 'your_client_key'
+ * };
+ * ```
+ *
+ * @see {@link OkHiLogin} - Used within the login configuration
+ */
 export type OkHiAuth = {
+    /**
+     * Your unique OkHi branch identifier.
+     * Obtained from the OkHi dashboard.
+     */
     branchId: string;
+    /**
+     * Your OkHi client API key.
+     */
     clientKey: string;
     env?: string;
 };
+/**
+ * User information for OkHi address verification.
+ *
+ * @remarks
+ * This type represents the user whose address is being verified.
+ * All contact information should be valid as it may be used for verification purposes.
+ * important: Make sure to use a phone number you own during testing!
+ *
+ * @example
+ * ```typescript
+ * const user: OkHiUser = {
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   phone: '+254712345678',
+ *   email: 'john.doe@example.com',
+ * };
+ * ```
+ *
+ * @see {@link OkHiLogin} - Used within the login configuration
+ * @see {@link OkHiSuccessResponse} - Enriched and returned after successful verification
+ */
 export type OkHiUser = {
+    /**
+     * User's first name.
+     */
     firstName: string;
+    /**
+     * User's last name.
+     */
     lastName: string;
+    /**
+     * User's phone number in international format.
+     * @example `'+254712345678'`
+     */
     phone: string;
+    /**
+     * User's email address.
+     */
     email: string;
+    /**
+     * OkHi's internal user identifier.
+     */
     okhiUserId?: string;
+    /**
+     * Managed internally by the SDK.
+     */
     token?: string;
+    /**
+     * Your application's internal user identifier.
+     * Use this to link OkHi verifications to your own user records.
+     *
+     * @example `'user_abc123'`
+     */
     appUserId?: string;
 };
+/**
+ * Application context information sent to OkHi.
+ *
+ * @remarks
+ * Provides metadata about your application for analytics and debugging purposes.
+ *
+ * @example
+ * ```typescript
+ * const appContext: OkHiAppContext = {
+ *   name: 'MyApp',
+ *   version: '1.2.3',
+ *   build: '456',
+ * };
+ * ```
+ *
+ * @see {@link OkHiLogin} - Used within the login configuration
+ */
 export type OkHiAppContext = {
+    /**
+     * Your application's name.
+     * @example `'MyLoanApp'`
+     */
     name: string;
+    /**
+     * Your application's version string.
+     * @example `'1.2.3'`
+     */
     version: string;
+    /**
+     * Your application's build number.
+     * @example `'456'`
+     */
     build: string;
 };
+/**
+ * Configuration options for the login process.
+ *
+ * @example
+ * ```typescript
+ * const loginConfig: OkHiLoginConfiguration = {
+ *   withPermissionsRequest: true, // Request permissions during login
+ * };
+ * ```
+ *
+ * @see {@link OkHiLogin} - Used within the login configuration
+ */
 export type OkHiLoginConfiguration = {
+    /**
+     * Whether to request required permissions during login.
+     * When `true`, the SDK will prompt for necessary permissions as part of the login flow.
+     *
+     * @defaultValue `false`
+     */
     withPermissionsRequest?: boolean;
 };
+/**
+ * Complete login configuration for authenticating with OkHi.
+ *
+ * @remarks
+ * This is the primary configuration object passed to the `login()` function.
+ * It combines authentication credentials, user information, and optional settings.
+ *
+ * @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',
+ *   },
+ *   configuration: {
+ *     withPermissionsRequest: true,
+ *   },
+ * };
+ *
+ * await OkHi.login(credentials);
+ * ```
+ */
 export type OkHiLogin = {
+    /**
+     * Authentication credentials for OkHi.
+     */
     auth: OkHiAuth;
+    /**
+     * User information.
+     */
     user: OkHiUser;
+    /**
+     * Optional login behavior configuration.
+     */
     configuration?: OkHiLoginConfiguration;
+    /**
+     * Optional application context for analytics.
+     */
     appContext?: OkHiAppContext;
 };
+/**
+ * Visual styling options for the OkCollect address collection UI.
+ *
+ * @remarks
+ * Customize the appearance of the address collection interface to match your app's branding.
+ *
+ * @example
+ * ```typescript
+ * const style: OkCollectStyle = {
+ *   color: '#FF5722', // Your brand's primary color
+ *   logo: 'https://example.com/logo.png',
+ * };
+ * ```
+ *
+ * @see {@link OkCollect} - Parent configuration type
+ */
 export type OkCollectStyle = {
+    /**
+     * Primary theme color for the UI in hexadecimal format.
+     * Applied to buttons, highlights, and accent elements.
+     *
+     * @defaultValue `'#005D67'` (OkHi teal)
+     * @example `'#FF5722'`
+     */
     color: string;
+    /**
+     * URL to your company logo.
+     * Displayed in the address collection header.
+     *
+     * @defaultValue `'https://cdn.okhi.co/icon.png'`
+     * @example `'https://example.com/logo.png'`
+     */
     logo: string;
 };
+/**
+ * Behavioral configuration options for the OkCollect address collection UI.
+ *
+ * @remarks
+ * Control which features are available during address collection.
+ *
+ * @example
+ * ```typescript
+ * const config: OkCollectConfig = {
+ *   streetView: true,
+ *   withAppBar: true,
+ * };
+ * ```
+ *
+ * @see {@link OkCollect} - Parent configuration type
+ */
 export type OkCollectConfig = {
+    /**
+     * Whether to enable Google Street View for address collection.
+     * When enabled, users can create addresses using street-level imagery.
+     *
+     * @defaultValue `true`
+     */
     streetView: boolean;
+    /**
+     * Whether to show "Home" as an address type option.
+     *
+     * @defaultValue `true`
+     */
     withHomeAddressType: boolean;
+    /**
+     * Whether to show "Work" as an address type option.
+     *
+     * @defaultValue `false`
+     */
     withWorkAddressType: boolean;
+    /**
+     * Whether to display the app bar (header) in the collection UI.
+     *
+     * @defaultValue `true`
+     */
     withAppBar: boolean;
 };
+/**
+ * Configuration options for address collection
+ *
+ * @remarks
+ * Pass this to verification functions to customize the address collection experience.
+ * All properties are optional - sensible defaults are applied automatically.
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ * import type { OkCollect } from 'react-native-okhi';
+ *
+ * // Use 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
+ * // Start verification on a previously created address.
+ * const locationId: string = await fetchLocationIdFromMyDatabase()
+ * const config: OkCollect = {
+ *   locationId,
+ * };
+ *
+ * const result = await startPhysicalAddressVerification(config);
+ * ```
+ */
 export type OkCollect = {
+    /**
+     * Visual styling options for the collection UI.
+     * Partial - only specify the properties you want to override.
+     */
     style?: Partial<OkCollectStyle>;
+    /**
+     * Behavioral configuration for the collection UI.
+     * Partial - only specify the properties you want to override.
+     */
     configuration?: Partial<OkCollectConfig>;
+    /**
+     * OkHi identifier for the address
+     * Use this to start verification on a previously created address.
+     */
     locationId?: string;
 };
+/**
+ * Comprehensive location data returned once verification starts successfully.
+ *
+ * @remarks
+ * Contains all available address information collected.
+ * Properties may be `null` if not available for the specific location.
+ *
+ * @example
+ * ```typescript
+ * const handleVerification = async () => {
+ *   const result = await OkHi.startDigitalAddressVerification();
+ *   const { location } = result;
+ *
+ *   console.log('Address:', location.formattedAddress);
+ *   console.log('Coordinates:', location.lat, location.lng);
+ *   console.log('Plus Code:', location.plusCode);
+ * };
+ * ```
+ *
+ * @see {@link OkHiSuccessResponse} - Parent response type
+ */
 export type OkHiLocation = {
+    /**
+     * Unique OkHi location identifier.
+     * Use this to reference the address in future API calls.
+     */
     id?: string | null;
+    /**
+     * Latitude coordinate of the location.
+     * @example `1.2921`
+     */
     lat?: number | null;
+    /**
+     * Longitude coordinate of the location.
+     * @example `36.8219`
+     */
     lng?: number | null;
+    /**
+     * Legacy not in use
+     */
     placeId?: string | null;
+    /**
+     * Open Location Code (Plus Code) for the address.
+     * A short, alphanumeric code that represents a geographic location.
+     *
+     * @see https://plus.codes/
+     * @example `'6GCRMQPX+JF'`
+     */
     plusCode?: string | null;
+    /**
+     * Name of the property (building, apartment complex, etc.).
+     * @example `'Sunrise Apartments'`
+     */
     propertyName?: string | null;
+    /**
+     * Name of the street.
+     * @example `'Ngong Road'`
+     */
     streetName?: string | null;
+    /**
+     * System generated title for the address.
+     */
     title?: string | null;
+    /**
+     * System generated subtitle for the address.
+     */
     subtitle?: string | null;
+    /**
+     * User-provided directions to the location.
+     */
     directions?: string | null;
+    /**
+     * Additional information about the location.
+     */
     otherInformation?: string | null;
+    /**
+     * OkHi URL for the address.
+     * Can be shared for navigation purposes.
+     */
     url?: string | null;
+    /**
+     * Google Street View panorama ID.
+     * Used to display street-level imagery.
+     */
     streetViewPanoId?: string | null;
+    /**
+     * URL to the Google Street View panorama image.
+     */
     streetViewPanoUrl?: string | null;
+    /**
+     * OkHi user ID associated with this location.
+     */
     userId?: string | null;
+    /**
+     * URL to a photo of the location.
+     */
     photoUrl?: string | null;
+    /**
+     * Property or house number.
+     * @example `'42'`
+     */
     propertyNumber?: string | null;
+    /**
+     * Country name.
+     * @example `'Kenya'`
+     */
     country?: string | null;
+    /**
+     * State, province, or region.
+     * @example `'Nairobi'`
+     */
     state?: string | null;
+    /**
+     * City or town name.
+     * @example `'Nairobi'`
+     */
     city?: string | null;
+    /**
+     * Display-friendly title for the address.
+     * Formatted for showing in UI.
+     */
     displayTitle?: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country code.
+     * @example `'KE'`
+     */
     countryCode?: string | null;
+    /**
+     * Neighborhood or locality name.
+     * @example `'Westlands'`
+     */
     neighborhood?: string | null;
+    /**
+     * Used internally by the SDK
+     */
     usageTypes?: string[] | null;
+    /**
+     * Administrative ward.
+     * Common in African addressing systems.
+     */
     ward?: string | null;
+    /**
+     * Complete formatted address string.
+     * @example `'Sunrise Apartments, Ngong Road, Westlands, Nairobi, Kenya'`
+     */
     formattedAddress?: string | null;
+    /**
+     * Postal or ZIP code.
+     */
     postCode?: string | null;
 };
-export type OkHiException = {
-    code: string;
-    message: string;
-};
 export type OkHiSuccessResponse = {
+    /**
+     * User information.
+     * @see {@link OkHiUser}
+     */
     user: OkHiUser;
+    /**
+     * Location data.
+     * @see {@link OkHiLocation}
+     */
     location: OkHiLocation;
 };
+/**
+ * Standard error codes returned by OkHi operations.
+ *
+ * These codes are consistent across iOS and Android platforms.
+ */
+export type OkHiErrorCode = 'fatal_exit' | 'user_closed' | 'unknown' | 'network_error' | 'permission_denied' | 'service_unavailable' | 'unsupported_device' | 'unauthenticated' | 'invalid_phone';
+/**
+ * Error class for OkHi operations.
+ *
+ * @remarks
+ * All OkHi functions that can fail will throw an `OkHiException`.
+ * Use the static code constants for type-safe error handling in switch statements.
+ *
+ * @example
+ * ```typescript
+ * import * as OkHi from 'react-native-okhi';
+ *
+ * try {
+ *   const result = await OkHi.startDigitalAddressVerification();
+ * } catch (error) {
+ *   if (error instanceof OkHi.OkHiException) {
+ *     switch (error.code) {
+ *       case OkHi.OkHiException.USER_CLOSED:
+ *         console.log('User cancelled the verification');
+ *         break;
+ *       case OkHi.OkHiException.NETWORK_ERROR:
+ *         console.log('Network issue:', error.message);
+ *         break;
+ *       case OkHi.OkHiException.PERMISSION_DENIED:
+ *         console.log('Permission denied:', error.message);
+ *         break;
+ *       default:
+ *         console.log('Error:', error.code, error.message);
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare class OkHiException extends Error {
+    /**
+     * A fatal error occurred that caused the SDK to exit unexpectedly.
+     */
+    static readonly FATAL_EXIT: OkHiErrorCode;
+    /**
+     * The user dismissed or closed the verification flow.
+     */
+    static readonly USER_CLOSED: OkHiErrorCode;
+    /**
+     * An unknown or unexpected error occurred.
+     */
+    static readonly UNKNOWN: OkHiErrorCode;
+    /**
+     * A network connectivity error occurred.
+     */
+    static readonly NETWORK_ERROR: OkHiErrorCode;
+    /**
+     * Required permissions were not granted.
+     */
+    static readonly PERMISSION_DENIED: OkHiErrorCode;
+    /**
+     * The OkHi service is temporarily unavailable.
+     */
+    static readonly SERVICE_UNAVAILABLE: OkHiErrorCode;
+    /**
+     * The device is not supported (e.g., missing Play Services, unsupported platform).
+     */
+    static readonly UNSUPPORTED_DEVICE: OkHiErrorCode;
+    /**
+     * Authentication failed. Call `login()` with valid credentials.
+     */
+    static readonly UNAUTHENTICATED: OkHiErrorCode;
+    /**
+     * The phone number provided is invalid.
+     */
+    static readonly INVALID_PHONE: OkHiErrorCode;
+    /**
+     * Machine-readable error code.
+     * Use this for programmatic error handling with switch statements.
+     *
+     * @example
+     * ```typescript
+     * if (error.code === OkHi.OkHiException.USER_CLOSED) {
+     *   // Handle user cancellation
+     * }
+     * ```
+     */
+    readonly code: OkHiErrorCode;
+    /**
+     * Creates a new OkHiException.
+     *
+     * @param code - The error code
+     * @param message - Human-readable error description
+     */
+    constructor(code: OkHiErrorCode, message: string);
+    /**
+     * Normalizes error codes from native SDKs to standard OkHi error codes.
+     *
+     * @param nativeCode - The error code received from native SDK
+     * @returns The normalized OkHiErrorCode
+     *
+     * @internal
+     */
+    static normalizeCode(nativeCode: string | undefined | null): OkHiErrorCode;
+    /**
+     * Creates an OkHiException from a native error object.
+     *
+     * @param error - The error object from native SDK
+     * @returns A new OkHiException instance
+     *
+     * @internal
+     */
+    static fromNativeError(error: {
+        code?: string;
+        message?: string;
+    }): OkHiException;
+    /**
+     * Type guard to check if an error is an OkHiException.
+     *
+     * @param error - The error to check
+     * @returns True if the error is an OkHiException
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   await OkHi.startDigitalAddressVerification();
+     * } catch (error) {
+     *   if (OkHi.OkHiException.isOkHiException(error)) {
+     *     console.log(error.code, error.message);
+     *   }
+     * }
+     * ```
+     */
+    static isOkHiException(error: unknown): error is OkHiException;
+}
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;IACf,aAAa,CAAC,EAAE,sBAAsB,CAAC;IACvC,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,sBAAsB,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;OAKG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAEhC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAEzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,aAAa,GACb,SAAS,GACT,eAAe,GACf,mBAAmB,GACnB,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,eAAe,CAAC;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAgB;IAEzD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAiB;IAE3D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAa;IAEnD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAmB;IAE/D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,aAAa,CAAuB;IAEvE;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,aAAa,CAAyB;IAE3E;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,aAAa,CAAwB;IAEzE;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAqB;IAEnE;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAmB;IAE/D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAE7B;;;;;OAKG;gBACS,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM;IAWhD;;;;;;;OAOG;IACH,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,aAAa;IAgC1E;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;QAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,aAAa;IAMjB;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa;CAG/D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-okhi",
-  "version": "1.2.32-beta.6",
+  "version": "2.0.1",
   "description": "The OkHi React Native library enables you to collect and verify addresses from your users",
   "license": "MIT",
   "repository": "https://github.com/OkHi/react-native-okhi",
@@ -60,7 +60,8 @@
     "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
     "prepare": "bob build",
     "typecheck": "tsc",
-    "lint": "eslint \"**/*.{js,ts,tsx}\""
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "docs": "typedoc"
   },
   "peerDependencies": {
     "react": "*",
@@ -86,6 +87,7 @@
     "react-native": "0.83.0",
     "react-native-builder-bob": "^0.40.13",
     "turbo": "^2.5.6",
+    "typedoc": "^0.28.16",
     "typescript": "^5.9.2"
   },
   "react-native-builder-bob": {

package/src/NativeOkhi.ts

@@ -1,7 +1,6 @@
 import { TurboModuleRegistry, type TurboModule } from 'react-native';
 
 export interface Spec extends TurboModule {
-  multiply(a: number, b: number): number;
   login(
     credentials: Object,
     callback: (results: string[] | null) => void