@proteoapp/react-native-onboarding 0.1.0

package/src/services/process/generate-data.ts

@@ -0,0 +1,54 @@
+import { api } from '../api'
+import { Objective } from '../../enums'
+import { ContactSupportError } from '../../errors'
+
+type GenerateProcessDataResponse = {
+  data: {
+    auth_token: string
+    bucket_upload: string
+    bucket_region: string
+    datetime: string
+    onboarding_theme: {
+      not_request_document: boolean
+      simplified: boolean
+      has_digital_file: boolean
+      primary_color: string
+      secondary_color: string
+      text_color: string
+      text_color_button: string
+      organization_picture?: string
+    }
+  }
+}
+
+type GenerateProcessDataProps = {
+  tenant: string
+  backgroundCheckId: string
+  objective: Objective
+}
+
+export const generateProcessData = async ({
+  tenant,
+  backgroundCheckId,
+  objective,
+}: GenerateProcessDataProps) => {
+  try {
+    const endpoint =
+      objective === Objective.ONBOARDING
+        ? `/${tenant}/${backgroundCheckId}/generate_data_onboarding`
+        : `/${tenant}/${backgroundCheckId}/generate_data_face_auth`
+
+    return await api.sendRequest<void, GenerateProcessDataResponse>({
+      method: 'GET',
+      url: endpoint,
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      const code = objective === Objective.ONBOARDING ? '0404' : '0420'
+
+      throw new ContactSupportError(code)
+    }
+
+    throw err
+  }
+}

package/src/services/process/index.ts

@@ -0,0 +1,6 @@
+export * from './generate-data'
+export * from './start'
+export * from './done'
+export * from './alter-status'
+export * from './create-timeline'
+export * from './create-error-log'

package/src/services/process/start.ts

@@ -0,0 +1,86 @@
+import { api } from '../api'
+import { Objective } from '../../enums'
+import { ContactSupportError } from '../../errors'
+
+type Location = {
+  ip: string
+  hostname: string
+  city: string
+  region: string
+  country: string
+  loc: string
+  org: string
+  postal: string
+  timezone: string
+}
+
+type Geolocation = {
+  latitude: number
+  longitude: number
+}
+
+type StartProcessRequest = {
+  params_input: {
+    document: string
+    location: Location
+    geolocation: Geolocation
+  }
+  datetime_client: string
+}
+
+type StartProcessResponse = {
+  data: {
+    background_check_execution_id: string
+  }
+}
+
+type StartProcessProps = {
+  authToken: string
+  tenant: string
+  backgroundCheckId: string
+  document: string
+  objective: Objective
+  location: Location
+  geolocation: Geolocation
+}
+
+export const startProcess = async ({
+  authToken,
+  tenant,
+  backgroundCheckId,
+  document,
+  objective,
+  location,
+  geolocation,
+}: StartProcessProps) => {
+  try {
+    const endpoint =
+      objective === Objective.ONBOARDING
+        ? `/${tenant}/${backgroundCheckId}/start_onboarding`
+        : `/${tenant}/${backgroundCheckId}/start_face_auth`
+
+    return await api.sendRequest<StartProcessRequest, StartProcessResponse>({
+      method: 'POST',
+      url: endpoint,
+      data: {
+        params_input: {
+          document,
+          location,
+          geolocation,
+        },
+        datetime_client: new Date().toISOString(),
+      },
+      headers: {
+        token: authToken,
+      },
+    })
+  } catch (err) {
+    if (err instanceof ContactSupportError) {
+      const code = objective === Objective.ONBOARDING ? '0406' : '0419'
+
+      throw new ContactSupportError(code)
+    }
+
+    throw err
+  }
+}

package/src/store/env-variables.ts

@@ -0,0 +1,37 @@
+import { createWithEqualityFn } from 'zustand/traditional'
+import { shallow } from 'zustand/shallow'
+
+type EnvVariablesState = {
+  baseApiUrl: string
+  baseWssUrl: string
+  baseLogUrl: string
+  validateDocumentImgUrl: string
+  validateDocumentPdfUrl: string
+  ipInfoUrl: string
+  ipInfoToken: string
+  minimumFaceConfidence: number
+  isConfigured: boolean
+  configure: (
+    config: Omit<EnvVariablesState, 'isConfigured' | 'configure'>,
+  ) => void
+}
+
+export const useEnvVariablesStore = createWithEqualityFn<EnvVariablesState>(
+  (set) => ({
+    baseApiUrl: '',
+    baseWssUrl: '',
+    baseLogUrl: '',
+    validateDocumentImgUrl: '',
+    validateDocumentPdfUrl: '',
+    ipInfoUrl: '',
+    ipInfoToken: '',
+    minimumFaceConfidence: 0,
+    isConfigured: false,
+    configure: (config) =>
+      set({
+        ...config,
+        isConfigured: true,
+      }),
+  }),
+  shallow,
+)

package/src/store/flow.ts

@@ -0,0 +1,54 @@
+import { createWithEqualityFn } from 'zustand/traditional'
+import { shallow } from 'zustand/shallow'
+
+type Credentials = {
+  accessKeyId: string
+  secretAccessKey: string
+  sessionToken: string
+  expiration: string
+}
+
+type FlowState = {
+  temporaryCredentials: Credentials | null
+  backgroundCheckExecutionId: string | null
+  facePictureUrl: string | null
+  faceConfidence: number | null
+  documentUrl: string | null
+  frontDocumentPictureUrl: string | null
+  backDocumentPictureUrl: string | null
+  setTemporaryCredentials: (
+    temporaryCredentials: FlowState['temporaryCredentials'],
+  ) => void
+  setBackgroundCheckExecutionId: (
+    backgroundCheckExecutionId: FlowState['backgroundCheckExecutionId'],
+  ) => void
+  setFacePictureUrl: (url: FlowState['facePictureUrl']) => void
+  setFaceConfidence: (faceConfidence: FlowState['faceConfidence']) => void
+  setDocumentUrl: (url: FlowState['documentUrl']) => void
+  setFrontDocumentPictureUrl: (
+    url: FlowState['frontDocumentPictureUrl'],
+  ) => void
+  setBackDocumentPictureUrl: (url: FlowState['backDocumentPictureUrl']) => void
+}
+
+export const useFlowStore = createWithEqualityFn<FlowState>(
+  (set) => ({
+    temporaryCredentials: null,
+    backgroundCheckExecutionId: null,
+    facePictureUrl: null,
+    faceConfidence: null,
+    documentUrl: null,
+    frontDocumentPictureUrl: null,
+    backDocumentPictureUrl: null,
+    setTemporaryCredentials: (temporaryCredentials) =>
+      set({ temporaryCredentials }),
+    setBackgroundCheckExecutionId: (backgroundCheckExecutionId) =>
+      set({ backgroundCheckExecutionId }),
+    setFacePictureUrl: (url) => set({ facePictureUrl: url }),
+    setFaceConfidence: (faceConfidence) => set({ faceConfidence }),
+    setDocumentUrl: (url) => set({ documentUrl: url }),
+    setFrontDocumentPictureUrl: (url) => set({ frontDocumentPictureUrl: url }),
+    setBackDocumentPictureUrl: (url) => set({ backDocumentPictureUrl: url }),
+  }),
+  shallow,
+)

package/src/store/index.ts

@@ -0,0 +1,4 @@
+export * from './env-variables'
+export * from './process'
+export * from './process-timeline-queue'
+export * from './flow'

package/src/store/process-timeline-queue.ts

@@ -0,0 +1,25 @@
+import { createWithEqualityFn } from 'zustand/traditional'
+import { shallow } from 'zustand/shallow'
+import { type CreateProcessTimelineProps } from '../services'
+
+type ProcessTimelineEvent = Pick<
+  CreateProcessTimelineProps,
+  'processStatus' | 'status' | 'message' | 'image'
+>
+
+type ProcessTimelineQueueState = {
+  events: ProcessTimelineEvent[]
+  enqueue: (event: ProcessTimelineEvent) => void
+  clear: () => void
+}
+
+export const useProcessTimelineQueueStore =
+  createWithEqualityFn<ProcessTimelineQueueState>(
+    (set) => ({
+      events: [],
+      enqueue: (event) =>
+        set((state) => ({ events: [...state.events, event] })),
+      clear: () => set({ events: [] }),
+    }),
+    shallow,
+  )

package/src/store/process.ts

@@ -0,0 +1,64 @@
+import { createWithEqualityFn } from 'zustand/traditional'
+import { shallow } from 'zustand/shallow'
+import { Objective, ProcessStatus } from '../enums'
+
+type Bucket = {
+  region: string
+  upload: string
+}
+
+type ProcessState = {
+  authToken: string
+  tenant: string
+  backgroundCheckId: string
+  document: string
+  objective: Objective
+  status: ProcessStatus
+  bucket: Bucket | null
+  organizationPicture: string | null
+  isSimplifiedMode: boolean
+  notRequestDocument: boolean
+  hasDigitalFile: boolean
+  isConfigured: boolean
+  onFinish: () => void
+  configure: (
+    config: Omit<
+      ProcessState,
+      | 'status'
+      | 'isConfigured'
+      | 'configure'
+      | 'setStatus'
+      | 'setNotRequestDocument'
+    >,
+  ) => void
+  setStatus: (status: ProcessState['status']) => void
+  setNotRequestDocument: (
+    notRequestDocument: ProcessState['notRequestDocument'],
+  ) => void
+}
+
+export const useProcessStore = createWithEqualityFn<ProcessState>(
+  (set) => ({
+    authToken: '',
+    tenant: '',
+    backgroundCheckId: '',
+    document: '',
+    objective: Objective.ONBOARDING,
+    status: ProcessStatus.START,
+    bucket: null,
+    organizationPicture: null,
+    isSimplifiedMode: false,
+    notRequestDocument: false,
+    hasDigitalFile: false,
+    isConfigured: false,
+    onFinish: () => {},
+    configure: (config) =>
+      set({
+        ...config,
+        isConfigured: true,
+      }),
+    setStatus: (status) => set({ status }),
+    setNotRequestDocument: (notRequestDocument) => set({ notRequestDocument }),
+  }),
+  shallow,
+)

package/src/theme/border-radius.ts

@@ -0,0 +1,6 @@
+export const borderRadii = {
+  xs: 2,
+  s: 4,
+  md: 8,
+  full: 999,
+}

package/src/theme/button-variants.ts

@@ -0,0 +1,16 @@
+export const buttonVariants = {
+  defaults: {
+    flexDirection: 'row',
+    alignItems: 'center',
+    justifyContent: 'center',
+    columnGap: 's',
+    height: 52,
+    backgroundColor: 'primary',
+    borderRadius: 'md',
+  },
+  outline: {
+    backgroundColor: 'transparent',
+    borderWidth: 1,
+    borderColor: 'primary',
+  },
+}

package/src/theme/common-colors.ts

@@ -0,0 +1,12 @@
+export const commonColors = {
+  transparent: 'transparent',
+  white: '#FFFFFF',
+  black: '#000000',
+  dark: '#000000B3',
+  gray: '#E0E0E0',
+  green: '#0E9F6E',
+  red: '#F05252',
+  loading: '#FACC15',
+  success: '#22C55E',
+  failure: '#F87171',
+}

package/src/theme/default-colors.ts

@@ -0,0 +1,4 @@
+export const defaultColors = {
+  background: '#E0E0E0',
+  text: '#2E2E2E',
+}

package/src/theme/index.ts

@@ -0,0 +1,31 @@
+import { createTheme } from '@shopify/restyle'
+import { commonColors } from './common-colors'
+import { spacing } from './spacing'
+import { borderRadii } from './border-radius'
+import { textVariants } from './text-variants'
+import { buttonVariants } from './button-variants'
+
+type Colors = {
+  primary: string
+  secondary: string
+  text: string
+  textButton: string
+}
+
+type CreateCustomThemeProps = {
+  colors: Colors
+}
+
+export const createCustomTheme = ({ colors }: CreateCustomThemeProps) =>
+  createTheme({
+    colors: {
+      ...commonColors,
+      ...colors,
+    },
+    spacing,
+    borderRadii,
+    textVariants,
+    buttonVariants,
+  })
+
+export type CustomThemeProps = ReturnType<typeof createCustomTheme>

package/src/theme/spacing.ts

@@ -0,0 +1,11 @@
+export const spacing = {
+  xs: 6,
+  s: 8,
+  m: 16,
+  l: 20,
+  xl: 24,
+  '2xl': 32,
+  '3xl': 40,
+  '4xl': 48,
+  '5xl': 56,
+}

package/src/theme/text-variants.ts

@@ -0,0 +1,14 @@
+export const textVariants = {
+  defaults: {
+    color: 'text',
+    fontSize: 14,
+    fontWeight: 400,
+  },
+  subtitle: {
+    fontSize: 16,
+    fontWeight: 600,
+  },
+  caption: {
+    fontSize: 12,
+  },
+}

package/src/utils/get-error-metadata.ts

@@ -0,0 +1,46 @@
+import { errorHeaderFields } from '../constants'
+import {
+  CameraPermissionDeniedError,
+  CameraProblemError,
+  ContactSupportError,
+  GeolocationPermissionDeniedError,
+  NonStandardHoursError,
+  ProcessAlreadyCompletedError,
+} from '../errors'
+
+export const getErrorMetadata = (error: Error) => {
+  const isCameraPermissionDeniedError =
+    error instanceof CameraPermissionDeniedError
+  const isCameraProblemError = error instanceof CameraProblemError
+  const isGeolocationPermissionDeniedError =
+    error instanceof GeolocationPermissionDeniedError
+  const isNonStandardHoursError = error instanceof NonStandardHoursError
+  const isProcessAlreadyCompletedError =
+    error instanceof ProcessAlreadyCompletedError
+  const isContactSupportError = error instanceof ContactSupportError
+  const isKnownError =
+    isCameraPermissionDeniedError ||
+    isCameraProblemError ||
+    isGeolocationPermissionDeniedError ||
+    isNonStandardHoursError ||
+    isProcessAlreadyCompletedError ||
+    (isContactSupportError && error.code !== '0')
+  const hasCode =
+    isNonStandardHoursError ||
+    isProcessAlreadyCompletedError ||
+    isContactSupportError
+  const defaultError = new ContactSupportError()
+  const headerFields =
+    errorHeaderFields[error.name] ?? errorHeaderFields.default
+  const message = isKnownError ? error.message : defaultError.message
+  const code = isKnownError && hasCode ? error.code : defaultError.code
+
+  return {
+    icon: headerFields.icon,
+    title: headerFields.title,
+    message,
+    code,
+    isPermissionDenied:
+      isCameraPermissionDeniedError || isGeolocationPermissionDeniedError,
+  }
+}

package/src/utils/get-route-step.ts

@@ -0,0 +1,24 @@
+import { type RootStackParamList, type RouteName } from '../navigation'
+import {
+  routeStepIndexes,
+  routeStepIndexDescriptions,
+  type RouteStepIndex,
+} from '../constants'
+
+type RouteStep = {
+  index: RouteStepIndex
+  description: string
+}
+
+export const getRouteStep = <T extends RouteName>(
+  name: T,
+  params: RootStackParamList[T],
+): RouteStep => {
+  const index = routeStepIndexes[name](params)
+  const description = routeStepIndexDescriptions[index].toLowerCase()
+
+  return {
+    index,
+    description,
+  }
+}

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './get-error-metadata'
+export * from './get-route-step'