@proteoapp/react-native-onboarding 0.1.0

package/src/screens/face-auth/view.tsx

@@ -0,0 +1,51 @@
+import { createBox, createText } from '@shopify/restyle'
+import { FaceAuthAvatarSvg, ArrowRightSvg } from '../../../assets/svgs'
+import { RootLayout } from '../../layouts'
+import { type CustomThemeProps } from '../../theme'
+import { Button, RecommendedValidations } from '../../components'
+import { useFaceAuthViewModel } from './view-model'
+
+const Box = createBox<CustomThemeProps>()
+const Text = createText<CustomThemeProps>()
+
+type FaceAuthViewProps = ReturnType<typeof useFaceAuthViewModel>
+
+export const FaceAuthView = ({
+  mainImageColor,
+  startButtonProps,
+  recommendedValidationsProps,
+  onStartPress,
+}: FaceAuthViewProps) => (
+  <RootLayout>
+    <Box flex={1} alignItems="center">
+      <Box flex={1} justifyContent="center">
+        <FaceAuthAvatarSvg color={mainImageColor} />
+      </Box>
+      <Box width="80%" rowGap="s">
+        <Text variant="subtitle" textAlign="center">
+          Reconhecimento facial
+        </Text>
+        <Text textAlign="center">
+          Posicione o rosto e siga as instruções para validar sua identidade.
+        </Text>
+      </Box>
+    </Box>
+    <Button
+      {...startButtonProps}
+      title="Começar"
+      marginVertical="m"
+      iconRight={ArrowRightSvg}
+      onPress={onStartPress}
+    />
+    <RecommendedValidations
+      {...recommendedValidationsProps}
+      mode="tip"
+      title="Antes de começar, siga estas dicas:"
+      recommendations={[
+        'Encontre um ambiente bem iluminado;',
+        'Remova acessórios como óculos, bonés ou máscaras;',
+        'Evite fundo muito escuro ou com muitas distrações.',
+      ]}
+    />
+  </RootLayout>
+)

package/src/screens/index.ts

@@ -0,0 +1,8 @@
+export * from './face-auth'
+export * from './face-auth/camera'
+export * from './face-auth/analysis'
+export * from './document'
+export * from './document/camera'
+export * from './document/review'
+export * from './document/analysis'
+export * from './process-finished'

package/src/screens/process-finished/index.tsx

@@ -0,0 +1,8 @@
+import { ProcessFinishedView } from './view'
+import { useProcessFinishedViewModel } from './view-model'
+
+export const ProcessFinishedScreen = () => {
+  const props = useProcessFinishedViewModel()
+
+  return <ProcessFinishedView {...props} />
+}

package/src/screens/process-finished/view-model.ts

@@ -0,0 +1,15 @@
+import { useEffect } from 'react'
+import { useTheme } from '@shopify/restyle'
+import { useProcessStore } from '../../store'
+import { type CustomThemeProps } from '../../theme'
+
+export const useProcessFinishedViewModel = () => {
+  const { colors } = useTheme<CustomThemeProps>()
+  const onFinish = useProcessStore((state) => state.onFinish)
+
+  useEffect(() => {
+    setTimeout(() => onFinish(), 3000)
+  }, [onFinish])
+
+  return { svgMiniIconColor: colors.secondary }
+}

package/src/screens/process-finished/view.tsx

@@ -0,0 +1,24 @@
+import { createBox, createText } from '@shopify/restyle'
+import { ProcessFinishedSvg } from '../../../assets/svgs'
+import { RootLayout } from '../../layouts'
+import { type CustomThemeProps } from '../../theme'
+import { useProcessFinishedViewModel } from './view-model'
+
+const Box = createBox<CustomThemeProps>()
+const Text = createText<CustomThemeProps>()
+
+type ProcessFinishedViewProps = ReturnType<typeof useProcessFinishedViewModel>
+
+export const ProcessFinishedView = ({
+  svgMiniIconColor,
+}: ProcessFinishedViewProps) => (
+  <RootLayout>
+    <Box flex={1} alignItems="center" justifyContent="center" rowGap="xl">
+      <ProcessFinishedSvg miniIconColor={svgMiniIconColor} />
+      <Box alignItems="center" justifyContent="center" rowGap="s">
+        <Text variant="subtitle">Processo realizado com sucesso!</Text>
+        <Text>Aguarde, você será redirecionado em instantes.</Text>
+      </Box>
+    </Box>
+  </RootLayout>
+)

