[TS migration] Migrate 'Onfido' component to TypeScript #31378
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,17 +1,28 @@ | ||||||||
| import {Onfido as OnfidoSDK} from 'onfido-sdk-ui'; | ||||||||
| import React, {forwardRef, useEffect} from 'react'; | ||||||||
| import type {ForwardedRef} from 'react'; | ||||||||
| import type {LocaleContextProps} from '@components/LocaleContextProvider'; | ||||||||
| import useLocalize from '@hooks/useLocalize'; | ||||||||
| import useTheme from '@hooks/useTheme'; | ||||||||
| import Log from '@libs/Log'; | ||||||||
| import type {ThemeColors} from '@styles/theme/types'; | ||||||||
| import FontUtils from '@styles/utils/FontUtils'; | ||||||||
| import variables from '@styles/variables'; | ||||||||
| import CONST from '@src/CONST'; | ||||||||
| import {isEmptyObject} from '@src/types/utils/EmptyObject'; | ||||||||
| import './index.css'; | ||||||||
| import type {OnfidoElement, OnfidoProps} from './types'; | ||||||||
|
|
||||||||
| type InitializeOnfidoProps = OnfidoProps & | ||||||||
| Pick<LocaleContextProps, 'translate' | 'preferredLocale'> & { | ||||||||
| theme: ThemeColors; | ||||||||
| }; | ||||||||
|
|
||||||||
| type OnfidoEvent = Event & { | ||||||||
| detail?: Record<string, unknown>; | ||||||||
| }; | ||||||||
|
|
||||||||
| function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLocale, translate, theme}: InitializeOnfidoProps) { | ||||||||
| OnfidoSDK.init({ | ||||||||
| token: sdkToken, | ||||||||
| containerId: CONST.ONFIDO.CONTAINER_ID, | ||||||||
|
|
@@ -20,7 +31,7 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||||||
| fontFamilySubtitle: `${FontUtils.fontFamily.platform.EXP_NEUE}, -apple-system, serif`, | ||||||||
| fontFamilyBody: `${FontUtils.fontFamily.platform.EXP_NEUE}, -apple-system, serif`, | ||||||||
| fontSizeTitle: `${variables.fontSizeLarge}px`, | ||||||||
| fontWeightTitle: Number(FontUtils.fontWeight.bold), | ||||||||
| fontWeightSubtitle: 400, | ||||||||
| fontSizeSubtitle: `${variables.fontSizeNormal}px`, | ||||||||
| colorContentTitle: theme.text, | ||||||||
|
|
@@ -45,10 +56,10 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||||||
| colorBorderLinkUnderline: theme.link, | ||||||||
| colorBackgroundLinkHover: theme.link, | ||||||||
| colorBackgroundLinkActive: theme.link, | ||||||||
| colorBackgroundInfoPill: theme.link, | ||||||||
| colorBackgroundSelector: theme.appBG, | ||||||||
| colorBackgroundDocTypeButton: theme.success, | ||||||||
| borderWidthSurfaceModal: '0px', | ||||||||
|
There was a problem hiding this comment.
Suggested change
@VickyStash Could you help to add borderWidthSurfaceModal property to hide the black border (more information here) |
||||||||
| colorBackgroundDocTypeButtonHover: theme.successHover, | ||||||||
| colorBackgroundButtonIconHover: theme.transparent, | ||||||||
| colorBackgroundButtonIconActive: theme.transparent, | ||||||||
|
|
@@ -57,11 +68,10 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||||||
| { | ||||||||
| type: CONST.ONFIDO.TYPE.DOCUMENT, | ||||||||
| options: { | ||||||||
| forceCrossDevice: true, | ||||||||
|
There was a problem hiding this comment. It was removed from lib some time ago https://documentation.onfido.com/sdk/web/#no--1100 There was a problem hiding this comment. ok, but we should make sure isn't being used in Onfido SDK, because it can be an issue with TS typings but not the code itself. There was a problem hiding this comment. From what I understood it was deprecated in 10.1.10, but we are at There was a problem hiding this comment. @fabioh8010 There was a problem hiding this comment. Thanks for explanation @VickyStash ! |
||||||||
| hideCountrySelection: true, | ||||||||
| documentTypes: { | ||||||||
|
There was a problem hiding this comment. This param wasn't found by TS There was a problem hiding this comment. ok, but we should make sure isn't being used in Onfido SDK, because it can be an issue with TS typings but not the code itself. There was a problem hiding this comment. Since I don't have access to the source code it's hard to say if it's used. But based on the docs you can pass country to specific document, which is done here. |
||||||||
| // eslint-disable-next-line @typescript-eslint/naming-convention | ||||||||
| driving_licence: { | ||||||||
| country: 'USA', | ||||||||
| }, | ||||||||
|
|
@@ -76,17 +86,15 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||||||
| }, | ||||||||
| }, | ||||||||
| ], | ||||||||
|
There was a problem hiding this comment. We don't have There was a problem hiding this comment. and what about There was a problem hiding this comment.
|
||||||||
| onComplete: (data) => { | ||||||||
VickyStash marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||
| if (isEmptyObject(data)) { | ||||||||
| Log.warn('Onfido completed with no data'); | ||||||||
| } | ||||||||
| onSuccess(data); | ||||||||
| }, | ||||||||
| onError: (error) => { | ||||||||
| const errorType = error.type; | ||||||||
| const errorMessage = error.message ?? CONST.ERROR.UNKNOWN_ERROR; | ||||||||
| Log.hmmm('Onfido error', {errorType, errorMessage}); | ||||||||
| if (errorType === CONST.WALLET.ERROR.ONFIDO_USER_CONSENT_DENIED) { | ||||||||
| onUserExit(); | ||||||||
|
|
@@ -103,26 +111,27 @@ function initializeOnfido({sdkToken, onSuccess, onError, onUserExit, preferredLo | |||||||
| // https://github.com/Expensify/App/issues/17244 | ||||||||
| // https://documentation.onfido.com/sdk/web/#custom-languages | ||||||||
| phrases: { | ||||||||
| // eslint-disable-next-line @typescript-eslint/naming-convention | ||||||||
| 'generic.back': translate('common.back'), | ||||||||
| }, | ||||||||
| }, | ||||||||
| }); | ||||||||
| } | ||||||||
|
|
||||||||
| function logOnFidoEvent(event: OnfidoEvent) { | ||||||||
| Log.hmmm('Receiving Onfido analytic event', event.detail); | ||||||||
| } | ||||||||
|
|
||||||||
| function Onfido({sdkToken, onSuccess, onError, onUserExit}: OnfidoProps, ref: ForwardedRef<OnfidoElement>) { | ||||||||
| const {preferredLocale, translate} = useLocalize(); | ||||||||
| const theme = useTheme(); | ||||||||
|
|
||||||||
| useEffect(() => { | ||||||||
| initializeOnfido({ | ||||||||
| sdkToken, | ||||||||
| onSuccess, | ||||||||
| onError, | ||||||||
| onUserExit, | ||||||||
| preferredLocale, | ||||||||
| translate, | ||||||||
| theme, | ||||||||
|
|
@@ -140,8 +149,8 @@ const Onfido = forwardRef((props, ref) => { | |||||||
| ref={ref} | ||||||||
| /> | ||||||||
| ); | ||||||||
| } | ||||||||
|
|
||||||||
| Onfido.displayName = 'Onfido'; | ||||||||
|
|
||||||||
| export default forwardRef(Onfido); | ||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import type {OnfidoResult} from '@onfido/react-native-sdk'; | ||
| import type {Handle} from 'onfido-sdk-ui/types/Onfido'; | ||
| import type {CompleteData} from 'onfido-sdk-ui/types/Types'; | ||
| import type {OnyxEntry} from 'react-native-onyx'; | ||
|
|
||
| type OnfidoData = CompleteData | OnfidoResult; | ||
|
|
||
| type OnfidoDataWithApplicantID = OnfidoData & { | ||
| applicantID: OnyxEntry<string>; | ||
| }; | ||
|
|
||
| type OnfidoElement = HTMLDivElement & {onfidoOut?: Handle}; | ||
|
|
||
| type OnfidoProps = { | ||
| /** Token used to initialize the Onfido SDK */ | ||
| sdkToken: string; | ||
|
|
||
| /** Called when the user intentionally exits the flow without completing it */ | ||
| onUserExit: () => void; | ||
|
|
||
| /** Called when the user is totally done with Onfido */ | ||
| onSuccess: (data: OnfidoData) => void; | ||
|
|
||
| /** Called when Onfido throws an error */ | ||
| onError: (error?: string) => void; | ||
| }; | ||
|
|
||
| export type {OnfidoProps, OnfidoElement, OnfidoData, OnfidoDataWithApplicantID}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This param wasn't found by TS, I haven't found it in lib/docs as well.
Onfido SDK source code is not is not publicly available to check this param there, but I can see the last version this params was mentioned in Onfido docs is 10.1.0, after that it wasn't there anymore.