@incodetech/core 2.0.0-alpha.1

package/src/flow/types.ts

@@ -0,0 +1,434 @@
+export type EmptyConfig = Record<string, never>;
+
+export type RegulationTypes =
+  | 'US'
+  | 'Worldwide'
+  | 'Other'
+  | 'US_Illinois'
+  | 'US_Texas'
+  | 'US_California'
+  | 'US_Washington';
+
+export type TutorialIdConfig = {
+  showTutorial: boolean;
+  enableId: boolean;
+  enablePassport: boolean;
+  onlyFront: boolean;
+  onlyBack: boolean;
+  barcodeCapture: boolean;
+  fetchAdditionalPage: boolean;
+  secondId: boolean;
+  thirdId: boolean;
+  autoCaptureTimeout: number;
+  deviceIdleTimeout: number;
+  captureAttempts: number;
+  manualUploadIdCapture: boolean;
+  digitalIdsUpload: boolean;
+  showDocumentChooserScreen: boolean;
+  enableIdRecording: boolean;
+  usSmartCapture: boolean;
+  perCountryPerDocOverrides: Record<
+    string,
+    Record<
+      string,
+      {
+        onlyFront: boolean;
+        onlyBack: boolean;
+        fetchAdditionalPage: boolean;
+      }
+    >
+  >;
+};
+
+export type FlowModuleConfig = {
+  AUTHENTICATION: {
+    showTutorial: boolean;
+    autoCaptureTimeout: number;
+    numberOfAttempts: number;
+    type: 'ONE_TO_ONE';
+    deepsightLiveness: 'SINGLE_FRAME' | 'MULTIMODAL' | 'VIDEOLIVENESS';
+    validateClosedEyes: boolean;
+    validateFaceMask: boolean;
+    validateHeadCover: boolean;
+    validateLenses: boolean;
+  };
+  ADDRESS: {
+    disableSkipPoa: boolean;
+    title: string;
+    text: string;
+  };
+  AE_SIGNATURE: {
+    uploadDocument: boolean;
+    downloadDocument: boolean;
+    issuePermanentCertificate: boolean;
+    allowWithoutScoreValidation: boolean;
+    validationsToSkip: ('ID' | 'FACE_RECOGNITION' | 'OTP' | 'TOTAL_SCORE')[];
+  };
+  CURP_VALIDATION: {
+    curpDataMatch: boolean;
+    deceasedStatusVerification: boolean;
+  };
+  CUSTOM_FIELDS: {
+    title: string;
+    customFields: {
+      name: string;
+      alias: string;
+      type: 'INTEGER' | 'DOUBLE' | 'BOOLEAN' | 'STRING';
+    }[];
+  };
+  DOCUMENT_CAPTURE: {
+    processingType:
+      | 'capture'
+      | 'processPoaOcr'
+      | 'processLoaOcr'
+      | 'processAsylumSeekerVisaZaf'
+      | 'processBankStatementOCR'
+      | 'processBankCheck'
+      | 'processV5CLogbook'
+      | 'processCarInvoice'
+      | 'processCirculationCard'
+      | 'processFinanceSettlement';
+    title: string;
+    text: string;
+    allowSkipDocumentCapture: boolean;
+  };
+  EKYB: {
+    checkBusinessName: boolean;
+    businessNameSource: 'userInput';
+    checkAddress: boolean;
+    address: 'userInput';
+    checkTaxId: boolean;
+    taxIdSource: 'userInput';
+    checkUniqueBeneficialOwner: boolean;
+    uniqueBeneficialOwnerSource: 'userInput';
+  };
+  EXTERNAL_VERIFICATION: {
+    source:
+      | 'US_DRIVERS_LICENSE_1'
+      | 'US_TELCO_1'
+      | 'US_TELCO_2'
+      | 'US_CONSUMER_1'
+      | 'US_CREDIT_BUREAU_1'
+      | 'MX_CONSUMER_1'
+      | 'BR_GOVT_1'
+      | 'CA_RES_CREDIT'
+      | 'UK_CREDIT_BUREAU_1'
+      | 'ES_1'
+      | 'CL_1'
+      | 'AR_1'
+      | 'GR_1'
+      | 'GT_1'
+      | 'BR_CPF_1';
+    checkName: boolean;
+    nameSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkEmail: boolean;
+    emailSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkAddress: boolean;
+    addressSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkPhone: boolean;
+    phoneSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkSsn: boolean;
+    ssnSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkDob: boolean;
+    dobSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkNationality: boolean;
+    nationalitySource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkDlNumber: boolean;
+    dlNumberSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkDlState: boolean;
+    dlStateSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkDlExpireAt: boolean;
+    dlExpireAtSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkLast4SSN: boolean;
+    last4SSNSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkIdNum: boolean;
+    idNumSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkIdNum1: boolean;
+    idNum1Source:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+    checkGender: boolean;
+    genderSource:
+      | 'userInput'
+      | 'document'
+      | 'poa'
+      | 'phoneModuleInput'
+      | 'emailModuleInput';
+  };
+  EMAIL: {
+    otpVerification: boolean;
+    otpExpirationInMinutes: number;
+    prefill?: boolean;
+  };
+  FACE_MATCH: {
+    matchingType: 'selfieVsId' | 'selfieVsNfc' | 'idVsNfc' | 'nfc3Way';
+    disableFaceMatchAnimation: boolean;
+  };
+  FINISH_GPT: {
+    finishgptCompanyName: string;
+  };
+  GEOLOCATION: {
+    allowUserToSkipGeolocation: boolean;
+  };
+  INE_VALIDATION: {
+    facialValidation: boolean;
+    alternativeFacialValidation: boolean;
+    fallbackEnabled: boolean;
+    scrapingMethod: boolean;
+    scrapingV2: boolean;
+    scrapingV3: boolean;
+    failUnsupportedId: boolean;
+    dataValidation: boolean;
+    backgroundExecution: boolean;
+    mockConnectionError: boolean;
+    mockUserNotFoundError: boolean;
+    mockOK: boolean;
+  };
+  GOVT_VALIDATION_PROVISIONING: {
+    validationCountries: string[];
+    facialValidation: boolean;
+    dataValidation: boolean;
+    faceAndDataValidation: boolean;
+    addressValidation: boolean;
+    backgroundExecution: boolean;
+    faceMatchOverrideDataScore: boolean;
+    useCroppedIdFacePhoto: boolean;
+  };
+  TUTORIAL_ID: TutorialIdConfig;
+  ID: TutorialIdConfig;
+  SECOND_ID: TutorialIdConfig;
+  THIRD_ID: TutorialIdConfig;
+  ID_OCR: {
+    editableOcr: boolean;
+  };
+  INCODE_WATCHLIST: {
+    failIfFaceOnBlocklist: boolean;
+    addSuspectedFraudAutomatically: boolean;
+    autoExecution: boolean;
+  };
+  INSTANT_BAV: {
+    bavVendorCountry:
+      | 'US'
+      | 'CA'
+      | 'AU'
+      | 'NZ'
+      | 'BR'
+      | 'MX'
+      | 'CO'
+      | 'UK'
+      | 'EU';
+    bavNumberOfRetries: number;
+  };
+  ML_CONSENT: {
+    consentType: RegulationTypes;
+  };
+  NFC_SCAN: {
+    nfcAvailability: boolean;
+    nfcValidation: boolean;
+    showInitialDataConfirmationScreen: boolean;
+  };
+  PHONE: {
+    otpVerification: boolean;
+    otpExpirationInMinutes: number;
+    prefill: boolean;
+  };
+  SELFIE: {
+    showTutorial: boolean;
+    showPreview: boolean;
+    assistedOnboarding: boolean;
+    enableFaceRecording: boolean;
+    autoCaptureTimeout: number;
+    captureAttempts: number;
+    validateLenses: boolean;
+    validateFaceMask: boolean;
+    validateHeadCover: boolean;
+    validateClosedEyes: boolean;
+    validateBrightness: boolean;
+    deepsightLiveness: 'SINGLE_FRAME' | 'MULTIMODAL' | 'VIDEOLIVENESS';
+  };
+  SIGNATURE: {
+    title: string;
+    subTitle: string;
+  };
+  USER_CONSENT: {
+    title: string;
+    text: string;
+  };
+  CONFERENCE: {
+    enableConferenceOtp: boolean;
+  };
+  VIDEO_ONBOARDING: {
+    useAsSelfie: boolean;
+    showTutorials: boolean;
+    companyName: string;
+    checkLiveness: boolean;
+    checkIdScan: boolean;
+    checkDocumentScan: boolean;
+    compareIdEnabled: boolean;
+    compareOcrEnabled: boolean;
+    compareBackIdEnabled: boolean;
+    compareBackOcrEnabled: boolean;
+    checkVoiceConsent: boolean;
+    voiceConsentQuestions: number;
+    selfieQualityAffectsScore: boolean;
+    maxWaitingVideoSelfieFile: number;
+    lastSecondsVideoQualityCheck: boolean;
+    lastSecondsVideoQualityCheckDuration: number;
+    validateClosedEyes: boolean;
+    validateFaceMask: boolean;
+    validateHeadCover: boolean;
+    validateLenses: boolean;
+  };
+  DYNAMIC_FORMS: {
+    screens: {
+      title: string;
+      hideTitle: boolean;
+      questions: {
+        questionId: string;
+        overrides: string | null;
+        isPredefined: boolean;
+        predefinedQuestionType: string | null;
+        question: string;
+        inputType:
+          | 'NUMBER'
+          | 'CPF'
+          | 'COUNTRY'
+          | 'NATIONALITY'
+          | 'DATE'
+          | 'PHONE'
+          | 'EMAIL'
+          | 'TEXT'
+          | 'MULTISELECT'
+          | 'YESNO'
+          | 'SELECT';
+        options: string[];
+      }[];
+    }[];
+  };
+  COMBINED_CONSENT: {
+    combinedConsents: string;
+  };
+  QE_SIGNATURE: {
+    uploadDocument: boolean;
+    downloadDocument: boolean;
+  };
+  CERTIFICATE_ISSUANCE: {
+    region: string;
+    type: 'ONE_TIME' | 'SHORT_TERM' | 'LONG_TERM';
+  };
+  // Empty configs
+  ANTIFRAUD: EmptyConfig;
+  CHECKBOX_SIGNATURE: EmptyConfig;
+  CROSS_DOCUMENT_DATA_MATCH: EmptyConfig;
+  DEVICE_FINGERPRINT: EmptyConfig;
+  FACE_ONBOARDING: EmptyConfig;
+  FIELD_COMPARISON: EmptyConfig;
+  FISCAL_QR: EmptyConfig;
+  GENERATE_QR: EmptyConfig;
+  INSTANT_VERIFY: EmptyConfig;
+  IP_ADDRESS: EmptyConfig;
+  NAME_CAPTURE: EmptyConfig;
+  SHOW_RESULTS: EmptyConfig;
+  STADIUM_SELECTOR: EmptyConfig;
+  UNIVERSAL_IDENTITY: EmptyConfig;
+  WATCHLIST: EmptyConfig;
+  TRUST_GRAPH: EmptyConfig;
+  WATCHLIST_BUSINESS: EmptyConfig;
+};
+
+export type FlowModule = {
+  [K in keyof FlowModuleConfig]: {
+    key: K;
+    configuration: FlowModuleConfig[K];
+  };
+}[keyof FlowModuleConfig];
+
+export type Flow = {
+  flowId: string;
+  name: string;
+  autoApproveEnabled?: boolean;
+  autoApproveLevel?: 'LOW' | 'MEDIUM' | 'HIGH';
+  checkTutorials?: boolean;
+  checkAuthorization?: boolean;
+  redirectDesktopToMobile?: boolean;
+  disableUnsupportedBrowserScreen?: boolean;
+  qrPhishingResistance?: boolean;
+  addContinueToDesktop?: boolean;
+  redirectOriginOnly?: boolean;
+  displayOnboardingResultOnDesktop?: boolean;
+  enableMultipleOnboardings?: boolean;
+  disableLaunchScreen?: boolean;
+  enableSardineRisk?: boolean;
+  mandatoryConsentCheck?: boolean;
+  disableSmsOption?: boolean;
+  mergeSessionRecordings?: boolean;
+  ageAssurance?: boolean;
+  flowModules: FlowModule[];
+  enforceCaptureAttemptLimits?: boolean;
+  enableFraudAi?: boolean;
+  getEnableIdOnlyIdentity?: boolean;
+  ds?: boolean;
+};

