otpless-headless-rn 2.2.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "otpless-headless-rn",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "react native plugin for otpless headless android and ios",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -41,7 +41,10 @@
     "ios",
     "android"
   ],
-  "repository": "https://github.com/otpless-tech/react-native-headless-sdk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/otpless-tech/react-native-headless-sdk.git"
+  },
   "author": "https://github.com/sparsh-otpless",
   "license": "MIT",
   "bugs": {

package/src/index.tsx

@@ -3,7 +3,11 @@ import type {
   OtplessTruecallerRequest,
   OtplessAuthEvent,
   OtplessProviderType,
+  OtplessRequestInput,
+  OtplessBackgroundAuthConfig,
+  OtplessInitOptions,
 } from './models';
+import { otplessRnVersion } from './version';
 
 const LINKING_ERROR =
   `The package 'otpless-headless-rn' doesn't seem to be linked. Make sure: \n\n` +
@@ -22,6 +26,23 @@ const OtplessHeadlessRN = NativeModules.OtplessHeadlessRN
       }
     );
 
+/**
+ * Wrapper-attribution token sent to the native SDKs at `initialize`.
+ *
+ * Computed here, in JS, so `otplessRnVersion` is the single source of truth:
+ * the Kotlin and Swift bridges only forward whatever arrives over the bridge,
+ * instead of each hardcoding a version that would drift on every release.
+ *
+ * Emitted by the native device-telemetry event as:
+ * - Android - `otpless-headless-sdk(react-native-android-<version>)`
+ * - iOS - `otpless-headless(react-native-ios-<version>)`
+ *
+ * The `react-native-` prefix distinguishes this package from the sibling
+ * wrappers (`react-native-lite-*`, `react-native-turbo-*`), which share the
+ * same iOS telemetry prefix.
+ */
+const BUILD_PLATFORM = `react-native-${Platform.OS}-${otplessRnVersion}`;
+
 interface OtplessResultCallback {
   (result: any): void;
 }
@@ -37,19 +58,31 @@ class OtplessHeadlessModule {
     this.eventEmitter?.removeAllListeners('OTPlessEventResult');
   }
 
