@airwallex/components-sdk - npm Package Compare versions

Comparing version 1.7.1 to 1.8.1

CHANGELOG.md

@@ -0,1 +1,16 @@
+## [1.8.1](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/compare/v1.8.0...v1.8.1) (2024-07-18)
+
+
+### Bug Fixes
+
+* namespace missing export after bundle ([c93d2bc](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/commit/c93d2bca6afdb7f3a1c579ebeb1f64490471a88a))
+
+# [1.8.0](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/compare/v1.7.1...v1.8.0) (2024-07-18)
+
+
+### Features
+
+* [osai-10139] update interface and docs and add sca functions ([00f2cda](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/commit/00f2cda0f36a9f742b4a054b0cb8b95a5687e367))
+* wrap all domain types with namespace ([6f496c6](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/commit/6f496c63794d37f3e5afa8d3ed196dd943036e03))
+
 ## [1.7.1](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/compare/v1.7.0...v1.7.1) (2024-06-28)
@@ -2,0 +17,0 @@

lib/index.js

@@ -91,3 +91,3 @@ 'use strict';
 var name = "@airwallex/components-sdk";
-var version = "1.6.0";
+var version = "1.7.1";
 var main = "./lib/index.js";
@@ -281,3 +281,3 @@ var module$1 = "./lib/index.mjs";
 };
-var DOMAIN_FUNCTIONS_NAMESPACES = ['payment'];
+var DOMAIN_FUNCTIONS_NAMESPACES = ['payment', 'sca'];
 
@@ -284,0 +284,0 @@ var sleep = function (delay) {

package.json

 {
   "name": "@airwallex/components-sdk",
-  "version": "1.7.1",
+  "version": "1.8.1",
   "main": "./lib/index.js",
@@ -5,0 +5,0 @@ "module": "./lib/index.mjs",

README.md

@@ -32,2 +32,9 @@ # Airwallex Components SDK
       - [`error`](#error-2)
+  - [SCA Elements Events](#sca-elements-events)
+      - [`ready`](#ready-3)
+      - [`scaSetupSucceed`](#scasetupsucceed)
+      - [`verificationSucceed`](#verificationsucceed)
+      - [`verificationFailed`](#verificationfailed)
+      - [`resetPasscodeSucceed`](#resetpasscodesucceed)
+      - [`error`](#error-3)
   - [Theming](#theming)
@@ -101,3 +108,8 @@ - [CHANGELOG](#changelog)
 |              | `theme`    | **No**    | -       | Theme Object | Contact your Account Manager for details. |
+| `scaSetup`,`scaVerify` | `userEmail`    | **Yes**    |  -        | `string` | Used to recovery 2fa method |
+| | `scaSessionCode`    | **No**    |    -      | `string` |  It must be provided when initialising the embedded scaVerify component for a one-time SCA token |
+| | `contactEmail`    | **No**    |    -      | `string` | Platfrom customer service email address |
+| | `theme`    | **No**    | -       | Theme Object | Contact your Account Manager for details. |
 
+
 #### Example
@@ -422,2 +434,110 @@
 
+## SCA Elements Events
+
+#### `ready`
+
+This event will be fired when: sca page is ready. 
+
+Type
+```ts
+element.on('ready', () => void);
+```
+
+Example
+
+```ts
+element.on('ready', () => {
+  // Handle ready event
+});
+```
+
+#### `scaSetupSucceed`
+
+This event will be fired when SCA has been successfully configured by users:
+
+Type
+
+```ts
+element.on('scaSetupSucceed', () => void);
+```
+Example
+
+```ts
+element.on('scaSetupSucceed', () => {
+  // Handle event
+});
+```
+
+#### `verificationSucceed`
+
+This event triggers when the SCA flow is authenticated successfully
+
+Type
+
+```ts
+element.on('verificationSucceed', ({token}: {token:string}) => void);
+```
+
+Example
+
+```ts
+element.on('verificationSucceed', ({token}: {token:string}) => {
+  // Handle success event
+});
+```
+
+#### `verificationFailed`
+
+This event triggers when the SCA flow authentication fails.
+
+Type
+
+```ts
+element.on('verificationFailed', ({reason}:{reason:string}) => void);
+```
+
+Example
+
+```ts
+element.on('verificationFailed', () => {
+  // Handle event
+});
+```
+
+#### `resetPasscodeSucceed`
+
+This event triggers when the user successfully resets their passcode
+
+Type
+
+```ts
+element.on('resetPasscodeSucceed', () => void);
+```
+
+Example
+
+```ts
+element.on('resetPasscodeSucceed', () => {
+  // Handle event
+});
+```
+#### `error`
+
+This event fires when an error occurs within the element.
+
+Type
+
+```ts
+
+element.on('error', (data: { code: string, message?: string }) => void);
+```
+
+Example
+
+```ts
+element.on('error', (data: { code: string, message?: string }) => {
+  // Handle error event
+});
+```
+
 ## Theming
@@ -430,2 +550,17 @@
 
+## [1.8.1](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/compare/v1.8.0...v1.8.1) (2024-07-18)
+
+
+### Bug Fixes
+
+* namespace missing export after bundle ([c93d2bc](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/commit/c93d2bca6afdb7f3a1c579ebeb1f64490471a88a))
+
+# [1.8.0](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/compare/v1.7.1...v1.8.0) (2024-07-18)
+
+
+### Features
+
+* [osai-10139] update interface and docs and add sca functions ([00f2cda](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/commit/00f2cda0f36a9f742b4a054b0cb8b95a5687e367))
+* wrap all domain types with namespace ([6f496c6](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/commit/6f496c63794d37f3e5afa8d3ed196dd943036e03))
+
 ## [1.7.1](https://gitlab.awx.im/airwallex-dev-scale/components-sdk/compare/v1.7.0...v1.7.1) (2024-06-28)
@@ -432,0 +567,0 @@

No alert changes

Improved metrics

Total package byte prevSize

674396

increased by4.48%

Lines of code

15986

increased by2.19%

Number of lines in readme file

636

increased by26.95%

No dependency changes