package/src/http/__mocks__/api.ts

@@ -0,0 +1,88 @@
+import type { HttpResponse } from '@incodetech/infra';
+import type { Mock } from 'vitest';
+import { vi } from 'vitest';
+
+export function createMockResponse<T>(data: T, ok = true): HttpResponse<T> {
+  return {
+    ok,
+    status: ok ? 200 : 400,
+    statusText: ok ? 'OK' : 'Bad Request',
+    url: '',
+    headers: {},
+    data,
+  };
+}
+
+type MockHttpClient = {
+  defaults: {
+    baseURL: string;
+    headers: Record<string, string>;
+  };
+  request: Mock;
+  get: Mock;
+  post: Mock;
+  put: Mock;
+  patch: Mock;
+  delete: Mock;
+  head: Mock;
+  options: Mock;
+  setHeader: Mock;
+};
+
+export function createMockHttpClient(): MockHttpClient {
+  return {
+    defaults: {
+      baseURL: 'https://mock-api.test',
+      headers: {},
+    },
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+    head: vi.fn(),
+    options: vi.fn(),
+    setHeader: vi.fn(),
+  };
+}
+
+const mockClient = createMockHttpClient();
+
+export const setClient = vi.fn();
+export const getApi = vi.fn().mockReturnValue(mockClient);
+export const isApiConfigured = vi.fn().mockReturnValue(true);
+export const resetApi = vi.fn();
+
+export const api = {
+  get defaults() {
+    return mockClient.defaults;
+  },
+  get: mockClient.get,
+  post: mockClient.post,
+  put: mockClient.put,
+  patch: mockClient.patch,
+  delete: mockClient.delete,
+  head: mockClient.head,
+  options: mockClient.options,
+  request: mockClient.request,
+  setHeader: mockClient.setHeader,
+};
+
+export function resetMocks(): void {
+  mockClient.request.mockReset();
+  mockClient.get.mockReset();
+  mockClient.post.mockReset();
+  mockClient.put.mockReset();
+  mockClient.patch.mockReset();
+  mockClient.delete.mockReset();
+  mockClient.head.mockReset();
+  mockClient.options.mockReset();
+  mockClient.setHeader.mockReset();
+  setClient.mockReset();
+  getApi.mockReset().mockReturnValue(mockClient);
+  isApiConfigured.mockReset().mockReturnValue(true);
+  resetApi.mockReset();
+}
+
+export { mockClient };