@sanctum-key/react-native-sdk 1.0.0

package/src/types/KYC.types.ts

@@ -0,0 +1,837 @@
+import { VerificationResult } from "../modules/api/types";
+
+// Types pour les documents
+export interface Document {
+  id: string;
+  type: DocumentType;
+  imageUri: string;
+  uploadedAt: Date;
+  validated: boolean;
+  extractedData?: DocumentData;
+
+}
+
+export type DocumentType = 'passport' | 'id_card' | 'drivers_license';
+
+export interface DocumentData {
+  firstName?: string;
+  lastName?: string;
+  dateOfBirth?: string;
+  documentNumber?: string;
+  expiryDate?: string;
+  nationality?: string;
+}
+
+// Types pour les selfies
+export interface Selfie {
+  id: string;
+  imageUri: string;
+  capturedAt: Date;
+  validated: boolean;
+  faceDetected: boolean;
+}
+
+// Types pour la session KYC
+export interface KYCSession {
+  id: string;
+  userId: string;
+  status: KYCStatus;
+  currentStep: number;
+  documents: Document[];
+  selfie?: Selfie;
+  verificationId?: string;
+  createdAt: Date;
+  updatedAt: Date;
+  completedAt?: Date;
+}
+
+export type KYCStatus = 'pending' | 'in_progress' | 'completed' | 'failed' | 'rejected';
+
+// Types pour les étapes du processus
+export interface KYCStep {
+  id: number;
+  title: string;
+  description: string;
+  isCompleted: boolean;
+  isRequired: boolean;
+}
+
+// Types pour les erreurs
+export interface KYCError {
+  code: string;
+  message: string;
+  field?: string;
+  details?: any;
+}
+
+// Types pour les réponses API
+export interface KYCResponse {
+  success: boolean;
+  data?: any;
+  error?: KYCError;
+  message?: string;
+}
+
+// Types pour les événements
+export interface KYCEvent {
+  type: 'step_completed' | 'document_uploaded' | 'selfie_captured' | 'verification_started' | 'verification_completed';
+  timestamp: Date;
+  data?: any;
+}
+
+// Types pour les configurations
+export interface KYCConfig {
+  apiBaseUrl: string;
+  apiKey: string;
+  timeout: number;
+  retryAttempts: number;
+  enableDebug: boolean;
+}
+
+// Types pour les hooks
+export interface UseKYCReturn {
+  session: KYCSession | null;
+  currentStep: number;
+  isProcessing: boolean;
+  error: KYCError | null;
+  startSession: (userId: string) => void;
+  nextStep: () => void;
+  previousStep: () => void;
+  uploadDocument: (document: Document) => Promise<void>;
+  captureSelfie: (selfie: Selfie) => Promise<void>;
+  submitVerification: () => Promise<void>;
+  resetSession: () => void;
+}
+
+// ===== NOUVEAUX TYPES POUR CONFIGURATION AUTOMATIQUE =====
+
+// Types d'éléments KYC configurables
+export type KYCElementType =
+  | 'country_selection'
+  | 'document_type_selection'
+  | 'camera_capture'
+  | 'file_upload'
+  | 'selfie_capture'
+  | 'verification'
+  | 'completion';
+//KYCElementType shorted
+
+
+// Configuration d'un élément KYC
+export interface KYCElement {
+  id: string;
+  type: KYCElementType;
+  title: string;
+  description: string;
+  isRequired: boolean;
+  isVisible: boolean;
+  order: number;
+  validation?: KYCValidation;
+  options?: KYCElementOption[];
+  cameraConfig?: KYCCameraConfig;
+  uploadConfig?: KYCUploadConfig;
+}
+
+// Options pour les éléments de sélection
+export interface KYCElementOption {
+  value: string;
+  label: string;
+  icon?: string;
+  description?: string;
+}
+
+// Configuration de validation
+export interface KYCValidation {
+  required: boolean;
+  minLength?: number;
+  maxLength?: number;
+  pattern?: string;
+  customValidator?: (value: any) => boolean | string;
+}
+
+// Configuration de la caméra
+export interface KYCCameraConfig {
+  aspectRatio?: number;
+  quality?: number;
+  flashMode?: 'on' | 'off' | 'auto';
+  cameraType?: 'front' | 'back';
+  allowRetake: boolean;
+  maxRetakes?: number;
+  overlay?: {
+    showGuide: boolean;
+    guideText?: string;
+    guideImage?: string;
+  };
+}
+
+// Configuration d'upload
+export interface KYCUploadConfig {
+  allowedTypes: string[];
+  maxFiles: number;
+  maxFileSize?: number;
+  allowMultiple: boolean;
+}
+
+// Configuration complète du flux KYC
+export interface KYCFlowConfig {
+  id: string;
+  name: string;
+  description: string;
+  version: string;
+  elements: KYCElement[];
+  settings: {
+    allowBackNavigation: boolean;
+    showProgressBar: boolean;
+    showStepNumbers: boolean;
+    autoAdvance: boolean;
+    enableRetry: boolean;
+    maxRetries: number;
+  };
+  styling: {
+    primaryColor: string;
+    secondaryColor: string;
+    backgroundColor: string;
+    textColor: string;
+    borderRadius: number;
+    fontFamily?: string;
+  };
+  localization: {
+    language: string;
+    translations: Record<string, Record<string, string>>;
+  };
+}
+
+// État du flux KYC
+export interface KYCFlowState {
+  config: KYCFlowConfig;
+  currentElementIndex: number;
+  completedElements: string[];
+  elementData: Record<string, any>;
+  errors: Record<string, string>;
+  isProcessing: boolean;
+}
+
+// Actions pour le flux KYC
+export interface KYCFlowActions {
+  initializeFlow: (config: KYCFlowConfig) => void;
+  nextElement: () => void;
+  previousElement: () => void;
+  goToElement: (elementId: string) => void;
+  updateElementData: (elementId: string, data: any) => void;
+  validateElement: (elementId: string) => boolean;
+  submitFlow: () => Promise<void>;
+  resetFlow: () => void;
+}
+
+// Hook pour le flux KYC
+export interface UseKYCFlowReturn {
+  state: KYCFlowState;
+  actions: KYCFlowActions;
+  currentElement: KYCElement | null;
+  progress: number;
+  canGoNext: boolean;
+  canGoPrevious: boolean;
+  isComplete: boolean;
+}
+
+// ===== TYPES FOR ORIENTATION VIDEO PROCESSING =====
+
+// Orientation types for liveness detection
+export type OrientationType = 'center' | 'left' | 'right';
+
+// Individual orientation capture result
+export interface OrientationCapture {
+  captured: boolean;
+  frame: number | null;
+}
+
+// Complete orientation video processing result
+export interface OrientationVideoResult {
+  center: OrientationCapture;
+  right: OrientationCapture;
+  left: OrientationCapture;
+}
+
+// Orientation video processing request
+export interface OrientationVideoRequest {
+  file: string; // Base64 encoded video or file path
+}
+
+// Orientation video processing response
+export interface OrientationVideoResponse {
+  success: boolean;
+  data?: OrientationVideoResult;
+  error?: KYCError;
+  message?: string;
+}
+
+// Configuration for orientation video capture
+export interface OrientationVideoConfig {
+  duration: number; // Duration in seconds
+  orientations: OrientationType[];
+  instructions: Record<OrientationType, string>;
+  showPreview: boolean;
+  allowRetake: boolean;
+  maxRetakes: number;
+  quality: number;
+  aspectRatio: number;
+}
+
+// State for orientation video capture
+export interface OrientationVideoState {
+  isRecording: boolean;
+  currentOrientation: OrientationType | null;
+  recordedVideo: string | null;
+  processingResult: OrientationVideoResult | null;
+  isProcessing: boolean;
+  error: string | null;
+  retakeCount: number;
+}
+
+// Actions for orientation video capture
+export interface OrientationVideoActions {
+  startRecording: () => void;
+  stopRecording: () => void;
+  processVideo: () => Promise<OrientationVideoResult>;
+  retake: () => void;
+  reset: () => void;
+  setCurrentOrientation: (orientation: OrientationType) => void;
+}
+
+// ===== NOUVEAUX TYPES POUR TEMPLATE JSON =====
+
+// Types pour les labels et instructions multilingues
+export interface LocalizedText {
+  en: string;
+  fr: string;
+  [key: string]: string; // Support pour d'autres langues
+}
+
+// Configuration UI pour les composants
+export interface ComponentUI {
+  icon?: string;
+  themeColor?: string;
+  buttonText: LocalizedText | Record<string, LocalizedText>;
+  backgroundColor?: string;
+  textColor?: string;
+  borderRadius?: number;
+}
+
+// Types de documents gouvernementaux supportés
+export type GovernmentDocumentType =
+  | 'identity_card'
+  | 'passport'
+  | 'drivers_licence'
+  | 'health_insurance_card'
+  | 'permanent_residence'
+  | 'national_id'
+  | 'work_permit'
+  | 'id'
+  | 'pp'
+  | 'dl'
+  | 'hic'
+  | 'pr'
+  | 'wp'
+
+export const GovernmentDocumentTypeShorted: Record<GovernmentDocumentType, string> = {
+  identity_card: 'id',
+  passport: 'pp',
+  drivers_licence: 'dl',
+  health_insurance_card: 'hic',
+  permanent_residence: 'pr',
+  national_id: 'id',
+  work_permit: 'wp',
+  id: 'id',
+  pp: 'pp',
+  dl: 'dl',
+  hic: 'hic',
+  pr: 'pr',
+  wp: 'wp',
+}
+
+export const GovernmentDocumentTypeBackend: Record<string, GovernmentDocumentType> = {
+  national_id: 'identity_card',
+  passport: 'passport',
+  driversLicense: 'drivers_licence',
+  healthInsuranceCard: 'health_insurance_card',
+  permanentResidence: 'permanent_residence',
+  workPermit: 'work_permit',
+  residencePermit: 'permanent_residence',
+}
+
+// Configuration spécifique pour chaque type de composant
+export interface IDCardConfig {
+  sides: string[];
+  allowed_formats: string[];
+  max_size_mb: number;
+  document_types: GovernmentDocumentType[]; // Types de documents disponibles
+  bbox_configs?: Record<GovernmentDocumentType, {
+    xMin: number;
+    yMin: number;
+    xMax: number;
+    yMax: number;
+    borderColor?: string;
+    borderWidth?: number;
+    cornerRadius?: number;
+  }>;
+}
+
+
+export interface SelfieConfig {
+  liveness_check: boolean;
+  max_attempts: number;
+  orientations: ('center' | 'left' | 'right')[]; // Tableau d'orientations à capturer
+}
+
+export interface FileUploadConfig {
+  allowed_formats: string[];
+  max_size_mb: number;
+  required: boolean;
+}
+
+export interface LocationConfig {
+  accuracy: string;
+  required: boolean;
+}
+
+export interface CountrySelectionConfig {
+  allowed_countries: string[];
+  default_country: string;
+  required: boolean;
+}
+
+// Union type pour toutes les configurations
+export type ComponentConfig =
+  | IDCardConfig
+  | SelfieConfig
+  | FileUploadConfig
+  | LocationConfig
+  | CountrySelectionConfig
+  | CountrySelectionConfig
+  | WelcomeConfig
+  | EmailVerificationConfig
+  | PhoneVerificationConfig
+  | PersonalInformationConfig
+  | AdditionalDocumentsConfig;
+
+// Nouveau type de composant basé sur le template JSON
+export interface TemplateComponent {
+  id: number;
+  type: 'id_card' | 'selfie' | 'file_upload' | 'location' | 'country_selection' | 'initialization' | 'review_submit' | 'verification_progress' | 'welcome' | 'email_verification' | 'phone_verification' | 'personal_information' | 'additional_documents';
+  order: number;
+  templateId?: number;
+  labels: LocalizedText | Record<string, LocalizedText>;
+  instructions: LocalizedText | Record<string, LocalizedText>;
+  ui: ComponentUI | Record<string, ComponentUI>;
+  config: ComponentConfig;
+}
+
+// Template KYC complet
+export interface KYCTemplate {
+  id: number;
+  name: LocalizedText;
+  description: LocalizedText;
+  version: string;
+  components: TemplateComponent[];
+}
+
+// État pour le template KYC
+export interface TemplateState {
+  template: KYCTemplate;
+  currentComponentIndex: number;
+  completedComponents: number[];
+  componentData: Record<number, any>;
+  errors: Record<number, string>;
+  isProcessing: boolean;
+  currentLanguage: string;
+  showCustomStepper: boolean;
+  session: SessionState;
+  verification: VerificationState;
+}
+
+export interface SessionState {
+  session_id: string;
+  token: string;
+  isInitialized: boolean;
+  isProcessing: boolean;
+  error: string | null;
+  /** True once loadSessionData has run (for resume flow); allows UI to show loading until country/data restored */
+  sessionDataRestored?: boolean;
+}
+
+export type VerificationStatus = 'idle' | 'in_progress' | 'success' | 'failed';
+
+
+
+export interface VerificationState {
+  status: VerificationStatus;
+  result?: VerificationResult;
+}
+
+// Actions pour le template KYC
+export interface TemplateActions {
+  initializeTemplate: (template: KYCTemplate) => void;
+  nextComponent: (overrideData?: any) => void;
+  previousComponent: () => void;
+  goToComponent: (componentId: number) => void;
+  updateComponentData: (componentId: number, data: any) => void;
+  validateComponent: (componentId: number, dataOverride?: any) => boolean;
+  submitTemplate: () => Promise<void>;
+  resetTemplate: () => void;
+  setLanguage: (language: string) => void;
+  showCustomStepper: (show: boolean) => void;
+  setVerificationState: (state: VerificationState) => void;
+  submitVerification: () => Promise<void>;
+}
+
+// Hook pour le template KYC (return type of useTemplateKYCFlow)
+export interface UseTemplateReturn {
+  state: TemplateState;
+  actions: TemplateActions;
+  currentComponent: TemplateComponent | null;
+  progress: number;
+  canGoNext: boolean;
+  canGoPrevious: boolean;
+  isComplete: boolean;
+  getLocalizedText: (text: LocalizedText) => string;
+  initializeSession: () => Promise<void>;
+  env: 'PRODUCTION' | 'SANDBOX';
+  /** Optional API key for backend auth (e.g. email verification endpoints). */
+  apiKey?: string;
+}
+
+
+export interface ISilentCaptureResult {
+  success: boolean;
+  path?: string;
+  mrz?: string;
+  error?: string;
+  isAnalyzing?: boolean;
+  bbox?: IBbox;
+  country?: string;
+  documentType?: string;
+  templatePath?: string;
+  lpipsScore?: number;
+}
+
+export interface IBbox {
+  minX: number;
+  minY: number;
+  width: number;
+  height: number;
+}
+
+export interface ICountryMapping {
+  py_file?: string;
+  front?: string;
+  back?: string;
+  keys_found?: string | null;
+  mrz_type?: string;
+}
+
+export interface Country {
+  code?: string; // ISO 3166-1 alpha-2
+  name: string;
+  name_en: string;
+  flag: string;
+  regionMapping?: ICountryMapping;
+  hasRegions?: boolean;
+}
+
+// ===== TYPES FOR BACKEND TEMPLATE FORMAT =====
+
+// Backend component configuration types
+export interface WelcomeConfig {
+  subtitle?: string;
+  buttonText?: string;
+  requirements?: string[];
+  estimatedTime?: string;
+  consentOptions?: {
+    showPrivacyPolicy?: boolean;
+    showTermsOfService?: boolean;
+    showMarketingConsent?: boolean;
+  };
+  welcomeMessage?: string;
+  showEstimatedTime?: boolean;
+}
+
+export interface LocationCaptureConfig {
+  showMap?: boolean;
+  accuracy?: string;
+  required?: boolean;
+  maxDistance?: number;
+  captureMethod?: string;
+  allowManualEntry?: boolean;
+  countryRestrictions?: string[];
+}
+
+export interface GovernmentIdConfig {
+  required?: boolean;
+  allowSkip?: boolean;
+  cameraOverlay?: {
+    bbox?: {
+      xMax?: number;
+      xMin?: number;
+      yMax?: number;
+      yMin?: number;
+      borderColor?: string;
+      borderWidth?: number;
+      cornerRadius?: number;
+    };
+  };
+  documentTypes?: string[];
+  requiredSides?: string;
+  cameraSettings?: {
+    quality?: number;
+    flashMode?: string;
+    maxRetakes?: number;
+    allowRetake?: boolean;
+    aspectRatio?: number;
+  };
+  validationRules?: string[];
+  regionsByCountry?: Record<string, any>;
+  selectedCountries?: string[];
+  authenticationMethods?: Record<string, Record<string, {
+    back?: string[];
+    front?: string[];
+    mrzTypes?: string[];
+  }>>;
+  documentTypesByCountry?: Record<string, string[]>;
+  instructionsByDocumentType?: Record<string, LocalizedText>;
+}
+
+export interface SelfieCaptureConfig {
+  timeout?: number;
+  maxAttempts?: number;
+  faceMatching?: boolean;
+  captureMethod?: string;
+  qualityChecks?: string[];
+  livenessChecks?: string[];
+  matchThreshold?: string;
+  livenessEnabled?: boolean;
+}
+
+export interface ReviewSubmitConfig {
+  allowEditing?: boolean;
+  displayOptions?: string[];
+  requireConsent?: boolean;
+  postSubmitActions?: string[];
+}
+
+export type BackendComponentConfig =
+  | WelcomeConfig
+  | LocationCaptureConfig
+  | GovernmentIdConfig
+  | SelfieCaptureConfig
+  | ReviewSubmitConfig
+  | Record<string, any>;
+
+// Backend component translation structure
+export interface BackendComponentTranslations {
+  en?: {
+    title?: string;
+    description?: string;
+    instructions?: string;
+    buttonText?: string;
+    consentText?: string;
+    successMessage?: string;
+  };
+  fr?: {
+    title?: string;
+    description?: string;
+    instructions?: string;
+    buttonText?: string;
+    consentText?: string;
+    successMessage?: string;
+  };
+  [key: string]: {
+    title?: string;
+    description?: string;
+    instructions?: string;
+    buttonText?: string;
+    consentText?: string;
+    successMessage?: string;
+  } | undefined;
+}
+
+// Backend template component
+export interface BackendTemplateComponent {
+  id: string;
+  type: 'welcome' | 'location-capture' | 'government-id' | 'selfie-capture' | 'review-submit' | 'verification-progress' | 'email-verification' | 'phone-verification' | 'personal-information' | 'additional-documents';
+  order: number;
+  config: BackendComponentConfig;
+  required?: boolean;
+  translations: BackendComponentTranslations;
+}
+
+// Backend template structure
+export interface BackendKYCTemplate {
+  id: string;
+  name: {
+    en: string;
+    fr: string;
+    [key: string]: string;
+  };
+  status?: string;
+  version?: string;
+  components: BackendTemplateComponent[];
+  description?: {
+    en: string;
+    fr: string;
+    [key: string]: string;
+  };
+}
+
+// ===== NEW CONFIG TYPES FOR INPUT VERIFICATION =====
+
+export interface EmailVerificationConfig {
+  allowResend: boolean;
+  otpSettings: {
+    codeLength: number;
+    expiryTime: number;
+  };
+  resendCooldown: number;
+  emailValidation: {
+    corporateOnly: boolean;
+    validateFormat: boolean;
+    checkDisposable: boolean;
+    checkDeliverability: boolean;
+  };
+  verificationMethod: string;
+  required?: boolean;
+}
+
+export interface PhoneVerificationConfig {
+  required: boolean;
+  codeExpiry: number;
+  codeLength: number;
+  maxAttempts: number;
+  resendDelay: number;
+  countryRestrictions: string;
+  verificationMethods: string[];
+  allowSkipForVerified: boolean;
+}
+
+export interface PersonalInfoField {
+  id: string;
+  type: string;
+  label: string;
+  required: boolean;
+  placeholder?: string;
+  autoFillFromId?: boolean;
+  minAge?: number;
+  verifyAge?: boolean;
+  dateFormat?: string;
+}
+
+export interface PersonalInformationConfig {
+  fields: PersonalInfoField[];
+  validationSettings: {
+    validateOnBlur: boolean;
+    showAllErrorsAtOnce: boolean;
+    preventSubmissionWithErrors: boolean;
+  };
+  required?: boolean;
+}
+
+export interface DocumentCategory {
+  enabled: boolean;
+  category: string;
+  documentTypes: string[];
+}
+
+export interface AdditionalDocumentsConfig {
+  required: boolean;
+  maxSizeEach: string;
+  maxDocuments: number;
+  minDocuments: number;
+  documentCategories: DocumentCategory[];
+  customDocumentTypes: any[];
+  showBasedOnUserProfile: boolean;
+}
+
+// API response for template
+export interface TemplateAPIResponse {
+  id: string;
+  name: {
+    en: string;
+    fr: string;
+    [key: string]: string;
+  };
+  status?: string;
+  version?: string;
+  components: BackendTemplateComponent[];
+  description?: {
+    en: string;
+    fr: string;
+    [key: string]: string;
+  };
+}
+
+// ===== NEW CONFIG TYPES FOR INPUT VERIFICATION =====
+
+export interface EmailVerificationConfig {
+  allowResend: boolean;
+  otpSettings: {
+    codeLength: number;
+    expiryTime: number;
+  };
+  resendCooldown: number;
+  emailValidation: {
+    corporateOnly: boolean;
+    validateFormat: boolean;
+    checkDisposable: boolean;
+    checkDeliverability: boolean;
+  };
+  verificationMethod: string;
+  required?: boolean;
+}
+
+export interface PhoneVerificationConfig {
+  required: boolean;
+  codeExpiry: number;
+  codeLength: number;
+  maxAttempts: number;
+  resendDelay: number;
+  countryRestrictions: string;
+  verificationMethods: string[];
+  allowSkipForVerified: boolean;
+}
+
+export interface PersonalInfoField {
+  id: string;
+  type: string;
+  label: string;
+  required: boolean;
+  placeholder?: string;
+  autoFillFromId?: boolean;
+  minAge?: number;
+  verifyAge?: boolean;
+  dateFormat?: string;
+}
+
+export interface PersonalInformationConfig {
+  fields: PersonalInfoField[];
+  validationSettings: {
+    validateOnBlur: boolean;
+    showAllErrorsAtOnce: boolean;
+    preventSubmissionWithErrors: boolean;
+  };
+  required?: boolean;
+}
+
+export interface DocumentCategory {
+  enabled: boolean;
+  category: string;
+  documentTypes: string[];
+}
+
+export interface AdditionalDocumentsConfig {
+  required: boolean;
+  maxSizeEach: string;
+  maxDocuments: number;
+  minDocuments: number;
+  documentCategories: DocumentCategory[];
+  customDocumentTypes: any[];
+  showBasedOnUserProfile: boolean;
+}