package/src/services/api.ts

@@ -0,0 +1,39 @@
+import axios, { AxiosError, type AxiosRequestConfig } from 'axios'
+import { useEnvVariablesStore } from '../store'
+import {
+  ContactSupportError,
+  ProcessAlreadyCompletedError,
+  NonStandardHoursError,
+} from '../errors'
+
+const instance = axios.create()
+
+export const api = {
+  sendRequest: async <TRequest, TResponse>(
+    config: AxiosRequestConfig<TRequest>,
+  ): Promise<TResponse> => {
+    try {
+      const { baseApiUrl } = useEnvVariablesStore.getState()
+
+      const response = await instance.request<TResponse>({
+        ...config,
+        baseURL: config.baseURL ?? baseApiUrl,
+      })
+
+      return response.data
+    } catch (err) {
+      const error = err as AxiosError<{ error_code: string }>
+      const code = error.response?.data.error_code ?? '0'
+
+      if (code === '0422' || code === '0423') {
+        throw new ProcessAlreadyCompletedError(code)
+      }
+
+      if (code === '0427') {
+        throw new NonStandardHoursError()
+      }
+
+      throw new ContactSupportError(code)
+    }
+  },
+}

package/src/services/credentials/generate.ts

@@ -0,0 +1,37 @@
+import { ContactSupportError } from '../../errors'
+import { api } from '../api'
+
+type GenerateTemporaryCredentialsResponse = {
+  data: {
+    access_key_id: string
+    secret_access_key: string
+    session_token: string
+    expiration: string
+  }
+}
+
+type GenerateTemporaryCredentialsProps = {
+  authToken: string
+  tenant: string
+  backgroundCheckId: string
+}
+
+export const generateTemporaryCredentials = async ({
+  authToken,
+  tenant,
+  backgroundCheckId,
+}: GenerateTemporaryCredentialsProps) => {
+  try {
+    return await api.sendRequest<void, GenerateTemporaryCredentialsResponse>({
+      method: 'GET',
+      url: `/${tenant}/${backgroundCheckId}/generate_temporary_credentials`,
+      headers: { token: authToken },
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      throw new ContactSupportError('0405')
+    }
+
+    throw err
+  }
+}

package/src/services/credentials/index.ts

@@ -0,0 +1 @@
+export * from './generate'

package/src/services/documents/index.ts

@@ -0,0 +1,2 @@
+export * from './validate-picture'
+export * from './validate-pdf'

package/src/services/documents/validate-pdf.ts

@@ -0,0 +1,46 @@
+import { api } from '../api'
+import { DocumentType } from '../../enums'
+import { useEnvVariablesStore } from '../../store'
+import { ContactSupportError } from '../../errors'
+
+type ValidateDocumentPDFRequest = {
+  tenant_id: string
+  background_check_execution_id: string
+  document_type: DocumentType
+  pdf_url: string
+}
+
+type ValidateDocumentPDFProps = {
+  tenant: string
+  backgroundCheckExecutionId: string
+  type: DocumentType
+  url: string
+}
+
+export const validateDocumentPDF = async ({
+  tenant,
+  backgroundCheckExecutionId,
+  type,
+  url,
+}: ValidateDocumentPDFProps) => {
+  try {
+    const { validateDocumentImgUrl } = useEnvVariablesStore.getState()
+
+    return await api.sendRequest<ValidateDocumentPDFRequest, void>({
+      method: 'POST',
+      baseURL: validateDocumentImgUrl,
+      data: {
+        tenant_id: tenant,
+        background_check_execution_id: backgroundCheckExecutionId,
+        document_type: type,
+        pdf_url: url,
+      },
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      throw new ContactSupportError('0424')
+    }
+
+    throw err
+  }
+}

package/src/services/documents/validate-picture.ts

@@ -0,0 +1,50 @@
+import { api } from '../api'
+import { useEnvVariablesStore } from '../../store'
+import { ContactSupportError } from '../../errors'
+
+type ValidateDocumentImageRequest = {
+  tenant_id: string
+  background_check_execution_id: string
+  image_url: string
+}
+
+type ValidateDocumentImageResponse = {
+  status: 'ok' | 'error'
+  class: 'Front' | 'Back'
+  ValidationFeedback: string[]
+}
+
+type ValidateDocumentPictureProps = {
+  tenant: string
+  backgroundCheckExecutionId: string
+  url: string
+}
+
+export const validateDocumentPicture = async ({
+  tenant,
+  backgroundCheckExecutionId,
+  url,
+}: ValidateDocumentPictureProps) => {
+  try {
+    const { validateDocumentImgUrl } = useEnvVariablesStore.getState()
+
+    return await api.sendRequest<
+      ValidateDocumentImageRequest,
+      ValidateDocumentImageResponse
+    >({
+      method: 'POST',
+      baseURL: validateDocumentImgUrl,
+      data: {
+        tenant_id: tenant,
+        background_check_execution_id: backgroundCheckExecutionId,
+        image_url: url,
+      },
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      throw new ContactSupportError('0424')
+    }
+
+    throw err
+  }
+}

package/src/services/index.ts

@@ -0,0 +1,5 @@
+export * from './process'
+export * from './credentials'
+export * from './onboarding'
+export * from './location'
+export * from './documents'

package/src/services/location/get-from-user-ip.ts

@@ -0,0 +1,31 @@
+import axios from 'axios'
+import { useEnvVariablesStore } from '../../store'
+import { ContactSupportError } from '../../errors'
+
+const instance = axios.create()
+
+type GetLocationFromUserIpResponse = {
+  ip: string
+  hostname: string
+  city: string
+  region: string
+  country: string
+  loc: string
+  org: string
+  postal: string
+  timezone: string
+}
+
+export const getLocationFromUserIp = async () => {
+  try {
+    const { ipInfoUrl, ipInfoToken } = useEnvVariablesStore.getState()
+
+    const response = await instance.get<GetLocationFromUserIpResponse>(
+      `${ipInfoUrl}?token=${ipInfoToken}`,
+    )
+
+    return response.data
+  } catch (err) {
+    throw new ContactSupportError()
+  }
+}

package/src/services/location/index.ts

@@ -0,0 +1 @@
+export * from './get-from-user-ip'

package/src/services/onboarding/create-channel.ts

@@ -0,0 +1,45 @@
+import {
+  createConsumer,
+  Subscription,
+  type BaseMixin,
+} from '@rails/actioncable'
+import { useEnvVariablesStore } from '../../store'
+import { ProcessStatus, RequestStatus } from '../../enums'
+
+global.addEventListener = () => {}
+global.removeEventListener = () => {}
+
+export type OnReceiveOnboardingChannelData = {
+  status: RequestStatus
+  status_onboarding: ProcessStatus
+  not_request_document: boolean
+}
+
+type CreateOnboardingChannelProps = {
+  authToken: string
+  tenant: string
+  backgroundCheckExecutionId: string
+  onReceiveData: (data: OnReceiveOnboardingChannelData) => void
+}
+
+export const createOnboardingChannel = ({
+  authToken,
+  tenant,
+  backgroundCheckExecutionId,
+  onReceiveData,
+}: CreateOnboardingChannelProps): Subscription<BaseMixin> => {
+  const { baseWssUrl } = useEnvVariablesStore.getState()
+  const consumer = createConsumer(
+    `${baseWssUrl}?token=${authToken}&tenant=${tenant}`,
+  )
+
+  return consumer.subscriptions.create(
+    {
+      channel: 'OnboardingChannel',
+      background_check_execution_id: backgroundCheckExecutionId,
+    },
+    {
+      received: onReceiveData,
+    },
+  )
+}

package/src/services/onboarding/index.ts

@@ -0,0 +1 @@
+export * from './create-channel'

package/src/services/process/alter-status.ts

@@ -0,0 +1,38 @@
+import { api } from '../api'
+import { ProcessStatus } from '../../enums'
+import { ContactSupportError } from '../../errors'
+
+type AlterProcessStatusRequest = {
+  status_onboarding: ProcessStatus
+}
+
+type AlterProcessStatusProps = {
+  authToken: string
+  tenant: string
+  backgroundCheckId: string
+  backgroundCheckExecutionId: string
+  status: ProcessStatus
+}
+
+export const alterProcessStatus = async ({
+  authToken,
+  tenant,
+  backgroundCheckId,
+  backgroundCheckExecutionId,
+  status,
+}: AlterProcessStatusProps) => {
+  try {
+    return await api.sendRequest<AlterProcessStatusRequest, void>({
+      method: 'POST',
+      url: `/${tenant}/${backgroundCheckId}/${backgroundCheckExecutionId}/alter_status_onboarding`,
+      data: { status_onboarding: status },
+      headers: { token: authToken },
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      throw new ContactSupportError('0407')
+    }
+
+    throw err
+  }
+}

package/src/services/process/create-error-log.ts

@@ -0,0 +1,28 @@
+import { api } from '../api'
+import { useEnvVariablesStore } from '../../store'
+
+type CreateProcessErrorLogRequest = {
+  background_check_execution_id: string
+  log_text: string
+}
+
+type CreateProcessErrorLogProps = {
+  backgroundCheckExecutionId: string
+  text: string
+}
+
+export const createProcessErrorLog = async ({
+  backgroundCheckExecutionId,
+  text,
+}: CreateProcessErrorLogProps) => {
+  const { baseLogUrl } = useEnvVariablesStore.getState()
+
+  return await api.sendRequest<CreateProcessErrorLogRequest, void>({
+    method: 'POST',
+    baseURL: baseLogUrl,
+    data: {
+      background_check_execution_id: backgroundCheckExecutionId,
+      log_text: text,
+    },
+  })
+}

package/src/services/process/create-timeline.ts

@@ -0,0 +1,75 @@
+import { api } from '../api'
+import { ImageType, ProcessStatus, TimelineStatus } from '../../enums'
+import { ContactSupportError } from '../../errors'
+
+type CreateProcessTimelineRequest = {
+  status_onboarding: ProcessStatus
+  details: {
+    status: TimelineStatus
+    message: string
+    image_type?: ImageType
+    image_url?: string
+  }
+}
+
+type BaseCreateProcessTimelineProps = {
+  authToken: string
+  tenant: string
+  backgroundCheckId: string
+  backgroundCheckExecutionId: string
+  processStatus: ProcessStatus
+  status: TimelineStatus
+  message: string
+}
+
+type CreateProcessTimelineWithPictureProps = BaseCreateProcessTimelineProps & {
+  image: {
+    type: ImageType
+    url: string
+  }
+}
+
+type CreateProcessTimelineWithoutPictureProps =
+  BaseCreateProcessTimelineProps & {
+    image?: never
+  }
+
+export type CreateProcessTimelineProps =
+  | CreateProcessTimelineWithPictureProps
+  | CreateProcessTimelineWithoutPictureProps
+
+export const createProcessTimeline = async ({
+  authToken,
+  tenant,
+  backgroundCheckId,
+  backgroundCheckExecutionId,
+  processStatus,
+  status,
+  message,
+  ...props
+}: CreateProcessTimelineProps) => {
+  try {
+    return await api.sendRequest<CreateProcessTimelineRequest, void>({
+      method: 'POST',
+      url: `${tenant}/${backgroundCheckId}/${backgroundCheckExecutionId}/create_timeline`,
+      data: {
+        status_onboarding: processStatus,
+        details: {
+          status,
+          message,
+          ...(props.image && {
+            image_type: props.image.type,
+            image_url: props.image.url,
+          }),
+        },
+      },
+      headers: { token: authToken },
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      throw new ContactSupportError('0425')
+    }
+
+    throw err
+  }
+}

package/src/services/process/done.ts

@@ -0,0 +1,114 @@
+import { api } from '../api'
+import { DocumentType, Objective } from '../../enums'
+import { ContactSupportError } from '../../errors'
+
+type DoneProcessRequest = {
+  liveness: {
+    Confidence: number
+    Status: 'SUCCEEDED'
+    ReferenceImage: {
+      image_url: string
+    }
+  }
+  document: string
+  doc_type?: DocumentType
+  document_img?: {
+    doc_img_url?: string
+    doc_img_a_url?: string
+    doc_img_b_url?: string
+  }
+}
+
+type BaseDoneProcessProps = {
+  authToken: string
+  tenant: string
+  backgroundCheckId: string
+  backgroundCheckExecutionId: string
+  document: string
+  objective: Objective
+  faceAuth: {
+    confidence: number
+    pictureUrl: string
+  }
+}
+
+type DoneFaceAuthProps = BaseDoneProcessProps & {
+  documentPictureUrls?: never
+  documentType?: never
+  documentPdfUrl?: never
+}
+
+type DoneOnboardingWithDocumentPictureProps = BaseDoneProcessProps & {
+  documentPictureUrls: {
+    front: string
+    back: string
+  }
+  documentType?: never
+  documentPdfUrl?: never
+}
+
+type DoneOnboardingWithDocumentPdfProps = BaseDoneProcessProps & {
+  documentPictureUrls?: never
+  documentType: DocumentType
+  documentPdfUrl: string
+}
+
+type DoneProcessProps =
+  | DoneFaceAuthProps
+  | DoneOnboardingWithDocumentPictureProps
+  | DoneOnboardingWithDocumentPdfProps
+
+export const doneProcess = async ({
+  authToken,
+  tenant,
+  backgroundCheckId,
+  backgroundCheckExecutionId,
+  document,
+  objective,
+  faceAuth,
+  documentPictureUrls,
+  documentType,
+  documentPdfUrl,
+}: DoneProcessProps) => {
+  try {
+    const endpoint =
+      objective === Objective.ONBOARDING
+        ? `/${tenant}/${backgroundCheckId}/${backgroundCheckExecutionId}/done_onboarding`
+        : `/${tenant}/${backgroundCheckId}/${backgroundCheckExecutionId}/done_face_auth`
+
+    return await api.sendRequest<DoneProcessRequest, void>({
+      method: 'POST',
+      url: endpoint,
+      data: {
+        liveness: {
+          Status: 'SUCCEEDED',
+          Confidence: faceAuth.confidence,
+          ReferenceImage: {
+            image_url: faceAuth.pictureUrl,
+          },
+        },
+        document,
+        doc_type: documentType,
+        ...((documentPictureUrls || documentPdfUrl) && {
+          document_img: documentPictureUrls
+            ? {
+                doc_img_a_url: documentPictureUrls.front,
+                doc_img_b_url: documentPictureUrls.back,
+              }
+            : { doc_img_url: documentPdfUrl },
+        }),
+      },
+      headers: {
+        token: authToken,
+      },
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      const code = objective === Objective.ONBOARDING ? '0409' : '0421'
+
+      throw new ContactSupportError(code)
+    }
+
+    throw err
+  }
+}