react-native-otp-auto-verify 0.1.8 → 0.2.0

package/src/NativeOtpAutoVerify.ts

@@ -1,6 +1,6 @@
-import { TurboModuleRegistry, type TurboModule } from 'react-native';
+import { NativeModules, TurboModuleRegistry, type TurboModule } from 'react-native';
 
-export interface Spec extends TurboModule {
+export interface OtpAutoVerifySpec extends TurboModule {
   getConstants(): { OTP_RECEIVED_EVENT: string };
   getHash(): Promise<ReadonlyArray<string>>;
   startSmsRetriever(): Promise<boolean>;
@@ -8,4 +8,18 @@ export interface Spec extends TurboModule {
   removeListeners(count: number): void;
 }
 
-export default TurboModuleRegistry.getEnforcing<Spec>('OtpAutoVerify');
+function getNativeModule(): OtpAutoVerifySpec {
+  try {
+    return TurboModuleRegistry.getEnforcing<OtpAutoVerifySpec>('OtpAutoVerify');
+  } catch {
+    const legacy = NativeModules.OtpAutoVerify;
+    if (!legacy) {
+      throw new Error(
+        'OtpAutoVerify native module is not available. Ensure the library is properly linked.'
+      );
+    }
+    return legacy as OtpAutoVerifySpec;
+  }
+}
+
+export default getNativeModule();

package/src/index.tsx

@@ -1,172 +1,197 @@
-import * as React from 'react';
-import { NativeEventEmitter, NativeModules, Platform } from 'react-native';
-import NativeOtpAutoVerify from './NativeOtpAutoVerify';
-
-const { OtpAutoVerify } = NativeModules;
-const eventEmitter =
-  Platform.OS === 'android' && OtpAutoVerify
-    ? new NativeEventEmitter(OtpAutoVerify)
-    : null;
-
-const OTP_RECEIVED_EVENT =
-  (NativeOtpAutoVerify.getConstants?.()?.OTP_RECEIVED_EVENT as string) ??
-  'otpReceived';
-
-const TIMEOUT_MESSAGE = 'Timeout Error.';
-const DEFAULT_DIGITS = 6;
-
-export type OtpDigits = 4 | 5 | 6;
-
-const OTP_REGEX: Record<OtpDigits, RegExp> = {
-  4: /\b(\d{4})\b/,
-  5: /\b(\d{5})\b/,
-  6: /\b(\d{6})\b/,
-};
-
-export interface UseOtpVerificationOptions {
-  /** Extract OTP with this many digits (4, 5, or 6). OTP is set when SMS is received. */
-  numberOfDigits?: OtpDigits;
-}
-
-export interface UseOtpVerificationResult {
-  /** App hash string for SMS (e.g. "uW87Uq6teXc"). Use at end of your OTP message. */
-  hashCode: string;
-  /** Extracted OTP when numberOfDigits is set and an SMS was received. */
-  otp: string | null;
-  /** Full SMS text when received. */
-  sms: string | null;
-  /** True when the 5-minute SMS Retriever timeout occurred. */
-  timeoutError: boolean;
-  /** Set when getHash fails (non-fatal) or when startListening fails. Cleared when startListening is called again. */
-  error: Error | null;
-  /** Start listening for OTP again (e.g. after timeout or error). */
-  startListening: () => Promise<void>;
-  /** Stop listening and clean up. Call on unmount. */
-  stopListening: () => void;
-}
-
-export interface OtpListenerSubscription {
-  remove: () => void;
-}
-
-/** Extracts a numeric OTP of 4–6 digits from SMS text. */
-export function extractOtp(
-  sms: string,
-  numberOfDigits: OtpDigits = DEFAULT_DIGITS
-): string | null {
-  if (!sms || typeof sms !== 'string') return null;
-  const trimmed = sms.trim();
-  if (!trimmed) return null;
-  const match = trimmed.match(OTP_REGEX[numberOfDigits]);
-  return match ? match[1]! : null;
-}
-
-/** Returns app hash strings for the current app. Android only; iOS returns []. */
-export async function getHash(): Promise<string[]> {
-  if (Platform.OS !== 'android') return [];
-  const arr = await NativeOtpAutoVerify.getHash();
-  return Array.from(arr);
-}
-
-/** Starts SMS Retriever and subscribes to OTP events. Returns subscription with remove(). */
-export async function activateOtpListener(
-  handler: (sms: string, extractedOtp?: string | null) => void,
-  options?: { numberOfDigits?: OtpDigits }
-): Promise<OtpListenerSubscription> {
-  if (Platform.OS !== 'android' || !eventEmitter) {
-    throw new Error('SMS Retriever is only supported on Android.');
-  }
-
-  const numberOfDigits = options?.numberOfDigits ?? DEFAULT_DIGITS;
-  const subscription = eventEmitter.addListener(
-    OTP_RECEIVED_EVENT,
-    (...args: unknown[]) => {
-      const smsText = String(args[0] ?? '');
-      handler(smsText, extractOtp(smsText, numberOfDigits));
-    }
-  );
-
-  await NativeOtpAutoVerify.startSmsRetriever();
-  return {
-    remove: () => {
-      subscription.remove();
-      NativeOtpAutoVerify.removeListeners(0);
-    },
-  };
-}
-
-/** Stops SMS listening and removes all listeners. */
-export function removeListener(): void {
-  if (Platform.OS === 'android') {
-    NativeOtpAutoVerify.removeListeners(0);
-  }
-}
-
-/** Hook for OTP verification. Call startListening() to begin; listener is stopped on unmount. */
-export function useOtpVerification(
-  options: UseOtpVerificationOptions = {}
-): UseOtpVerificationResult {
-  const numberOfDigits = options.numberOfDigits ?? DEFAULT_DIGITS;
-  const [hashCode, setHashCode] = React.useState('');
-  const [otp, setOtp] = React.useState<string | null>(null);
-  const [sms, setSms] = React.useState<string | null>(null);
-  const [timeoutError, setTimeoutError] = React.useState(false);
-  const [error, setError] = React.useState<Error | null>(null);
-  const subscriptionRef = React.useRef<OtpListenerSubscription | null>(null);
-
-  const stopListening = React.useCallback(() => {
-    subscriptionRef.current?.remove();
-    subscriptionRef.current = null;
-    removeListener();
-  }, []);
-
-  const startListening = React.useCallback(async () => {
-    if (Platform.OS !== 'android') return;
-    setOtp(null);
-    setSms(null);
-    setTimeoutError(false);
-    setError(null);
-    try {
-      const hashes = await getHash();
-      setHashCode(hashes[0] ?? '');
-    } catch (err) {
-      setError(err instanceof Error ? err : new Error(String(err)));
-    }
-    try {
-      const sub = await activateOtpListener(
-        (smsText, extractedOtp) => {
-          setSms(smsText);
-          if (smsText === TIMEOUT_MESSAGE) {
-            setTimeoutError(true);
-            return;
-          }
-          if (extractedOtp) setOtp(extractedOtp);
-        },
-        { numberOfDigits }
-      );
-      subscriptionRef.current = sub;
-    } catch (err) {
-      subscriptionRef.current = null;
-      const wrapped = new Error('Failed to start OTP listener', { cause: err });
-      setError(wrapped);
-      throw wrapped;
-    }
-  }, [numberOfDigits]);
-
-  React.useEffect(() => () => stopListening(), [stopListening]);
-
-  return React.useMemo(
-    () => ({
-      hashCode,
-      otp,
-      sms,
-      timeoutError,
-      error,
-      startListening,
-      stopListening,
-    }),
-    [hashCode, otp, sms, timeoutError, error, startListening, stopListening]
-  );
-}
-
-export { OTP_RECEIVED_EVENT };
+import * as React from 'react';
+import { NativeEventEmitter, Platform } from 'react-native';
+import NativeOtpAutoVerify from './NativeOtpAutoVerify';
+
+const eventEmitter =
+  Platform.OS === 'android' && NativeOtpAutoVerify
+    ? new NativeEventEmitter(NativeOtpAutoVerify)
+    : null;
+
+const OTP_RECEIVED_EVENT =
+  (NativeOtpAutoVerify.getConstants?.()?.OTP_RECEIVED_EVENT as string) ??
+  'otpReceived';
+
+export const TIMEOUT_MESSAGE = 'Timeout Error.';
+const DEFAULT_DIGITS = 6;
+
+const MIN_OTP_DIGITS = 4;
+const MAX_OTP_DIGITS = 8;
+
+export type OtpDigits = 4 | 5 | 6 | 7 | 8;
+
+function getOtpRegex(digits: number): RegExp {
+  if (digits < MIN_OTP_DIGITS || digits > MAX_OTP_DIGITS) {
+    return new RegExp(`\\b(\\d{${DEFAULT_DIGITS}})\\b`);
+  }
+  return new RegExp(`\\b(\\d{${digits}})\\b`);
+}
+
+export interface UseOtpVerificationOptions {
+  /** Extract OTP with this many digits (4–8). OTP is set when SMS is received. */
+  numberOfDigits?: OtpDigits;
+}
+
+export interface UseOtpVerificationResult {
+  /** App hash string for SMS (e.g. "uW87Uq6teXc"). Use at end of your OTP message. */
+  hashCode: string;
+  /** Extracted OTP when numberOfDigits is set and an SMS was received. */
+  otp: string | null;
+  /** Full SMS text when received. */
+  sms: string | null;
+  /** True when the 5-minute SMS Retriever timeout occurred. */
+  timeoutError: boolean;
+  /** Set when getHash fails (non-fatal) or when startListening fails. Cleared when startListening is called again. */
+  error: Error | null;
+  /** Start listening for OTP again (e.g. after timeout or error). */
+  startListening: () => Promise<void>;
+  /** Stop listening and clean up. Call on unmount. */
+  stopListening: () => void;
+}
+
+export interface OtpListenerSubscription {
+  remove: () => void;
+}
+
+/**
+ * Extracts a numeric OTP of 4–8 digits from SMS text.
+ */
+export function extractOtp(
+  sms: string,
+  numberOfDigits: OtpDigits = DEFAULT_DIGITS
+): string | null {
+  if (!sms || typeof sms !== 'string') return null;
+  const trimmed = sms.trim();
+  if (!trimmed) return null;
+  const regex = getOtpRegex(numberOfDigits);
+  const match = trimmed.match(regex);
+  return match ? match[1]! : null;
+}
+
+/** Returns app hash strings for the current app. Android only; iOS returns []. */
+export async function getHash(): Promise<string[]> {
+  if (Platform.OS !== 'android') return [];
+  const arr = await NativeOtpAutoVerify.getHash();
+  return Array.from(arr);
+}
+
+/** No-op subscription for platforms where SMS Retriever is not supported (e.g. iOS). */
+const NOOP_SUBSCRIPTION: OtpListenerSubscription = {
+  remove: () => {},
+};
+
+/** Starts SMS Retriever and subscribes to OTP events. Returns subscription with remove(). On iOS, returns no-op (call remove() safely). */
+export async function activateOtpListener(
+  handler: (sms: string, extractedOtp?: string | null) => void,
+  options?: { numberOfDigits?: OtpDigits }
+): Promise<OtpListenerSubscription> {
+  if (Platform.OS !== 'android' || !eventEmitter) {
+    return NOOP_SUBSCRIPTION;
+  }
+
+  const numberOfDigits = options?.numberOfDigits ?? DEFAULT_DIGITS;
+  const subscription = eventEmitter.addListener(
+    OTP_RECEIVED_EVENT,
+    (...args: unknown[]) => {
+      const smsText = String(args[0] ?? '');
+      handler(smsText, extractOtp(smsText, numberOfDigits));
+    }
+  );
+
+  await NativeOtpAutoVerify.startSmsRetriever();
+  return {
+    remove: () => {
+      subscription.remove();
+      NativeOtpAutoVerify.removeListeners(0);
+    },
+  };
+}
+
+/**
+ * Stops SMS listening and removes all listeners.
+ * The native module ignores the count parameter and always unregisters the SMS receiver.
+ */
+export function removeListener(): void {
+  if (Platform.OS === 'android') {
+    NativeOtpAutoVerify.removeListeners(0);
+  }
+}
+
+/** Hook for OTP verification. Call startListening() to begin; listener is stopped on unmount. */
+export function useOtpVerification(
+  options: UseOtpVerificationOptions = {}
+): UseOtpVerificationResult {
+  const numberOfDigits = options.numberOfDigits ?? DEFAULT_DIGITS;
+  const [hashCode, setHashCode] = React.useState('');
+  const [otp, setOtp] = React.useState<string | null>(null);
+  const [sms, setSms] = React.useState<string | null>(null);
+  const [timeoutError, setTimeoutError] = React.useState(false);
+  const [error, setError] = React.useState<Error | null>(null);
+  const subscriptionRef = React.useRef<OtpListenerSubscription | null>(null);
+  const isStartingRef = React.useRef(false);
+
+  const stopListening = React.useCallback(() => {
+    subscriptionRef.current?.remove();
+    subscriptionRef.current = null;
+    isStartingRef.current = false;
+    removeListener();
+  }, []);
+
+  const startListening = React.useCallback(async () => {
+    if (Platform.OS !== 'android') return;
+    if (isStartingRef.current) return;
+
+    isStartingRef.current = true;
+    subscriptionRef.current?.remove();
+    subscriptionRef.current = null;
+    setOtp(null);
+    setSms(null);
+    setTimeoutError(false);
+    setError(null);
+
+    try {
+      try {
+        const hashes = await getHash();
+        setHashCode(hashes[0] ?? '');
+      } catch (err) {
+        setError(err instanceof Error ? err : new Error(String(err)));
+      }
+
+      const sub = await activateOtpListener(
+        (smsText, extractedOtp) => {
+          setSms(smsText);
+          if (smsText === TIMEOUT_MESSAGE) {
+            setTimeoutError(true);
+            return;
+          }
+          if (extractedOtp) setOtp(extractedOtp);
+        },
+        { numberOfDigits }
+      );
+      subscriptionRef.current = sub;
+    } catch (err) {
+      subscriptionRef.current = null;
+      const wrapped = new Error('Failed to start OTP listener', { cause: err });
+      setError(wrapped);
+      throw wrapped;
+    } finally {
+      isStartingRef.current = false;
+    }
+  }, [numberOfDigits]);
+
+  React.useEffect(() => () => stopListening(), [stopListening]);
+
+  return React.useMemo(
+    () => ({
+      hashCode,
+      otp,
+      sms,
+      timeoutError,
+      error,
+      startListening,
+      stopListening,
+    }),
+    [hashCode, otp, sms, timeoutError, error, startListening, stopListening]
+  );
+}
+
+export { OTP_RECEIVED_EVENT };