@paydock/client-sdk 1.104.3-beta → 1.105.1

package/slate.md

@@ -16,10 +16,6 @@ Also you will need added gateway ([see API Reference by gateway](https://docs.pa
 
 ## Get started
 
-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.
-
 ### Download from CDN
 
 ```html
@@ -29,73 +25,77 @@ we exemplify how to import each format.
 </script>
 ```
 
+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:
+
+*Compressed version for production*
+`https://widget.paydock.com/sdk/latest/widget.umd.min.js` 
 
-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`.
+*Full version for development and debug*
+`https://widget.paydock.com/sdk/latest/widget.umd.js`
 
-For production we recommend using the compressed version (`.min.js`) since
-it will result in faster loading times for your end users.
 
-- *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`*
 
-You may download the production version of the Client SDK scripts [here][min],
-and, the development version [here][max].
+Also can download library the [production version][min] or the [development version][max]
 
 [min]: https://widget.paydock.com/sdk/latest/widget.umd.min.js
 [max]: https://widget.paydock.com/sdk/latest/widget.umd.js
 
-For more advanced use-cases, the library has [UMD](https://github.com/umdjs/umd)
-format that can be used in RequireJS, Webpack, etc.
+
+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.
+
+
+
+
+
+
+
 
 
 ### With package manager
 
-```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');
-```
+```javascript--es2015
+// ES2015 / TypeScript
+
+import { HtmlWidget } from '@paydock/client-sdk/widget';
 
-```mjs
-// namespaced import - ESM projects or TypeScript projects ✅
-import * as Paydock from '@paydock/client-sdk'
-const widget = new Paydock.HtmlWidget('#selector', 'publicKey', 'gatewayId');
+let widget = new 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'"
+
+```html
+<script src="@paydock/client-sdk/bundles/widget.umd.min.js"></script>
+<script>
+    var widget = new paydock.HtmlWidget('#tag', 'publicKey', 'gatewayId');
+</script>
 ```
 
 
-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.
+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`
+
+
+Also can use UMD module (global visibility, see above)
+
+`@paydock/client-sdk/bundles/widget.umd.js`
+
+`@paydock/client-sdk/bundles/widget.umd.min.js`
+
 
-```bash
-npm install @paydock/client-sdk
-```
 
-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.
 
 
 ## Widget
@@ -122,11 +122,11 @@ var widget = new paydock.HtmlWidget('#widget', 'publicKey');
 widget.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
-import { HtmlWidget } from '@paydock/client-sdk';
-
+import { HtmlWidget } from '@paydock/client-sdk/widget';
+    
 var widget = new HtmlWidget('#widget', 'publicKey');
 widget.load();
 ```
@@ -134,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>
@@ -197,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>
@@ -220,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>
@@ -262,10 +262,10 @@ var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken
 list.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
-import { HtmlPaymentSourceWidget } from '@paydock/client-sdk';
+import { HtmlPaymentSourceWidget } from '@paydock/client-sdk/payment-source-widget';
 
 var list = new HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
 list.load();
@@ -392,7 +392,7 @@ You must create a button to turn it into checkout-button
 var button = new paydock.PaypalCheckoutButton('#button', 'publicKey', 'gatewayId');
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
 
@@ -622,11 +622,11 @@ This wrapper helps you to work with paydock api emdpoints
 var browserDetails = await new paydock.Api('publicKey').setEnv('env').getBrowserDetails();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
-import { Api } from '@paydock/client-sdk';
-
+import { Api } from '@paydock/client-sdk/api';
+    
 var browserDetails = await new paydock.Api('publicKey').setEnv('env').getBrowserDetails();
 ```
 
@@ -639,11 +639,11 @@ var response = await new paydock.Api('publicKey').setEnv('env').charge().preAuth
     });
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
-import { Api } from '@paydock/client-sdk';
-
+import { Api } from '@paydock/client-sdk/api';
+    
 var response = await new Api('publicKey').setEnv('env').charge().preAuth({
       amount: 100,
       currency: 'AUD',
@@ -653,7 +653,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>
@@ -700,10 +700,10 @@ var canvas3ds = new paydock.Canvas3ds('#widget', 'token');
 canvas3ds.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
-import { Canvas3ds } from '@paydock/client-sdk';
+import { Canvas3ds } from '@paydock/client-sdk/canvas3ds';
 
 var list = new Canvas3ds('#widget', 'token');
 list.load();
@@ -924,7 +924,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
@@ -944,18 +944,18 @@ var widget = new paydock.VaultDisplayWidget('#widget', 'token');
 widget.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
-import { VaultDisplayWidget } from '@paydock/client-sdk';
-
+import { VaultDisplayWidget } from '@paydock/client-sdk/vault-display-widget';
+    
 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>
@@ -966,9 +966,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');
@@ -1006,9 +1006,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>
@@ -1019,27 +1019,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',
@@ -1088,7 +1088,7 @@ let button = new paydock.WalletButtons(
 button.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 import { WalletButtons } from '@paydock/client-sdk';
 
@@ -1113,7 +1113,7 @@ let button = new paydock.WalletButtons(
 button.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 import { WalletButtons } from '@paydock/client-sdk';
 
@@ -1137,7 +1137,7 @@ let button = new paydock.WalletButtons(
 button.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 import { WalletButtons } from '@paydock/client-sdk';
 
@@ -1206,6 +1206,14 @@ In some situations you may want to forcibly close the checkout so that your user
 button.close();
 ```
 
+### Performing actions when the wallet button is clicked
+
+In some situations you may want to perform some validations or actions when the user clicks on the wallet button, for which you can use this method. Currently supported by Paypal, ApplePay and GooglePay wallets.
+
+```javascript
+button.onClick(() => console.log("Perform actions on button click"));
+```
+
 ### Performing actions when shipping info is updated
 
 In Flypay, Paypal, ApplePay via MPGS and GooglePay via MPGS integrations after each shipping info update the `onUpdate(data)` will be called with the selected shipping address information, plus selected shipping method when applicable for Paypal, ApplePay and GooglePay. Merchants should handle this callback, recalculate shipping costs in their server by analyzing the new data, and submit a backend to backend request to `POST charges/:id` with the new total amount and shipping amount (you can find the documentation of this call in the PayDock API documentation).
@@ -1333,30 +1341,51 @@ _(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_l
 <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
 <script>
     let button = new paydock.WalletButtons(
-          "#widget",
-          charge_token,
-          {
-               request_shipping: true,
-               pay_later: true,
-               standalone: false,
-               style: {
-                    layout: 'horizontal',
-                    color: 'blue',
-                    shape: 'rect',
-                    label: 'paypal',
-               },
-          }
-     );
+        "#widget",
+        charge_token,
+        {
+            request_shipping: true,
+            pay_later: true,
+            standalone: false,
+            style: {
+                layout: 'horizontal',
+                color: 'blue',
+                shape: 'rect',
+                label: 'paypal',
+            },
+        }
+    );
     button.setEnv('sandbox');
     button.onUnavailable(() => console.log("No wallet buttons available"));
     button.onUpdate((data) => {
-          console.log("Updating amount via a backend to backend call to POST charges/:id");
-          // call `POST charges/:id` to modify charge
-          button.update({ success: true });
-     });
+        console.log("Updating amount via a backend to backend call to POST charges/:id");
+        // call `POST charges/:id` to modify charge
+        button.update({ success: true });
+    });
     button.onPaymentSuccessful((data) => console.log("The payment was successful"));
     button.onPaymentError((data) => console.log("The payment was not successful"));
     button.onPaymentInReview((data) => console.log("The payment is on fraud review"));
+
+    // Example 1: Asynchronous onClick handler
+    const asyncLogic = async () => {
+        // Perform asynchronous logic. Expectation is that a Promise is returned and attached to response via `attachResult`,
+        // and resolve or reject of it will dictate how wallet behaves.
+    }
+
+    button.onClick(({ data: { attachResult } }) => {
+        // Promise is attached to the result. On Paypal, when promise is resolved, the user Journey will continue.
+        // If no promise is attached then the Paypal journey will not depend on the promise being resolved or rejected
+        attachResult(asyncLogic());
+    });
+
+    // Example 2: Synchronous onClick handler
+    // button.onClick(({ data: { attachResult } }) => {
+    //     // Perform synchronous logic
+    //     console.log("Synchronous onClick: Button clicked");
+    //     // Optionally return a boolean flag to halt the operation
+    //     attachResult(false);
+    // });
+
     button.load();
 </script>
 </html>
@@ -1490,6 +1519,7 @@ _(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `ra
     button.onUnavailable(() => console.log("No wallet buttons available"));
     button.onPaymentSuccessful((data) => console.log("The payment was successful"));
     button.onPaymentError((data) => console.log("The payment was not successful"));
+    button.onClick(() => console.log("On WalletButton Click"));
     button.onUpdate((data) => {
         console.log("Updating amount via a backend to backend call to POST charges/:id");
         // call `POST charges/:id` to modify charge
@@ -1522,7 +1552,6 @@ _(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `ra
 Also, for **ApplePay via MPGS** you can initialize the `ApplePayPaymentRequest` with your own values instead of using the default ones. Below you can see an example on how to initialize the `ApplePayPaymentRequest` with the `raw_data_initialization` meta field.
 
 Similarly, for **GooglePay via MPGS** you can initialize the `PaymentMethodSpecification` with your own values instead of using the default ones. Below you can see an example on how to initialize the `PaymentMethodSpecification` with the `raw_data_initialization` meta field.
-
 ### ApplePay and GooglePay via MPGS Raw data initialization example
 
 ```html
@@ -1664,7 +1693,7 @@ var src = new paydock.SRC(
 src.load();
 ```
 
-```javascript
+```javascript--es2015
 // ES2015 | TypeScript
 
 import { SRC } from '@paydock/client-sdk';

package/tslint.json

@@ -0,0 +1,129 @@
+{
+  "defaultSeverity": "error",
+  "extends": [
+    "tslint:recommended"
+  ],
+  "jsRules": {
+    "no-unused-expression": true
+  },
+  "rules": {
+    "ordered-imports": false,
+    "arrow-return-shorthand": false,
+    "callable-types": true,
+    "class-name": false,
+    "comment-format": [
+      true,
+      "check-space"
+    ],
+    "curly": false,
+    "eofline": true,
+    "forin": true,
+    "import-blacklist": [
+      true,
+      "rxjs"
+    ],
+    "import-spacing": true,
+    "indent": [
+      true,
+      "spaces"
+    ],
+    "interface-over-type-literal": true,
+    "label-position": true,
+    "max-line-length": [
+      true,
+      300
+    ],
+    "member-access": false,
+    "member-ordering": [
+      true,
+      {
+        "order": [
+          "static-field",
+          "instance-field",
+          "static-method",
+          "instance-method"
+        ]
+      }
+    ],
+    "no-arg": true,
+    "no-bitwise": true,
+    "no-console": [
+      true,
+      "debug",
+      "log",
+      "time",
+      "timeEnd",
+      "trace"
+    ],
+    "no-construct": true,
+    "no-debugger": true,
+    "no-duplicate-super": true,
+    "no-empty": false,
+    "no-empty-interface": false,
+    "interface-name": [false, "always-prefix"],
+    "no-eval": true,
+    "no-inferrable-types": [
+      true,
+      "ignore-params"
+    ],
+    "max-classes-per-file": [true, 6, "exclude-class-expressions"],
+    "no-misused-new": true,
+    "no-non-null-assertion": true,
+    "no-shadowed-variable": false,
+    "no-string-literal": false,
+    "no-string-throw": true,
+    "jsdoc-format": false,
+    "no-switch-case-fall-through": true,
+    "no-trailing-whitespace": false,
+    "no-unnecessary-initializer": true,
+    "no-angle-bracket-type-assertion": false,
+    "no-unused-expression": true,
+    "no-consecutive-blank-lines": false,
+    "no-var-keyword": true,
+    "no-reference": false,
+    "ban-types": false,
+    "object-literal-sort-keys": false,
+    "object-literal-shorthand": false,
+    "one-line": [
+      true,
+      "check-open-brace",
+      "check-catch",
+      "check-else",
+      "check-whitespace"
+    ],
+    "prefer-const": false,
+    "quotemark": [
+      false,
+      "single"
+    ],
+    "radix": true,
+    "semicolon": [
+      false
+    ],
+    "triple-equals": [
+      true,
+      "allow-null-check"
+    ],
+    "typedef-whitespace": [
+      true,
+      {
+        "call-signature": "nospace",
+        "index-signature": "nospace",
+        "parameter": "nospace",
+        "property-declaration": "nospace",
+        "variable-declaration": "nospace"
+      }
+    ],
+    "unified-signatures": false,
+    "variable-name": false,
+    "whitespace": [
+      false,
+      "check-branch",
+      "check-decl",
+      "check-operator",
+      "check-separator",
+      "check-type"
+    ]
+  },
+  "rulesDirectory": []
+}

package/typings/globals/@auspayplus/open-payments-checkout/index.d.ts

@@ -0,0 +1,43 @@
+declare module '@auspayplus/open-payments-checkout' {
+  // WindowFeatures type
+  type WindowFeatures = {
+    width?: number;
+    height?: number;
+    left?: number;
+    popup?: 'yes' | 'no' | '1' | '0';
+    resizable?: 'yes' | 'no' | '1' | '0';
+    top?: number;
+  };
+
+  // Callbacks type
+  interface ICheckoutCallback {
+    orderId: string;
+    error?: Error;
+  }
+
+  // Constructor options for Checkout
+  interface CheckoutOptions {
+    orderId: string;
+    url: string;
+    accessToken?: string;
+    refreshToken?: string;
+    clientId?: string;
+    onCheckoutClosed?: (callbackData: ICheckoutCallback) => void;
+    onError?: (callbackData: ICheckoutCallback) => void;
+    onPaymentSuccess?: (callbackData: ICheckoutCallback) => void;
+    onPaymentError?: (callbackData: ICheckoutCallback) => void;
+    onTokensChanged?: ({ accessToken, refreshToken }: { accessToken: string; refreshToken: string; }) => void;
+    windowFeatures?: WindowFeatures;
+    auth?: { access_token?: string; refresh_token?: string };
+    mode?: string;
+  }
+
+  // Checkout class declaration
+  export class Checkout {
+    constructor(options: CheckoutOptions);
+    isCheckoutOpen(): boolean;
+    listenMessage(): void;
+    open(): void;
+    close(): void;
+  }
+}