Skip to content

Commit

Permalink
Release 14.35.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 3, 2024
1 parent 79a0ba8 commit 4d365ec
Show file tree
Hide file tree
Showing 48 changed files with 768 additions and 106 deletions.
54 changes: 43 additions & 11 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,70 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/)
and this project adheres to [Semantic Versioning](https://semver.org/).

## 14.35.0 - 2024-09-03
### Added
- Proof of Address Module: replaced basic camera with js camera

### Fixed
- Ensure the motion instruction video is dismissed on the head-turn side complete
- accessibility screen reader and keyboard navigations
- Assistive technologies now reads intructions in center of capture frame.

## 14.34.0 - 2024-08-15
### Added
- Preselect country in documents list following the value of custom input `preferred_user_country` (currently only works with Onfido Studio)

### Changed
- Updated CSP - Added data: to media-src
- Fixed accessibility and usability issues with the document list
- Optional task completion task when using Studio token
- Removed inactivity error message and continue to display shutter button

### Fixed
- Extended SSN scope to include US territories: American Samoa, Guam, Northern Marian Islands, United States Virgin Islands and Puerto Rico
- The redo button displayed after an error when uploading a document is now a primary button

## 14.33.0 - 2024-07-31
### Changed
- Updated CSP - Added data: to media-src
- Updated CSP - Added data: to media-src

### Fixed
- Ensure screen readers don't read headings twice
- Resolved an issue causing infinite loading when pressing the back button on the video preview screen

## 14.32.0 - 2024-07-24
### Changed
- Updated CSP - Added data: to media-src
- Updated CSP - Added data: to media-src

### Fixed
- Fixed video preview on iOS
- Replaced the `faceVideo` intro icons with bullet points aligned with Motion
- Improved accessibility of the country selector label
- Various accessibility fixes

## 14.31.0 - 2024-07-17
### Fixed
- Check audio permission for `faceMotion` when `recordAudio` is enabled
- Fixed UPLOAD user analytics event
- Removed whitespaces at end of string inputs for profile data

## 14.30.0 - 2024-07-04
### Fixed
- Fixed UPLOAD user analytics event
- Removed whitespaces at end of string inputs for profile data

## 14.29.0 - 2024-06-25
No changes.
### Fixed
- Various bug fixes and accessibility updates

## 14.28.0 - 2024-06-20
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## 14.28.0 - 2024-06-13
No changes.
### Fixed
- Various bug fixes and accessibility updates

## 14.27.1 - 2024-06-05
No changes.
### Added
- Added an error warning if no international code is included in the phone number field for one-time password link
- International code is now included in the phone number field for one-time password link

## 14.27.0 - 2024-05-30
### Changed
Expand Down
12 changes: 6 additions & 6 deletions MIGRATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,21 @@ This documents the breaking changes between the Web SDK v13.7.0 and the Web SDK
- The "Capture Guide" screen has moved earlier in the document capture flow
- The "Completion" screens at the end of the cross-device flow have been streamlined and no longer show differences between the document and face capture steps
- Cross-device flow change: the user is now prevented from going cross-device after the first side (front) has already been captured. The full capture flow has to be either on the desktop or on the mobile device
- The `crossDeviceClientIntroProductName` subtitle customization option has been deprecated. Please use the standard language customization process to override the entire subtitle
- The `crossDeviceClientIntroProductName` subtitle customization option has been removed. Please use the standard language customization process to override the entire subtitle
- Merger of options `_crossDeviceLinkMethods: ['qr_code' | 'copy_link' | 'sms']` and `_initialCrossDeviceLinkView` into `_initialCrossDeviceLinkView: ['qr_code', 'copy_link', 'sms']` where the default cross-device option is the first element in the list. Note the change in separators from `|` to `,`

## `Onfido.init()` parameters

- `onUserExit` has been deprecated and the `user_consent_denied` type is now returned in the `onError` callback
- Ability for the Web SDK to self-load in a modal has been deprecated:
- `onUserExit` has been removed and the `user_consent_denied` type is now returned in the `onError` callback
- Ability for the Web SDK to self-load in a modal has been removed:
- `onModalRequestClose`
- `useModal`
- `isModalOpen`
- `shouldCloseOnOverlayClick`
- `autoFocusOnInitialScreenTitle`
- Removal of `uploadFallback` option for the `document` and `face` steps. This feature is now only configurable in the Onfido systems.
- `useMemoryHistory` has been deprecated
- `handle.setOptions()` has been deprecated, no longer allowing changing options after bootstrapping the SDK
- `useMemoryHistory` has been removed
- `handle.setOptions()` has been removed, no longer allowing changing options after bootstrapping the SDK
- The fallback options under the `face` step now only occur on the mobile session of a user as all fallbacks due to device capabilities will always trigger a cross-device flow first.
- `tearDown` now returns a Promise
- `safeTearDown` has been deprecated, please use `tearDown` instead
- `safeTearDown` has been removed, please use `tearDown` instead
88 changes: 44 additions & 44 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,16 @@ More details are provided in the [SDK version pinning](#version-pinning) section

Since version `6.5.0`, TypeScript is officially supported.

**Note**: In previous versions of the SDK (v13 and earlier), additional types, such as for the `init()` function were exposed. They will be gradually re-introduced in upcoming releases.
Available types:

- `OnfidoApi` - The base type for the `Onfido` object
- `SdkParameters` - The parameters passed into `Onfido.init()`

## Initializing the SDK

> ⚠️ The following SDK initialization documentation applies to identity verification workflows orchestrated using Onfido Studio.
> For integrations where the verification steps are manually defined and configured, please refer to the [Advanced flow customization](#advanced-flow-customization) section below.
The Web SDK has multiple initialization and customization options that provide flexibility to your integration, while remaining easy to integrate.

**Note** that from version 14, it will no longer be possible to change initialization options at runtime as was previously allowed with the `setOption()` function.
Expand Down Expand Up @@ -336,7 +342,7 @@ Defining a default language and applying custom translations or text is done wit

- **`language {String}` - optional**

You can specify the language displayed during the SDK session. The `string` identifier can either be one of Onfido's supported languages (full list available in the [SDK customization guide](https://documentation.onfido.com/sdk/sdk-customization/#supported-languages)) or your own custom language identifier as described in the [Using custom language files](#using-custom-language-files) section below.
You can specify the language displayed during the SDK session. The `string` identifier can either be one of Onfido's supported languages (full list available in the [SDK customization guide](https://documentation.onfido.com/sdk/sdk-customization/#supported-languages)) or your own custom language identifier as described in the [Using custom language files](#using-custom-language-files) section below.

```javascript
Onfido.init({
Expand All @@ -347,12 +353,12 @@ Onfido.init({

<Callout type="info">

If the `language` property is not present, the language identifier is incorrect or not yet supported by Onfido, the SDK will use the browser's language setting. <br/>
If the browser's language is not supported by Onfido, the SDK will default to English (`en_US`).
If the `language` property is not present, the language identifier is incorrect or not yet supported by Onfido, the SDK will use the browser's language setting. <br/>
If the browser's language is not supported by Onfido, the SDK will default to English (`en_US`).

</Callout>

**Note**: In the context of cross-device and OTP, the language of the SMS body is also controlled by this identifier.
**Note**: In the context of cross-device and OTP, the language of the SMS body is also controlled by this identifier.

#### Custom translations and text

Expand All @@ -369,12 +375,12 @@ Onfido.init({
en_US: {
welcome: {
title: 'This custom title will appear by default for en_US'
}
}
},
es: {
es: {
welcome: {
title: 'Este título personalizado aparecerá por defecto para es'.
}
}
}
}
})
Expand All @@ -384,25 +390,25 @@ Onfido.init({

The full list of keys that can be customized in the Onfido Web SDK is available on the Onfido CDN and is split by module and language.

| File URL | Description |
| -------- | ----------- |
| https://sdk.onfido.com/capture/i18n/common/en_US.json | Flow level keys, country names, document types and other keys shared across modules |
| https://sdk.onfido.com/capture/i18n/welcome/en_US.json | Welcome screen |
| https://sdk.onfido.com/capture/i18n/complete/en_US.json | "Thank you" screen |
| https://sdk.onfido.com/capture/i18n/consent/en_US.json | Consent screen |
| https://sdk.onfido.com/capture/i18n/error/en_US.json | General error screens |
| https://sdk.onfido.com/capture/i18n/retry/en_US.json | Retry screen |
| https://sdk.onfido.com/capture/i18n/crossdevice/en_US.json | Cross-device screens for both desktop and mobile sessions |
| https://sdk.onfido.com/capture/i18n/document/en_US.json | Document Capture screens |
| https://sdk.onfido.com/capture/i18n/proofOfAddress/en_US.json | Proof of Address screens |
| https://sdk.onfido.com/capture/i18n/face/en_US.json | Face Capture - Selfie screens |
| https://sdk.onfido.com/capture/i18n/faceVideo/en_US.json | Face Capture - Video screens |
| https://sdk.onfido.com/capture/i18n/motion/en_US.json | Face Capture - Motion screens |
| https://sdk.onfido.com/capture/i18n/profileData/en_US.json | Profile Data screens |
| https://sdk.onfido.com/capture/i18n/electronicId/en_US.json | Electronic ID verification screens |
| https://sdk.onfido.com/capture/i18n/ial2/en_US.json | IAL2 screens |
| https://sdk.onfido.com/capture/i18n/qualifiedElectronicSignature/en_US.json | Qualified Electronic Signature (QES) screens |
| https://sdk.onfido.com/capture/i18n/oneTimePassword/en_US.json | One-Time-Password (OTP) screens |
| File URL | Description |
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| https://sdk.onfido.com/capture/i18n/common/en_US.json | Flow level keys, country names, document types and other keys shared across modules |
| https://sdk.onfido.com/capture/i18n/welcome/en_US.json | Welcome screen |
| https://sdk.onfido.com/capture/i18n/complete/en_US.json | "Thank you" screen |
| https://sdk.onfido.com/capture/i18n/consent/en_US.json | Consent screen |
| https://sdk.onfido.com/capture/i18n/error/en_US.json | General error screens |
| https://sdk.onfido.com/capture/i18n/retry/en_US.json | Retry screen |
| https://sdk.onfido.com/capture/i18n/crossdevice/en_US.json | Cross-device screens for both desktop and mobile sessions |
| https://sdk.onfido.com/capture/i18n/document/en_US.json | Document Capture screens |
| https://sdk.onfido.com/capture/i18n/proofOfAddress/en_US.json | Proof of Address screens |
| https://sdk.onfido.com/capture/i18n/face/en_US.json | Face Capture - Selfie screens |
| https://sdk.onfido.com/capture/i18n/faceVideo/en_US.json | Face Capture - Video screens |
| https://sdk.onfido.com/capture/i18n/motion/en_US.json | Face Capture - Motion screens |
| https://sdk.onfido.com/capture/i18n/profileData/en_US.json | Profile Data screens |
| https://sdk.onfido.com/capture/i18n/electronicId/en_US.json | Electronic ID verification screens |
| https://sdk.onfido.com/capture/i18n/ial2/en_US.json | IAL2 screens |
| https://sdk.onfido.com/capture/i18n/qualifiedElectronicSignature/en_US.json | Qualified Electronic Signature (QES) screens |
| https://sdk.onfido.com/capture/i18n/oneTimePassword/en_US.json | One-Time-Password (OTP) screens |

**Note** that the same keys are available across all supported languages and are accessible by specifying the appropriate language name in the URL (`en_US.json` in the example above).

Expand All @@ -418,6 +424,7 @@ It is also possible to identify text that can be customized by using a browser i

The Onfido Web SDK allows the use of custom languages alongside all officially supported languages.
This functionality is achieved by:

- defining a unique `language` identifier
- using the unique `language` identifier within the `translations` object, mapping any required strings to the existing language file structure

Expand All @@ -430,15 +437,14 @@ Onfido.init({
MY_CUSTOM_LANG: {
welcome: {
title: 'This custom title will appear by default'
}
}
}
}
})
```

**Note**: Custom languages, similarly to standard text overrides, work as 'delta' to the base language file they relate to. In the case of custom languages, that base language is `en_US`.


### Cross-device navigation

The Web SDK offers a cross-device flow where desktop users are directed to continue on their mobile device browser to complete the capture process. This provides a vastly improved image quality versus a typical desktop webcam and increases the likelihood of successful live capture.
Expand All @@ -460,13 +466,15 @@ At the end of the capture process, users will be instructed to revert back to th
**Also note** that One-Time SMS links **cannot** be sent to the following regions and the messages will not be delivered:

**North America**

- Belize
- Cuba
- Grenada
- Haiti
- St Kitts and Nevis

**Asia**

- Afghanistan
- Azerbaijan
- Bangladesh
Expand All @@ -487,8 +495,9 @@ At the end of the capture process, users will be instructed to revert back to th
- Tajikistan
- Turkmenistan
- Yemen

**Africa**

- Burkina Faso
- Burundi
- Cape Verde
Expand Down Expand Up @@ -612,7 +621,7 @@ After `onComplete` has fired in the context of a workflow, information about the

<Callout type="warn">

While the existing implementation of `onComplete` also returns *partial* information after a workflow has been executed, this behaviour will be removed in the next major version of the web SDK.
While the existing implementation of `onComplete` also returns _partial_ information after a workflow has been executed, this behaviour will be removed in the next major version of the web SDK.

</Callout>

Expand Down Expand Up @@ -832,8 +841,8 @@ From the possible steps listed below, only `document` is required:
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `welcome` | Welcome screen shown to the user with preliminary instructions. [Customization](#welcome-step) options include modification to the text elements and instructions shown to the user. |
| `document` | Set of screens that control the capture via photo or upload of the user's document. Numerous [customization](#document-step) options are available to define the document list presented to the user and the overall capture experience. |
| `face` | Set of screens that control the capture of a selfie, video or motion of the user. The [customization](#face-step) options allow the selection of the capture variant as well as fallback options.
| `poa` | Set of screens where the user selects the issuing country and type of document to [verify their address](#poa-step). |
| `face` | Set of screens that control the capture of a selfie, video or motion of the user. The [customization](#face-step) options allow the selection of the capture variant as well as fallback options. |
| `poa` | Set of screens where the user selects the issuing country and type of document to [verify their address](#poa-step). |
| `complete` | Screen shown to the user at the end of the flow. [Customization](#complete-step) options include modifications to the text elements shown to the user. |

```javascript
Expand Down Expand Up @@ -983,6 +992,7 @@ In case you require to capture a document that is not supported by Onfido or a s
}
}
```

#### `poa` step

This is the Proof of Address capture step. Users will be asked to select the issuing country of their document, the document type, and to provide images of their selected document. They will also have a chance to check the quality of the images before confirming. There are no custom options for this step.
Expand Down Expand Up @@ -1459,18 +1469,8 @@ To do so, please contact your Onfido Solution Engineer or Customer Success Manag
### User analytics callbacks
<Callout>
> The following features must be enabled for your account before they can be used. For more information, please contact your Onfido Solution Engineer or Customer Success Manager.
</Callout>
The SDK allows you to track a user's journey through the verification process via a dispatched event. This gives insight into how your users make use of the SDK screens.

#### Overriding the hook

In order to track a user's progress through the SDK an `EventListener` must be added that listens for `UserAnalyticsEvent` events. This can be done anywhere within your application.
In order to track a user's progress through the SDK an `EventListener` must be added that listens for `userAnalyticsEvent` events. This can be done anywhere within your application.
The code inside of the `EventListener` callback will be invoked when an event is triggered.
```javascript
Expand Down
Loading

0 comments on commit 4d365ec

Please sign in to comment.