@myazahq/kyc-sdk-react-native 2.0.0

package/src/types/verification.ts

@@ -0,0 +1,79 @@
+// ---------------------------------------------------------------------------
+// Submission callback payload (returned to onSubmit)
+// ---------------------------------------------------------------------------
+
+export interface KYCSubmission {
+  verificationId: string;
+  status: 'pending';
+  metadata: Record<string, string>;
+  submittedAt: string;
+}
+
+// ---------------------------------------------------------------------------
+// Technical error types (onError callback)
+// ---------------------------------------------------------------------------
+
+/**
+ * Typed, documented technical-error categories surfaced through `onError`.
+ * These are IDENTICAL to the web + Flutter SDKs' codes so integrators get one
+ * consistent contract across all three platforms.
+ *
+ * - `network_error`            — connection failure / timeout (after retries)
+ * - `invalid_api_key`          — server returned 401
+ * - `insufficient_credits`     — server returned 402 (see `details`)
+ * - `upload_failed`            — `POST /api/kyc/upload` failed (after retries)
+ * - `camera_permission_denied` — the user denied (or the OS blocks) camera
+ *                                access; capture cannot proceed
+ * - `feature_disabled`         — server returned 403 (ID type or a verification
+ *                                feature is not enabled for the org)
+ * - `unknown`                  — anything else
+ *
+ * > Voice guidance is text-to-speech *output* — it never records audio, so
+ * > there is no microphone-permission error code.
+ */
+export type KYCErrorCode =
+  | 'network_error'
+  | 'invalid_api_key'
+  | 'insufficient_credits'
+  | 'upload_failed'
+  | 'camera_permission_denied'
+  | 'feature_disabled'
+  | 'unknown';
+
+export interface KYCErrorDetails {
+  required?: number;
+  balance?: number;
+  currency?: string;
+}
+
+/**
+ * The error instance passed to `onError`. It is a real `Error` (so existing
+ * `onError: (error: Error) => void` handlers keep working) that additionally
+ * carries a typed `code` and optional `details`. Narrow with `instanceof
+ * KYCError` (or read `error.code`) to branch on the category.
+ */
+export class KYCError extends Error {
+  readonly code: KYCErrorCode;
+  readonly details?: KYCErrorDetails;
+
+  constructor(code: KYCErrorCode, message: string, details?: KYCErrorDetails) {
+    super(message);
+    this.name = 'KYCError';
+    this.code = code;
+    this.details = details;
+    // Restore the prototype chain for `instanceof` after transpilation.
+    Object.setPrototypeOf(this, KYCError.prototype);
+  }
+}
+
+// ---------------------------------------------------------------------------
+// API call status (used by stores)
+// ---------------------------------------------------------------------------
+
+export type ApiStatus = 'idle' | 'loading' | 'success' | 'error';
+
+export interface ApiError {
+  message: string;
+  code?: string;
+  statusCode?: number;
+}

package/src/utils/platform.ts

@@ -0,0 +1,23 @@
+// Thin wrapper around React Native's `Platform` so the SDK's pure-logic modules
+// (resolveUrl, deviceMetadata) stay testable under a plain Node test runner —
+// where the `react-native` module isn't resolvable. Under Metro/RN this reads
+// the real `Platform.OS`; under Node it falls back to `'ios'`.
+//
+// This is the ONLY place the SDK reaches for `Platform` outside of React
+// components, so the platform concern is isolated to a single file.
+
+export type PlatformOS = 'ios' | 'android' | 'windows' | 'macos' | 'web';
+
+function readOS(): PlatformOS {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const rn = require('react-native') as { Platform?: { OS?: PlatformOS } };
+    return rn?.Platform?.OS ?? 'ios';
+  } catch {
+    return 'ios';
+  }
+}
+
+export const OS: PlatformOS = readOS();
+export const isAndroid = OS === 'android';
+export const isIOS = OS === 'ios';

package/src/utils/tokens.ts

@@ -0,0 +1,10 @@
+import type { MyazaKYCConfig } from '../types/config';
+
+// Replaces {firstName} / {lastName} tokens with values from userData (or ''),
+// mirroring the Flutter SDK's `_fillTokens` and the web SDK's token handling.
+export function fillTokens(template: string, userData: MyazaKYCConfig['userData']): string {
+  return template
+    .replace(/\{firstName\}/g, userData?.firstName ?? '')
+    .replace(/\{lastName\}/g, userData?.lastName ?? '')
+    .trim();
+}

package/src/utils/uuid.ts

@@ -0,0 +1,31 @@
+// Best-effort UUID/request-id generator. Prefers `expo-crypto`'s native
+// randomUUID when available, falling back to a Math.random()-based v4 (good
+// enough for a request correlation id — not used for anything security-sensitive).
+
+interface ExpoCryptoModule {
+  randomUUID?: () => string;
+}
+
+function fallbackUuid(): string {
+  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
+    const r = (Math.random() * 16) | 0;
+    const v = c === 'x' ? r : (r & 0x3) | 0x8;
+    return v.toString(16);
+  });
+}
+
+export function uuid(): string {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const crypto = require('expo-crypto') as ExpoCryptoModule;
+    if (crypto?.randomUUID) return crypto.randomUUID();
+  } catch {
+    /* expo-crypto not installed — fall through */
+  }
+  return fallbackUuid();
+}
+
+/** Prefixed request id sent as `metadata.requestId` on every verify. */
+export function generateRequestId(): string {
+  return `kyc_${uuid()}`;
+}