Skip to content

Commit

Permalink
Update for release 13.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 27, 2023
1 parent c5ca4c7 commit 4f639fc
Show file tree
Hide file tree
Showing 48 changed files with 40,453 additions and 111 deletions.
8 changes: 8 additions & 0 deletions BASE_32_VERSION_MAPPING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,11 @@
| FK | 12.4.0-rc.3 | 2023-06-15 | |
| FL | 12.3.6 | 2023-06-16 | |
| FM | 13.0.0 | 2023-06-29 | |
| FN | 13.0.1 | 2023-07-11 | |
| FO | 12.4.1 | 2023-07-14 | |
| FP | 13.1.0 | 2023-07-20 | |
| FQ | 13.2.0 | 2023-08-03 | |
| FR | 13.3.0 | 2023-08-09 | |
| FS | 13.3.1 | 2023-08-22 | |
| FT | 13.3.2 | 2023-09-18 | |
| FU | 13.4.0 | 2023-09-22 | |
92 changes: 89 additions & 3 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,93 @@ This project adheres to the Node [default version scheme](https://docs.npmjs.com

### Changed

## [13.4.0] - 2023-09-27

### Changed

- Add new `colorBackgroundDropdownItemHover` and `colorBackgroundDropdownItemActive` UI customization option for the country selector.
- Add ODP error handling (https://documentation.onfido.com/#original-document-present-reasons)
- New document capture experience change: Stop rendering the fallback message after two blurry document upload tries.
- Three changes in the Javascript "New document capture experience": One, increase timeout to see the fallback error message from 40s to 80s. Two, don't show the fallback error message when uploadFallback is disabled. Three, keep the button available even when the uploadFallback error message is shown.
- Support customUI on self-hosted crossdevice instances

### Fixed

- Prevent the windows touch machines from using the JS camera. In some cases, the Windows Touch machines were allowed to behave as mobile devices. It's not the case anymore.
- Fix the resolution of the new document capture experience (JS Camera) for iOS devices. It was 1443 px instead of 1440 px.

## [13.3.2] - 2023-09-18

### Changed

### Fixed

- Fix workflow double document steps and blank screen after face capture

## [13.3.1] - 2023-08-22

### Changed

- Prevent Windows Touch machines from using the JS camera. In some cases, Windows Touch machines were allowed to behave as mobile devices. This is no longer the case.

## [13.3.0] - 2023-08-16

### Changed

- Fix loading modules when the first module is skippable (studio).
- Add a general tips section in the README.md
- Change the welcome screen wording to comply with video recording regulations.

## [13.2.0] - 2023-08-08

### Changed

### Fixed

- Custom cross device URLs can now contain a path between the host and the hash. Ex: `https://host:port/some/path/HASH`
- Color contrast in button and remove icons preload

## [13.1.0] - 2023-07-20

### Changed

- Update `resend SMS` copy for better user experience.
- Add Accessibility translations for Motion.
- Add support for Romanian national identity number in profile capture

### Fixed

- Fix `issuing_country` on `cross-device` for `passport` not added to payload.

## [13.0.1] - 2023-07-11

### Changed

- Add play pause button to motion intro animation video.

### Fixed

- Fix duplicate Motion capture uploads on SDK initialisations without a `complete` step.
- Fix Motion capture recording starting too early.

## [13.0.0] - 2023-07-11

### Changed

- Remove `uploadFallback` option in the `document` step.
- Add a new error when barcode detection issues arise.
- Remove `uploadFallback` option in the `face` step.
- Add a new error when barcode detection issues arise.

### Fixed

- Fix workflow multi document taks step configuration.

## [12.4.1] - 2023-07-14

### Fixed

- Fix close button on document preview

## [12.4.0] - 2023-06-19

### Changed
Expand Down Expand Up @@ -1539,8 +1617,16 @@ Install with `npm install [email protected]`

- NPM (commonjs2) style of importing the library now works

[next-version]: https://github.com/onfido/onfido-sdk-ui/compare/13.0.0...development
[13.0.0]: https://github.com/onfido/onfido-sdk-ui/compare/12.4.0...13.0.0
[next-version]: https://github.com/onfido/onfido-sdk-ui/compare/13.4.0...development
[13.4.0]: https://github.com/onfido/onfido-sdk-ui/compare/13.3.2...13.4.0
[13.3.2]: https://github.com/onfido/onfido-sdk-ui/compare/13.3.1...13.3.2
[13.3.1]: https://github.com/onfido/onfido-sdk-ui/compare/13.3.0...13.3.1
[13.3.0]: https://github.com/onfido/onfido-sdk-ui/compare/13.2.0...13.3.0
[13.2.0]: https://github.com/onfido/onfido-sdk-ui/compare/13.1.0...13.2.0
[13.1.0]: https://github.com/onfido/onfido-sdk-ui/compare/13.0.1...13.1.0
[13.0.1]: https://github.com/onfido/onfido-sdk-ui/compare/13.0.0...13.0.1
[13.0.0]: https://github.com/onfido/onfido-sdk-ui/compare/12.4.1...13.0.0
[12.4.1]: https://github.com/onfido/onfido-sdk-ui/compare/12.4.0...12.4.1
[12.4.0]: https://github.com/onfido/onfido-sdk-ui/compare/12.3.6...12.4.0
[12.3.6]: https://github.com/onfido/onfido-sdk-ui/compare/12.3.5...12.3.6
[12.3.5]: https://github.com/onfido/onfido-sdk-ui/compare/12.3.4...12.3.5
Expand Down
3 changes: 3 additions & 0 deletions MIGRATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,9 @@ For all supported language the copy for the following string(s) has been added:
- `profile_data::national_id_number_title`
- `cross_device::button_primary_upload`
- `cross_device_intro::subtitle_upload`
- `profile_data::field_validation::rou_specific::invalid_national_id_value`
- `profile_data::field_validation::rou_specific::required_national_id_value`
- `profile_data::field_labels::rou_specific::national_id_value`

## `11.0.0`

Expand Down
37 changes: 27 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
## Table of contents

- [Overview](#overview)
- [General tips](#general-tips)
- [Getting started](#getting-started)
- [Handling callbacks](#handling-callbacks)
- [Removing the SDK](#removing-the-sdk)
Expand Down Expand Up @@ -34,6 +35,10 @@ The SDK offers a number of benefits to help you create the best identity verific

![Various views from the SDK](demo/screenshots.jpg)

## General tips

For use in a mobile device, it is recommended to set up the SDK to use the full screen of the device. Otherwise, there may not be enough room to display all critical elements of the SDK.

## Getting started

The following content assumes you're using our API v3 versions for backend calls. If you are currently using API `v2` please refer to [this migration guide](https://developers.onfido.com/guide/api-v2-to-v3-migration-guide) for more information.
Expand Down Expand Up @@ -89,7 +94,7 @@ $ curl https://api.onfido.com/v3/sdk_token \
| Parameter | Notes |
| -------------- | ---------------------------------------------------------------- |
| `applicant_id` | **required** <br /> Specifies the applicant for the SDK instance |
| `referrer` | **required** <br /> The referrer URL pattern |
| `referrer` | **optional** <br /> The referrer URL pattern |

⚠️ Note: SDK tokens expire after 90 minutes.

Expand Down Expand Up @@ -136,7 +141,7 @@ From SDK 12.3.1 onwards, the version number you subscribe to can vary, depending

```html
<!-- Replace "<version>" with the actual SDK version you want to use, example: v12 -->
<script src="https://sdk.onfido.com/<version>"></script>
<script src="https://sdk.onfido.com/<version>" charset="utf-8"></script>
<link href="https://sdk.onfido.com/<version>/style.css" rel="stylesheet" />
```

Expand All @@ -147,7 +152,7 @@ For versions prior to 12.3.1, specifying a precise release only, see our previou
You can include the library as a regular script tag on your page:

```html
<script src="dist/onfido.min.js"></script>
<script src="dist/onfido.min.js" charset="utf-8"></script>
```

And the CSS styles:
Expand Down Expand Up @@ -189,6 +194,8 @@ import { init } from 'onfido-sdk-ui/split'
import 'onfido-sdk-ui/split/css'
```

If you are using TypeScript, you have to enable `moduleResolution` to `Node16 | NodeNext | Bundler`. If it is not possible in your case, you need to add a `@ts-ignore` comment above the import.

⚠️ Note: The main bundle will be in included in your build, but the other bundles will be loaded from Onfido's CDN.

### 5. Add basic HTML markup
Expand Down Expand Up @@ -649,11 +656,19 @@ The user is offered a QR code to scan with their camera app, which then resumes
When a user switches to the SDK's cross-device flow, they will see an [introductory screen](https://developers.onfido.com/guide/sdk-customization#cross-device---mobile-client-introductory-screen) when the SDK client loads on their mobile browser. At the end of the capture process, users will be redirected back to their desktop to complete the SDK flow.

It is recommended to enforce the cross-device flow. The option is available in Onfido Studio, configurable in the [workflow builder](https://developers.onfido.com/guide/onfido-studio-product#document-capture-task), and in the Classic integration, configured as follows:
It is recommended to enforce the cross-device flow. The option is available in Onfido Studio, configurable in the [workflow builder](https://developers.onfido.com/guide/onfido-studio-product#document-capture-task).

- When configured, forceCrossDevice makes the cross-device flow mandatory for all users who will be required to complete the capture process on a mobile device browser
- The forceCrossDevice functionality can be configured for both the Document capture and Proof of Address verification steps
- forceCrossDevice cannot be configured for Face captures
In a Classic integration, the cross-device flow is configured by setting `forceCrossDevice` to true:

```javascript
options: {
forceCrossDevice: true
}
```

- When configured, `forceCrossDevice` makes the cross-device flow mandatory for all users who will be required to complete the capture process on a mobile device browser
- The `forceCrossDevice` functionality can be configured for both the Document capture and Proof of Address verification steps
- `forceCrossDevice` cannot be configured for Face captures

![Force cross-device flow](demo/cross-device.png)

Expand Down Expand Up @@ -972,9 +987,7 @@ From version `6.5.0`, TypeScript is officially supported, providing typings for:
| ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png) |
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| Latest ✔ | Latest \* ✔ | Latest ✔ | Latest ✔ |
\* _Firefox on Android, iOS not supported_
| Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
### Node.js compatibility
Expand Down Expand Up @@ -1024,6 +1037,10 @@ If embedded inside a cross-origin iframe, the SDK may fail to access the camera
<iframe src="..." allow="camera;microphone"></iframe>
```
#### Upload fallback
Onfido Web SDK versions <13.0.0 have a parameter named `uploadFallback` that can be set on both the document step and the face step. This parameter allowed clients to present end-users with a file input capability during the SDK flow. This client-side optional parameter has been removed in Web SDK 13 and above to enhance security which means users will not have the option to upload files during the SDK flow. However, file upload can be enabled as an option for end-users as a backend configuration if requested through the Onfido Support Team.
### Support
Please open an issue through [GitHub](https://github.com/onfido/onfido-sdk-ui/issues). Please be as detailed as you can. Remember **not** to submit your token in the issue. Also check the closed issues to check whether it has been previously raised and answered.
Expand Down
Loading

0 comments on commit 4f639fc

Please sign in to comment.