Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
okra-js - npm Package Compare versions
Comparing version 2.0.9 to 2.1.0
| { | ||
| "name": "okra-js", | ||
| "version": "2.0.9", | ||
| "version": "2.1.0", | ||
| "description": "JS library for implementing Okra widget", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
| # Okra Widget JavaScript SDK | ||
|  | ||
|  | ||
@@ -7,7 +7,7 @@ JS library for implementing the OkraJS widget - OkraJS is a safe and secure web drop-in module and this library provides a front-end web (also available in [iOS](https://github.com/okraHQ/okra-ios-sdk) and [Android](https://github.com/okraHQ/okra-android-sdk)) SDK for [account authentication](https://docs.okra.ng/docs/widget-properties) and [payment initiation](https://docs.okra.ng/docs/creating-a-charge) for each bank that Okra [supports](https://docs.okra.ng/docs/bank-coverage). | ||
| ## Try the demo | ||
| Checkout the [widget flow](https://okra.ng/) to view how the Okra Widget works. *Click "See How it Works"* | ||
| Checkout the [widget flow](https://docs.okra.ng/docs/widget-flow/) to view how the Okra Widget works. *Click "See How it Works"* | ||
| ## Before getting started | ||
| - Checkout our [get started guide](https://docs.okra.ng/docs/get-started-with-okra) to create your developer account and retrieve your Client Token, API Keys, and Private Keys. | ||
| - Create a [sandbox customer](https://docs.okra.ng/docs/creating-sandbox-customers), so you can get connecting immediately. | ||
| - Checkout our [get started guide](https://docs.okra.ng/docs/onboarding-guide) to create your developer account and retrieve your Client Token, API Keys, and Private Keys. | ||
| - Create a [sandbox customer](https://docs.okra.ng/docs/using-sandbox), so you can get connecting immediately. | ||
@@ -51,3 +51,3 @@ ## buildWithShortURL | ||
| env: 'production-sandbox', | ||
| app_id: ''// app_id from your App builder | ||
| app_id: '',// app_id from your App builder | ||
| key: '', // Your key from the Okra dashboard | ||
@@ -75,35 +75,34 @@ token: '', // Your token from the okra dashboard | ||
| }) | ||
| ``` | ||
| ## Okra.buildWithOptions Options | ||
| |Name | Type | Required | Default Value | Description | | ||
| |-----------------------|----------------|---------------------|---------------------|---------------------| | ||
| | `app_id ` | `String` | true | | Your app id from your Okra Dashboard. | ||
| | `key ` | `String` | true | | Your public key from your Okra Dashboard. | ||
| | `token ` | `String` | true | | Your token from your Okra Dashboard. | ||
| | `env ` | `String` | false |`production` | production(live)/production-sandbox (test) | ||
| | `products` | `Array` | true | `['Auth']` | The Okra products you want to use with the widget. | ||
| | `payment` | `Booelan` | false | | Whether you want to initiate a payment (https://docs.okra.ng/docs/payments) | ||
| | `charge ` | `Object` | false | | Payment charge opject (https://docs.okra.ng/docs/creating-a-charge) | ||
| | `products` | `Array` | true | `['Auth']` | The Okra products you want to use with the widget. | ||
| | `logo ` | `String(URL)` | false | Okra's Logo | | ||
| | `name ` | `String` | false | Your Company's name | Name on the widget | ||
| | `color` | `HEX ` | false | #3AB795 | Theme on the widget | ||
| | `limit` | `Number` | false | 24 | Statement length | ||
| | `filter` | `Object` | false | | Filter for widget | ||
| | `selection_type` | `String` | false | `multiple` | To select all accounts, some or none | ||
| | `account_type` | `String` | false | `both` | To display all account, individual or corporate | ||
| | `connectMessage` | `String` | false | | Instruction to connnect account | ||
| | `widget_success` | `String` | false | | Widget Success Message | ||
| | `widget_failed` | `String` | false | | Widget Failed Message | ||
| | `callback_url` | `String(Url)` | false | | | ||
| | `currency` | `String` | false | NGN | Wallet to bill | ||
| | `exp` | `Date` | false | Won't expire | Expirary date of widget | ||
| | `options` | `Object` | false | | You can pass a object custom values eg id | ||
| | `onSuccess` | `Function` | false | | Action to perform after widget is successful | ||
| | `onClose` | `Function` | false | | Action to perform if widget is closed | ||
| | `onError` | `Function` | false | | Action to perform on widget Error | ||
| | `BeforeClose` | `Function` | false | | Action to perform before widget close | ||
| | Name | Type | Required | Default Value | Description | | ||
| |------------------|---------------|----------|---------------------|-------------------------------------------------------------------------------------| | ||
| | `app_id ` | `String` | true | | Your app id from your Okra Dashboard. | | ||
| | `okraKey ` | `String` | true | | Your public key from your Okra Dashboard. | | ||
| | `token ` | `String` | true | | Your token from your Okra Dashboard. | | ||
| | `env ` | `String` | false | `production` | production(live)/production-sandbox (test) | | ||
| | `products` | `Array` | true | `['Auth']` | The Okra products you want to use with the widget. | | ||
| | `payment` | `Booelan` | false | | Whether you want to initiate a payment (https://docs.okra.ng/docs/payments) | | ||
| | `charge ` | `Object` | false | | Payment charge opject (https://docs.okra.ng/docs/widget-properties#set-up-payments) | | ||
| | `products` | `Array` | true | `['Auth']` | The Okra products you want to use with the widget. | | ||
| | `logo ` | `String(URL)` | false | Okra's Logo | | | ||
| | `name ` | `String` | false | Your Company's name | Name on the widget | | ||
| | `color` | `HEX ` | false | #3AB795 | Theme on the widget | | ||
| | `limit` | `Number` | false | 24 | Statement length | | ||
| | `filter` | `Object` | false | | Filter for widget | | ||
| | `isCorporate` | `Boolen` | false | `false` | Corporate or Individual account | | ||
| | `connectMessage` | `String` | false | | Instruction to connnect account | | ||
| | `widget_success` | `String` | false | | Widget Success Message | | ||
| | `widget_failed` | `String` | false | | Widget Failed Message | | ||
| | `callback_url` | `String(Url)` | false | | | | ||
| | `currency` | `String` | false | NGN | Wallet to bill | | ||
| | `exp` | `Date` | false | Won't expire | Expirary date of widget | | ||
| | `options` | `Object` | false | | You can pass a object custom values eg id | | ||
| | `onSuccess` | `Function` | false | | Action to perform after widget is successful | | ||
| | `onClose` | `Function` | false | | Action to perform if widget is closed | | ||
| | `onError` | `Function` | false | | Action to perform on widget Error | | ||
| | `BeforeClose` | `Function` | false | | Action to perform before widget close | | ||
| | `onEvent` | `Function` | false | | Action to perform on widget event | | ||
@@ -114,9 +113,10 @@ View a complete list of customizable options [here](https://docs.okra.ng/docs/widget-properties) | ||
| |Name | Type | Required | Description | | ||
| |-----------------------|----------------|---------------------|---------------------| | ||
| | `short_url` | `String` | true | Your generated url from our [App builder](https://docs.okra.ng/docs/widget-customization). | ||
| | `onSuccess` | `Function` | false | Action to perform after widget is successful | ||
| | `onClose` | `Function` | false | Action to perform if widget is closed | ||
| | `onError` | `Function` | false | Action to perform on widget Error | ||
| | `BeforeClose` | `Function` | false | Action to perform before widget close | ||
| | Name | Type | Required | Description | | ||
| |---------------|------------|----------|--------------------------------------------------------------------------------------------| | ||
| | `short_url` | `String` | true | Your generated url from our [App builder](https://docs.okra.ng/docs/widget-customization). | | ||
| | `onSuccess` | `Function` | false | Action to perform after widget is successful | | ||
| | `onClose` | `Function` | false | Action to perform if widget is closed | | ||
| | `onError` | `Function` | false | Action to perform on widget Error | | ||
| | `BeforeClose` | `Function` | false | Action to perform before widget close | | ||
| | `onEvent` | `Function` | false | | Action to perform on widget event | ||
@@ -126,7 +126,7 @@ ## Done connecting? | ||
| ## Not a developer? | ||
| Get started without writing a single line of code, Try our App Builder! [Click here to get started](https://dash.okra.ng/link-builder) | ||
| ## Not a developer? | ||
| Get started without writing a single line of code, Try our App Builder! [Click here to get started](https://docs.okra.ng/docs/widget-customization) | ||
| ## Other information | ||
| For enquires and questions, contact | ||
| - [@oreace](https://github.com/oreace) | ||
| - support@okra.ng |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by9845.02%
3685824
- Number of package files
- increased by3.13%
33
No dependency changes