-  initialize(appId: String, loginUri: string | null = null) {
+  initialize(
+    appId: string,
+    loginUri: string | null = null,
+    options: OtplessInitOptions | null = null
+  ) {
     if (this.eventEmitter == null) {
       this.eventEmitter = new NativeEventEmitter(OtplessHeadlessRN);
     }
-    // call the native method
-    OtplessHeadlessRN.initialize(appId, loginUri);
+    // call the native method; sslPinning is a plain string so an older
+    // native module degrades to pinning disabled. buildPlatform is internal
+    // wrapper attribution, not a merchant-facing parameter; the native bridges
+    // fall back to a bare "react-native-<platform>" if it ever arrives blank.
+    OtplessHeadlessRN.initialize(
+      appId,
+      loginUri,
+      options?.sslPinning ?? 'disabled',
+      BUILD_PLATFORM
+    );
   }
 
   setResponseCallback(callback: OtplessResultCallback) {
     this.eventEmitter?.addListener('OTPlessEventResult', callback);
   }
 
-  start(input: any) {
+  start(input: OtplessRequestInput) {
     OtplessHeadlessRN.start(input);
   }
 
@@ -81,6 +114,41 @@ class OtplessHeadlessModule {
     OtplessHeadlessRN.setDevLogging(enable);
   }
 
+  setMfaEnabled(enabled: boolean) {
+    OtplessHeadlessRN.setMfaEnabled(enabled);
+  }
+
+  async startBackgroundAuth(
+    config: OtplessBackgroundAuthConfig
+  ): Promise<boolean> {
+    return await OtplessHeadlessRN.startBackgroundAuth(config);
+  }
+
+  startInBackground(input: OtplessRequestInput) {
+    if (Platform.OS === 'android') {
+      OtplessHeadlessRN.startInBackground(input);
+    }
+  }
+
+  setSimBindingEnabled(enabled: boolean) {
+    if (Platform.OS === 'android') {
+      OtplessHeadlessRN.setSimBindingEnabled(enabled);
+    }
+  }
+
+  async checkSimBindingStatus(): Promise<boolean> {
+    if (Platform.OS === 'android') {
+      return await OtplessHeadlessRN.checkSimBindingStatus();
+    }
+    return false;
+  }
+
+  async clearSimBinding(): Promise<void> {
+    if (Platform.OS === 'android') {
+      await OtplessHeadlessRN.clearSimBinding();
+    }
+  }
+
   async isSdkReady(): Promise<boolean> {
     return await OtplessHeadlessRN.isSdkReady();
   }
@@ -92,22 +160,18 @@ class OtplessHeadlessModule {
     return false;
   }
 
-  // Android only — OtplessBM (iOS) has no equivalent.
   userAuthEvent(
     event: OtplessAuthEvent,
     providerType: OtplessProviderType,
     fallback: boolean = false,
-    providerInfo: any = {} // `any` avoids Record<string,string> conflicts across RN versions
+    providerInfo: any = {}
   ) {
-    if (Platform.OS === 'android') {
-      // args reordered to match Kotlin bridge: (event, fallback, providerType, providerInfo)
-      OtplessHeadlessRN.userAuthEvent(
-        event,
-        fallback,
-        providerType,
-        providerInfo
-      );
-    }
+    OtplessHeadlessRN.userAuthEvent(
+      event,
+      fallback,
+      providerType,
+      providerInfo
+    );
   }
 }
 

package/src/models.tsx

@@ -1,10 +1,8 @@
-
 export interface OtplessTruecallerRequest {
-    trueCallerRequest?: OtplessTruecallerConfig;
-    scope: Array<OTScope>;
+  trueCallerRequest?: OtplessTruecallerConfig;
+  scope: Array<OTScope>;
 }
 
-
 export interface OtplessTruecallerConfig {
   footerType?: OTFooterType;
   shape?: OTButtonShape;
@@ -17,78 +15,142 @@ export interface OtplessTruecallerConfig {
   buttonTextColor?: number;
 }
 
-export type OTScope = "profile" | "phone" | "open_id" | "offline_access" | "email" | "address";
+export type OTScope =
+  | 'profile'
+  | 'phone'
+  | 'open_id'
+  | 'offline_access'
+  | 'email'
+  | 'address';
 
 export type OTFooterType =
-    | 'footer_type_skip'
-    | 'footer_type_another_mobile_no'
-    | 'footer_type_another_method'
-    | 'footer_type_manually'
-    | 'footer_type_later';
-
-export type OTButtonShape =
-    | 'button_shape_rounded'
-    | 'button_shape_rectangle';
+  | 'footer_type_skip'
+  | 'footer_type_another_mobile_no'
+  | 'footer_type_another_method'
+  | 'footer_type_manually'
+  | 'footer_type_later';
 
+export type OTButtonShape = 'button_shape_rounded' | 'button_shape_rectangle';
 
 export type OTVerifyOption =
-    | 'option_verify_only_tc_users'
-    | 'option_verify_all_users';
-
+  | 'option_verify_only_tc_users'
+  | 'option_verify_all_users';
 
 export type OTHeadingConsent =
-    | 'sdk_consent_heading_log_in_to'
-    | 'sdk_consent_heading_sign_up_with'
-    | 'sdk_consent_heading_sign_in_to'
-    | 'sdk_consent_heading_verify_number_with'
-    | 'sdk_consent_heading_register_with'
-    | 'sdk_consent_heading_get_started_with'
-    | 'sdk_consent_heading_proceed_with'
-    | 'sdk_consent_heading_verify_with'
-    | 'sdk_consent_heading_verify_profile_with'
-    | 'sdk_consent_heading_verify_your_profile_with'
-    | 'sdk_consent_heading_verify_phone_no_with'
-    | 'sdk_consent_heading_verify_your_no_with'
-    | 'sdk_consent_heading_continue_with'
-    | 'sdk_consent_heading_complete_order_with'
-    | 'sdk_consent_heading_place_order_with'
-    | 'sdk_consent_heading_complete_booking_with'
-    | 'sdk_consent_heading_checkout_with'
-    | 'sdk_consent_heading_manage_details_with'
-    | 'sdk_consent_heading_manage_your_details_with'
-    | 'sdk_consent_heading_login_to_with_one_tap'
-    | 'sdk_consent_heading_subscribe_to'
-    | 'sdk_consent_heading_get_updates_from'
-    | 'sdk_consent_heading_continue_reading_on'
-    | 'sdk_consent_heading_get_new_updates_from'
-    | 'sdk_consent_heading_login_signup_with';
-
+  | 'sdk_consent_heading_log_in_to'
+  | 'sdk_consent_heading_sign_up_with'
+  | 'sdk_consent_heading_sign_in_to'
+  | 'sdk_consent_heading_verify_number_with'
+  | 'sdk_consent_heading_register_with'
+  | 'sdk_consent_heading_get_started_with'
+  | 'sdk_consent_heading_proceed_with'
+  | 'sdk_consent_heading_verify_with'
+  | 'sdk_consent_heading_verify_profile_with'
+  | 'sdk_consent_heading_verify_your_profile_with'
+  | 'sdk_consent_heading_verify_phone_no_with'
+  | 'sdk_consent_heading_verify_your_no_with'
+  | 'sdk_consent_heading_continue_with'
+  | 'sdk_consent_heading_complete_order_with'
+  | 'sdk_consent_heading_place_order_with'
+  | 'sdk_consent_heading_complete_booking_with'
+  | 'sdk_consent_heading_checkout_with'
+  | 'sdk_consent_heading_manage_details_with'
+  | 'sdk_consent_heading_manage_your_details_with'
+  | 'sdk_consent_heading_login_to_with_one_tap'
+  | 'sdk_consent_heading_subscribe_to'
+  | 'sdk_consent_heading_get_updates_from'
+  | 'sdk_consent_heading_continue_reading_on'
+  | 'sdk_consent_heading_get_new_updates_from'
+  | 'sdk_consent_heading_login_signup_with';
 
 export type OTLoginPrefixText =
-    | 'login_text_prefix_to_get_started'
-    | 'login_text_prefix_to_continue'
-    | 'login_text_prefix_to_place_order'
-    | 'login_text_prefix_to_complete_your_purchase'
-    | 'login_text_prefix_to_checkout'
-    | 'login_text_prefix_to_complete_your_booking'
-    | 'login_text_prefix_to_proceed_with_your_booking'
-    | 'login_text_prefix_to_continue_with_your_booking'
-    | 'login_text_prefix_to_get_details'
-    | 'login_text_prefix_to_view_more'
-    | 'login_text_prefix_to_continue_reading'
-    | 'login_text_prefix_to_proceed'
-    | 'login_text_prefix_for_new_updates'
-    | 'login_text_prefix_to_get_updates'
-    | 'login_text_prefix_to_subscribe'
-    | 'login_text_prefix_to_subscribe_and_get_updates';
-
+  | 'login_text_prefix_to_get_started'
+  | 'login_text_prefix_to_continue'
+  | 'login_text_prefix_to_place_order'
+  | 'login_text_prefix_to_complete_your_purchase'
+  | 'login_text_prefix_to_checkout'
+  | 'login_text_prefix_to_complete_your_booking'
+  | 'login_text_prefix_to_proceed_with_your_booking'
+  | 'login_text_prefix_to_continue_with_your_booking'
+  | 'login_text_prefix_to_get_details'
+  | 'login_text_prefix_to_view_more'
+  | 'login_text_prefix_to_continue_reading'
+  | 'login_text_prefix_to_proceed'
+  | 'login_text_prefix_for_new_updates'
+  | 'login_text_prefix_to_get_updates'
+  | 'login_text_prefix_to_subscribe'
+  | 'login_text_prefix_to_subscribe_and_get_updates';
 
 export type OTCtaText =
-    | 'cta_text_proceed'
-    | 'cta_text_continue'
-    | 'cta_text_accept'
-    | 'cta_text_confirm';
+  | 'cta_text_proceed'
+  | 'cta_text_continue'
+  | 'cta_text_accept'
+  | 'cta_text_confirm';
 
-export type OtplessAuthEvent = 'AUTH_INITIATED' | 'AUTH_SUCCESS' | 'AUTH_FAILED';
+export type OtplessAuthEvent =
+  | 'AUTH_INITIATED'
+  | 'AUTH_SUCCESS'
+  | 'AUTH_FAILED';
 
 export type OtplessProviderType = 'CLIENT' | 'OTPLESS';
+
+export interface OtplessRequestInput {
+  phone?: string;
+  /** Required together with `phone`. */
+  countryCode?: string;
+  email?: string;
+  channelType?: OtplessChannelType;
+  otp?: string;
+  expiry?: string;
+  otpLength?: string;
+  deliveryChannel?: string;
+  tid?: string;
+  /** Backend-generated or WebAuthn request ID. */
+  requestId?: string;
+  deviceFingerprintMode?: OtplessDeviceFingerprintMode;
+}
+
+export interface OtplessBackgroundAuthConfig {
+  /** Defaults to `true` — presents the OneTap bottom sheet. `false` runs in background when possible. */
+  isForeground?: boolean;
+  otp?: string;
+  tid?: string;
+  deviceFingerprintMode?: OtplessDeviceFingerprintMode;
+}
+
+export type OtplessChannelType =
+  | 'WHATSAPP'
+  | 'GOOGLE_SDK'
+  | 'FACEBOOK_SDK'
+  | 'APPLE'
+  | 'APPLE_SDK'
+  | 'GMAIL'
+  | 'TWITTER'
+  | 'DISCORD'
+  | 'SLACK'
+  | 'FACEBOOK'
+  | 'LINKEDIN'
+  | 'MICROSOFT'
+  | 'LINE'
+  | 'LINEAR'
+  | 'NOTION'
+  | 'TWITCH'
+  | 'GITHUB'
+  | 'BITBUCKET'
+  | 'ATLASSIAN'
+  | 'GITLAB'
+  | 'TRUE_CALLER';
+
+export type OtplessDeviceFingerprintMode = 'NONE' | 'ASYNC' | 'SYNC';
+
+/**
+ * SSL pinning mode for `initialize`. `'disabled'` (default) keeps the
+ * 2.3.x behaviour. `'enabled'` pins `sigma.otpless.app`; a pin mismatch
+ * (e.g. an intercepting proxy) fails closed with `FAILED` / statusCode `5004`.
+ */
+export type OtplessSslPinning = 'enabled' | 'disabled';
+
+export interface OtplessInitOptions {
+  /** Defaults to `'disabled'`. */
+  sslPinning?: OtplessSslPinning;
+}

package/src/version.ts

@@ -0,0 +1,17 @@
+/**
+ * This package's own version, kept in lock-step with `version` in
+ * `package.json`.
+ *
+ * Internal only: this module is deliberately **not** re-exported from
+ * `src/index.tsx` (which exports `OtplessHeadlessModule` and `./models`), so it
+ * never becomes merchant-facing API. It exists so the wrapper-attribution token
+ * sent to the native SDKs at `initialize`
+ * (`react-native-android-<version>` / `react-native-ios-<version>`) has a
+ * single source of truth in TypeScript instead of being duplicated in Kotlin
+ * and Swift, where it would silently drift on every release.
+ *
+ * `src/__tests__/version.test.ts` reads `package.json` and fails if this
+ * constant falls out of sync, so a forgotten bump breaks CI rather than
+ * shipping a wrong token.
+ */
+export const otplessRnVersion = '3.0.0';