@paydock/client-sdk 1.106.11-beta → 1.107.0

package/README.md

@@ -16,76 +16,78 @@ Also you will need added gateway ([see API Reference by gateway](https://docs.pa
 
 ## Get started
 
-### With package manager
-
-To install with package manager, enter the following command:
-
-`npm install @paydock/client-sdk`
-
-
-You can use ES2015 or TypeScript modules
-
-`@paydock/client-sdk/widget`
-
+The Client SDK ships in JavaScript ES6 (EcmaScript 2015) in three different
+formats (CJS, ESM and UMD) along with respective TypeScript declarations. Below,
+we exemplify how to import each format.
 
-Also can use UMD module (global visibility, see above)
-
-`@paydock/client-sdk/bundles/widget.umd.js`
-
-`@paydock/client-sdk/bundles/widget.umd.min.js`
+### With package manager
 
+Our NPM package is compatible with all package managers (e.g., `npm`, `yarn`,
+`pnpm`, `bun`). Using `npm` the following command would add the Client SDK as a
+production dependency.
 
+```bash
+npm install @paydock/client-sdk
+```
 
-```javascript--es2015
-// ES2015 / TypeScript
+After installation is complete, if you are developing in NodeJS environments or
+using tools that expect your JavaScript code to be in CJS format (e.g., Jest,
+Karma, RequireJS, Webpack), you can import the Client SDK using CommonJS modules.
+For these environments the UMD format (`@paydock/client-sdk/bundles/widget.umd.js`)
+can also be used as a fallback. Alternatively, in case you are developing in
+projects that have access to modern bundlers such as Vite or others (e.g., SPA
+libs or SSR Metaframeworks), you can import the Client SDK features using ESM
+through named imports or namespaced imports.
 
-import { HtmlWidget } from '@paydock/client-sdk/widget';
 
-let widget = new HtmlWidget('#selector', 'publicKey', 'gatewayId');
+```cjs
+// module import - CommonJS/Node projects ✅
+const paydock = require('@paydock/client-sdk')
+const api = new paydock.Api('publicKey');
 ```
 
+```mjs
+// named import - ESM projects or TypeScript projects ✅
+import { HtmlWidget } from '@paydock/client-sdk'
+const widget = new HtmlWidget('#selector', 'publicKey', 'gatewayId');
+```
 
-```html
-<script src="@paydock/client-sdk/bundles/widget.umd.min.js"></script>
-<script>
-    var widget = new paydock.HtmlWidget('#tag', 'publicKey', 'gatewayId');
-</script>
+```mjs
+// namespaced import - ESM projects or TypeScript projects ✅
+import * as Paydock from '@paydock/client-sdk'
+const widget = new Paydock.HtmlWidget('#selector', 'publicKey', 'gatewayId');
 ```
 
+```js
+// default import - We do not provide default exports. They are handled differently by different tools!
+ ❌
+import paydock from '@paydock/client-sdk'
+>>> "Uncaught SyntaxError: The requested module does not provide an export named 'default'"
+```
 
 
 ### Download from CDN
 
-You should begin by including the library in your page.
-
-Add this script tag to your page to get started with with the url below:
+For browser environments, you can import the Client SDK directly from our CDN to
+your project's HTML. To accomplish this, include the Client SDK in your page
+using one and only of the two script tags below. After this step you will be
+able to access the Client SDK features via the global variable `paydock`.
 
-*Compressed version for production*
-`https://widget.paydock.com/sdk/latest/widget.umd.min.js` 
+For production we recommend using the compressed version (`.min.js`) since
+it will result in faster loading times for your end users.
 
-*Full version for development and debug*
-`https://widget.paydock.com/sdk/latest/widget.umd.js`
+- *Compressed version for production: `https://widget.paydock.com/sdk/latest/widget.umd.min.js`*
 
+- *Full version for development and debug: `https://widget.paydock.com/sdk/latest/widget.umd.js`*
 
-
-
-Also can download library the [production version][min] or the [development version][max]
+You may download the production version of the Client SDK scripts [here][min],
+and, the development version [here][max].
 
 [min]: https://widget.paydock.com/sdk/latest/widget.umd.min.js
 [max]: https://widget.paydock.com/sdk/latest/widget.umd.js
 
-
-The library will always be available via the global variable `paydock`.
-
-
-
-Also for more advanced use, the library has [UMD](https://github.com/umdjs/umd) format, thus can be used in requireJs, webpack, etc.
-
-
-
-
-
-
+For more advanced use-cases, the library has [UMD](https://github.com/umdjs/umd)
+format that can be used in RequireJS, Webpack, etc.
 
 
 ```html
@@ -95,6 +97,7 @@ Also for more advanced use, the library has [UMD](https://github.com/umdjs/umd)
 </script>
 ```
 
+
 ## Widget
 You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#widget-simple-example)
 
@@ -119,11 +122,11 @@ var widget = new paydock.HtmlWidget('#widget', 'publicKey');
 widget.load();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 
-import { HtmlWidget } from '@paydock/client-sdk/widget';
-    
+import { HtmlWidget } from '@paydock/client-sdk';
+
 var widget = new HtmlWidget('#widget', 'publicKey');
 widget.load();
 ```
@@ -131,7 +134,7 @@ widget.load();
 Then write only need 2 lines of code in js to initialize widget
 
 
-### Full example 
+### Full example
 
 ```html
 <!DOCTYPE html>
@@ -194,9 +197,9 @@ widget.setFormFields(['phone', 'email']); // add additional fields for form of w
 widget.setSupportedCardIcons(['mastercard', 'visa']); // add icons of supported card types
 ```
 
-This example shows how you can use a lot of other methods to settings your form 
+This example shows how you can use a lot of other methods to settings your form
 
-### Full example 
+### Full example
 
 ```html
 <!DOCTYPE html>
@@ -217,12 +220,12 @@ This example shows how you can use a lot of other methods to settings your form
 <script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
 <script>
 	var widget = new paydock.HtmlWidget('#widget', 'publicKey', 'gatewayId');
-	
+
 	widget.setSupportedCardIcons(['mastercard', 'visa']);
 	widget.setFormFields(['phone', 'email']);
 	widget.setRefId('custom-ref-id');
     widget.onFinishInsert('input[name="payment_source_token"]', 'payment_source');z
-	
+
 	widget.load();
 </script>
 </script>
@@ -648,7 +651,7 @@ Class Widget include method for working on html and include extended by HtmlMult
     * [.setFormValues(fieldValues)](#user-content-w_MultiWidget+setFormValues)
     * [.setFormLabels(fieldLabels)](#user-content-w_MultiWidget+setFormLabels)
     * [.setFormPlaceholders(fieldPlaceholders)](#user-content-w_MultiWidget+setFormPlaceholders)
-    * [.setIcons()](#user-content-w_MultiWidget+setIcons)
+    * ~~[.setIcons()](#user-content-w_MultiWidget+setIcons)~~
     * [.setHiddenElements(elements)](#user-content-w_MultiWidget+setHiddenElements)
     * [.setRefId(refId)](#user-content-w_MultiWidget+setRefId)
     * [.useGatewayFieldValidation()](#user-content-w_MultiWidget+useGatewayFieldValidation)
@@ -1213,15 +1216,13 @@ widget.setFormPlaceholders({
 ```
 <a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" href="#user-content-w_MultiWidget+setIcons">&nbsp;</a>
 
-### htmlWidget.setIcons()
+### ~~htmlWidget.setIcons()~~
+***Deprecated***
+
 The method to change the widget icons
 
 **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)  
 **Overrides**: [<code>setIcons</code>](#user-content-w_MultiWidget+setIcons)  
-**Todo**
-
-- [ ] DEPRECATED
-
 <a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" href="#user-content-w_MultiWidget+setHiddenElements">&nbsp;</a>
 
 ### htmlWidget.setHiddenElements(elements)
@@ -1375,7 +1376,7 @@ Class HtmlMultiWidget include method for working with html
     * [.setFormLabels(fieldLabels)](#user-content-w_MultiWidget+setFormLabels)
     * [.setFormPlaceholders(fieldPlaceholders)](#user-content-w_MultiWidget+setFormPlaceholders)
     * [.setFormElements(elements)](#user-content-w_MultiWidget+setFormElements)
-    * [.setIcons()](#user-content-w_MultiWidget+setIcons)
+    * ~~[.setIcons()](#user-content-w_MultiWidget+setIcons)~~
     * [.setHiddenElements(elements)](#user-content-w_MultiWidget+setHiddenElements)
     * [.setRefId(refId)](#user-content-w_MultiWidget+setRefId)
     * [.useGatewayFieldValidation()](#user-content-w_MultiWidget+useGatewayFieldValidation)
@@ -1841,15 +1842,13 @@ widget.setFormElements([
 ```
 <a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" href="#user-content-w_MultiWidget+setIcons">&nbsp;</a>
 
-### htmlMultiWidget.setIcons()
+### ~~htmlMultiWidget.setIcons()~~
+***Deprecated***
+
 The method to change the widget icons
 
 **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)  
 **Overrides**: [<code>setIcons</code>](#user-content-w_MultiWidget+setIcons)  
-**Todo**
-
-- [ ] DEPRECATED
-
 <a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" href="#user-content-w_MultiWidget+setHiddenElements">&nbsp;</a>
 
 ### htmlMultiWidget.setHiddenElements(elements)
@@ -2162,7 +2161,7 @@ Class MultiWidget include method for for creating iframe url
     * [.setFormLabels(fieldLabels)](#user-content-w_MultiWidget+setFormLabels)
     * [.setFormPlaceholders(fieldPlaceholders)](#user-content-w_MultiWidget+setFormPlaceholders)
     * [.setFormElements(elements)](#user-content-w_MultiWidget+setFormElements)
-    * [.setIcons()](#user-content-w_MultiWidget+setIcons)
+    * ~~[.setIcons()](#user-content-w_MultiWidget+setIcons)~~
     * [.setHiddenElements(elements)](#user-content-w_MultiWidget+setHiddenElements)
     * [.setRefId(refId)](#user-content-w_MultiWidget+setRefId)
     * [.useGatewayFieldValidation()](#user-content-w_MultiWidget+useGatewayFieldValidation)
@@ -2388,14 +2387,12 @@ widget.setFormElements([
 ```
 <a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" href="#user-content-w_MultiWidget+setIcons">&nbsp;</a>
 
-### multiWidget.setIcons()
+### ~~multiWidget.setIcons()~~
+***Deprecated***
+
 The method to change the widget icons
 
 **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)  
-**Todo**
-
-- [ ] DEPRECATED
-
 <a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" href="#user-content-w_MultiWidget+setHiddenElements">&nbsp;</a>
 
 ### multiWidget.setHiddenElements(elements)
@@ -2765,10 +2762,10 @@ var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken
 list.load();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 
-import { HtmlPaymentSourceWidget } from '@paydock/client-sdk/payment-source-widget';
+import { HtmlPaymentSourceWidget } from '@paydock/client-sdk';
 
 var list = new HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
 list.load();
@@ -3481,7 +3478,7 @@ You must create a button to turn it into checkout-button
 var button = new paydock.PaypalCheckoutButton('#button', 'publicKey', 'gatewayId');
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 
 
@@ -4624,11 +4621,11 @@ This wrapper helps you to work with paydock api emdpoints
 var browserDetails = await new paydock.Api('publicKey').setEnv('env').getBrowserDetails();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 
-import { Api } from '@paydock/client-sdk/api';
-    
+import { Api } from '@paydock/client-sdk';
+
 var browserDetails = await new paydock.Api('publicKey').setEnv('env').getBrowserDetails();
 ```
 
@@ -4641,11 +4638,11 @@ var response = await new paydock.Api('publicKey').setEnv('env').charge().preAuth
     });
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 
-import { Api } from '@paydock/client-sdk/api';
-    
+import { Api } from '@paydock/client-sdk';
+
 var response = await new Api('publicKey').setEnv('env').charge().preAuth({
       amount: 100,
       currency: 'AUD',
@@ -4655,7 +4652,7 @@ var response = await new Api('publicKey').setEnv('env').charge().preAuth({
 
 Then write only need 2 lines of code in js to make request
 
-### Initialization full example 
+### Initialization full example
 
 ```html
 <!DOCTYPE html>
@@ -4702,10 +4699,10 @@ var canvas3ds = new paydock.Canvas3ds('#widget', 'token');
 canvas3ds.load();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 
-import { Canvas3ds } from '@paydock/client-sdk/canvas3ds';
+import { Canvas3ds } from '@paydock/client-sdk';
 
 var list = new Canvas3ds('#widget', 'token');
 list.load();
@@ -4926,7 +4923,7 @@ After you initialized the standalone 3ds charge via `v1/charges/standalone-3ds`
 ## Vault Display Widget
 You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#vault-display-widget)
 
-The vault display form allows viewing card number and CVV. The form can be customised according to your needs. 
+The vault display form allows viewing card number and CVV. The form can be customised according to your needs.
 You can set styles as well as subscribe to widget events that help monitor user’s actions in real time.
 
 ## Vault Display Widget simple example
@@ -4946,18 +4943,18 @@ var widget = new paydock.VaultDisplayWidget('#widget', 'token');
 widget.load();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 
-import { VaultDisplayWidget } from '@paydock/client-sdk/vault-display-widget';
-    
+import { VaultDisplayWidget } from '@paydock/client-sdk';
+
 var widget = new VaultDisplayWidget('#widget', 'token');
 widget.load();
 ```
 
 Then write only need 2 lines of code in js to initialize widget
 
-### Full example 
+### Full example
 
 ```html
 <!DOCTYPE html>
@@ -4968,9 +4965,9 @@ Then write only need 2 lines of code in js to initialize widget
     <style>iframe {border: 0;width: 100%;height: 300px;}</style>
 </head>
 <body>
-        
+
     <div id="widget"></div>
-   
+
     <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
     <script>
         var widget = new paydock.VaultDisplayWidget('#widget', 'token');
@@ -5008,9 +5005,9 @@ widget.setStyles({
 });
 ```
 
-This example shows how you can use a lot of other methods to settings your form 
+This example shows how you can use a lot of other methods to settings your form
 
-### Full example 
+### Full example
 
 ```html
 <!DOCTYPE html>
@@ -5021,27 +5018,27 @@ This example shows how you can use a lot of other methods to settings your form
     <style>iframe {border: 0;width: 40%;height: 450px;}</style>
 </head>
 <body>
-        
+
     <div id="widget"></div>
-   
+
     <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
     <script>
         var widget = new paydock.VaultDisplayWidget('#widget', 'token');
 
         widget.setEnv('sandbox');
-        
+
         widget.on('after_load', function (data) {
           console.log(data);
         });
-        
+
         widget.on('cvv_secure_code_requested', function (data) {
           console.log(data);
         });
-        
+
         widget.on('card_number_secure_code_requested', function (data) {
           console.log(data);
         });
-        
+
         widget.setStyles({
             background_color: 'rgb(0, 0, 0)',
             border_color: 'yellow',
@@ -5185,7 +5182,7 @@ let button = new paydock.WalletButtons(
 button.load();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 import { WalletButtons } from '@paydock/client-sdk';
 
@@ -5210,7 +5207,7 @@ let button = new paydock.WalletButtons(
 button.load();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 import { WalletButtons } from '@paydock/client-sdk';
 
@@ -5234,7 +5231,7 @@ let button = new paydock.WalletButtons(
 button.load();
 ```
 
-```javascript--es2015
+```javascript
 // ES2015 | TypeScript
 import { WalletButtons } from '@paydock/client-sdk';
 
@@ -6399,8 +6396,11 @@ To integrate the Click To Pay checkout iFrame, create a container in your HTML c
 ```html
 <div id="checkoutIframe"></div>
 ```
+
 ### Initialize the Widget
+
 Use the following code to initialize your widget:
+
 ```javascript
 var src = new paydock.ClickToPay(
     "#checkoutIframe",
@@ -6410,7 +6410,8 @@ var src = new paydock.ClickToPay(
 );
 src.load();
 ```
-```javascript--es2015
+
+```javascript
 // ES2015 | TypeScript
 import { ClickToPay } from '@paydock/client-sdk';
 var src = new ClickToPay(
@@ -6421,9 +6422,13 @@ var src = new ClickToPay(
 );
 src.load();
 ```
+
 *NOTE:* Paydock recommends that you use a Paydock Access Token instead of a public key for security reasons in production environments. When creating your access token, you must enable the `Secure Remote Commerce` and add a whitelist for the domain of your checkout screen.
+
 ### Full example
+
 A full example of the container and the initialized widget is as follows:
+
 ```html
 <!DOCTYPE html>
 <html lang="en">
@@ -6451,7 +6456,9 @@ A full example of the container and the initialized widget is as follows:
 ## Customize your Click To Pay Checkout
 
 The following is an advanced example that includes customization. You can use these methods to enhance your checkout experience.
+
 ### Settings
+
 ```javascript
 src.setEnv('sandbox'); // set environment
 src.hideCheckout(); // hide checkout iframe
@@ -6469,7 +6476,9 @@ src.on('checkoutError', (error) => {
     console.log(error);
 });
 ```
+
 ### Full example
+
 ```html
 <!DOCTYPE html>
 <html lang="en">
@@ -6505,9 +6514,12 @@ src.on('checkoutError', (error) => {
 </body>
 </html>
 ```
+
 ## Customize your billing address fields
+
 To customize your billing address experience, Paydock uses a flag that manages whether a customer's billing address is mandatory.
 The options for this customization are NONE (default option), and POSTAL_COUNTRY or FULL.
+
 ```
 var src = new paydock.ClickToPay(
     "#checkoutIframe",
@@ -6526,6 +6538,7 @@ You can also provide the billing address at the time of creating the charge. For
 1. Disable the billing address in Paydock's Click To Pay widget.
 2. Get your One Time Token from the Click To Pay widget alongside other details that may have been collected outside the Click To Pay checkout as the shipping address.
 3. Send the billing address when creating the charge.
+
 ```
 POST v1/charges
 {
@@ -6554,10 +6567,15 @@ POST v1/charges
     }
 }
 ```
+
 ## How to customize accepted cards
+
 You can send a flag `unaccepted_card_type` to block the usage of a specific card type. The available options are 'DEBIT' and 'CREDIT'.
+
 ### Example code
+
 The following example demonstrates how to block the card:
+
 ```
 var src = new paydock.ClickToPay(
     "#checkoutIframe",
@@ -6568,9 +6586,13 @@ var src = new paydock.ClickToPay(
     },
 );
 ```
+
 ## Personalize the Style
+
 Customize the look and feel of your UI. The following example demonstrates changes in the styling of the buttons.
+
 ### Example code
+
 ```
 var src = new paydock.ClickToPay(
     "#checkoutIframe",