@notabene/javascript-sdk 2.5.1 → 2.5.2

package/README.md

@@ -64,6 +64,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
       - [Field reference](#field-reference)
   - [Locales](#locales)
   - [License](#license)
+  - [Theming](#theming)
 
 ## Installation
 
@@ -198,6 +199,14 @@ To be notified of any validation errors use:
 withdrawal.on('error',error => ...)
 ```
 
+To be notified when the component is Ready:
+
+```js
+withdrawal.on('ready', ({ type }) => {
+  console.log(type === 'ready');
+});
+```
+
 Calling `on` returns a function that will allow you to cleanly unsubscribe.
 
 ```js
@@ -423,9 +432,43 @@ If any of the required parameters are missing the component will just show the N
 If any error occurs, the `error` event is passed containing a message.
 
 ```ts
-withdrawal.on('error', {message} => ...)
+withdrawal.on('error', (error) => ...)
+```
+
+An example error object.
+
+```ts
+type Error = {
+  type: CMType.Error;
+  message: string;
+  description: string;
+  identifier: ErrorIdentifierCode;
+};
+```
+Errors can be handled in this way:
+
+```ts
+component.on('error', (error) => {
+  if (error.type === CMType.Error) {
+    switch (error.identifier) {
+      case ErrorIdentifierCode.SERVICE_UNAVAILABLE:
+        // handle the error
+        break;
+      //...
+    }
+  }
+});
 ```
 
+#### Error reference
+
+|                ErrorIdentifierCode          |                   Description/Message                                                          | In Use   |
+|--------------------------|----------------------------------------------------------------------------------------------------------|---|
+| SERVICE_UNAVAILABLE      | The Notabene service is currently unavailable                                                            | ✅  |
+| TOKEN_INVALID            | Auth Token is Invalid                                                                                    | ✅  |
+| WALLET_CONNECTION_FAILED | The connection to the wallet service failed, possibly due to network issues or unsupported wallet types. | ✅  |
+| WALLET_NOT_SUPPORTED     | The wallet used does not support the required functionality or blockchain.                               |   |
+
 ## Transaction parameters
 
 ### Asset specification
@@ -493,7 +536,7 @@ const options: TransactionOptions = {
       amountSubunits: '12344',
       timeout: 86440,
     },
-    fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self_declaration']
+    fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self-declaration']
     deminimis: {
       threshold: 1000,
       currency: 'EUR',
@@ -729,6 +772,23 @@ const options: TransactionOptions = {
 
 See [locales](src/locales.ts) for the list of supported locales.
 
+## Theming
+
+You can optionally theme the UI when creating an instance of `Notabene`
+
+```js
+const notabene = new Notabene({
+  nodeUrl: 'https://api.notabene.id',
+  authToken: 'YOUR_CUSTOMER_TOKEN',
+  theme: {
+    mode: 'light', // 'light', 'dark'
+    primaryColor: '#0a852d',
+    secondaryColor: '#f5f7fa',
+    fontFamily: 'Montserrat' // Google Fonts Supported
+  }
+});
+```
+
 ## [License](LICENSE.md)
 
 MIT © Notabene Inc.

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "source": "src/notabene.ts",
   "main": "dist/notabene.js",
   "types": "dist/notabene.d.ts",