@paydock/client-sdk 1.104.3-beta → 1.104.7-beta

package/docs/wallet-buttons.md

@@ -17,6 +17,24 @@
 ## Interfaces
 
 <dl>
+<dt><a href="#IEventData">IEventData</a></dt>
+<dd><p>Interface of data from events.</p>
+</dd>
+<dt><a href="#IWalletPaymentSuccessful">IWalletPaymentSuccessful</a></dt>
+<dd><p>Interface of data from a successful payment result.</p>
+</dd>
+<dt><a href="#IWalletUpdate">IWalletUpdate</a></dt>
+<dd><p>Interface of data from an update event.</p>
+</dd>
+<dt><a href="#IWalletOnClick">IWalletOnClick</a></dt>
+<dd><p>Interface of data from a wallet onClick event.</p>
+</dd>
+<dt><a href="#IWalletUnavailable">IWalletUnavailable</a></dt>
+<dd><p>Interface of data from an unavailable event.</p>
+</dd>
+<dt><a href="#IWalletUpdateData">IWalletUpdateData</a></dt>
+<dd><p>Interface of data for wallet button <code>update</code> call.</p>
+</dd>
 <dt><a href="#IWalletMeta">IWalletMeta</a> : <code>object</code></dt>
 <dd><p>Interface of data used by the wallet checkout and payment proccess.</p>
 </dd>
@@ -31,6 +49,100 @@
 </dd>
 </dl>
 
+<a name="IEventData" id="IEventData" href="#IEventData">&nbsp;</a>
+
+## IEventData
+Interface of data from events.
+
+**Kind**: global interface  
+
+| Param | Type |
+| --- | --- |
+| event | <code>string</code> | 
+| data | <code>void</code> \| [<code>IWalletPaymentSuccessful</code>](#IWalletPaymentSuccessful) \| [<code>IWalletUpdate</code>](#IWalletUpdate) \| [<code>IWalletUnavailable</code>](#IWalletUnavailable) \| [<code>IWalletOnClick</code>](#IWalletOnClick) \| <code>any</code> | 
+
+<a name="IWalletPaymentSuccessful" id="IWalletPaymentSuccessful" href="#IWalletPaymentSuccessful">&nbsp;</a>
+
+## IWalletPaymentSuccessful
+Interface of data from a successful payment result.
+
+**Kind**: global interface  
+
+| Param | Type |
+| --- | --- |
+| id | <code>string</code> | 
+| amount | <code>number</code> | 
+| currency | <code>string</code> | 
+| status | <code>string</code> | 
+| [payer_name] | <code>string</code> | 
+| [payer_email] | <code>string</code> | 
+| [payer_phone] | <code>string</code> | 
+
+<a name="IWalletUpdate" id="IWalletUpdate" href="#IWalletUpdate">&nbsp;</a>
+
+## IWalletUpdate
+Interface of data from an update event.
+
+**Kind**: global interface  
+
+| Param | Type |
+| --- | --- |
+| [wallet_response_code] | <code>string</code> | 
+| [wallet_session_id] | <code>string</code> | 
+| [payment_source] | <code>object</code> | 
+| [payment_source.wallet_payment_method_id] | <code>string</code> | 
+| [payment_source.card_number_last4] | <code>string</code> | 
+| [payment_source.card_scheme] | <code>string</code> | 
+| [wallet_loyalty_account] | <code>object</code> | 
+| [wallet_loyalty_account.id] | <code>string</code> | 
+| [wallet_loyalty_account.barcode] | <code>string</code> | 
+| [shipping] | <code>object</code> | 
+| [shipping.address_line1] | <code>string</code> | 
+| [shipping.address_line2] | <code>string</code> | 
+| [shipping.address_postcode] | <code>string</code> | 
+| [shipping.address_city] | <code>string</code> | 
+| [shipping.address_state] | <code>string</code> | 
+| [shipping.address_country] | <code>string</code> | 
+| [shipping.address_company] | <code>string</code> | 
+| [shipping.post_office_box_number] | <code>string</code> | 
+| [shipping.wallet_address_id] | <code>string</code> | 
+| [shipping.wallet_address_name] | <code>string</code> | 
+| [shipping.wallet_address_created_timestamp] | <code>string</code> | 
+| [shipping.wallet_address_updated_timestamp] | <code>string</code> | 
+
+<a name="IWalletOnClick" id="IWalletOnClick" href="#IWalletOnClick">&nbsp;</a>
+
+## IWalletOnClick
+Interface of data from a wallet onClick event.
+
+**Kind**: global interface  
+
+| Param | Description |
+| --- | --- |
+| attachResult | Method to be called that attaches a result to the wallet onClick operation. When handler is synchronous, this method is optionally called with a boolean flag indicating validation result. When handler executes asynchronous operations, this method must be called with the Promise to have the wallet process wait for its completion or rejection. |
+
+<a name="IWalletUnavailable" id="IWalletUnavailable" href="#IWalletUnavailable">&nbsp;</a>
+
+## IWalletUnavailable
+Interface of data from an unavailable event.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [wallet] | <code>string</code> | For gateways with more than one wallet button available (e.g: MPGS with ApplePay and GooglePay). Possible values for wallet are 'apple' or 'google'. |
+
+<a name="IWalletUpdateData" id="IWalletUpdateData" href="#IWalletUpdateData">&nbsp;</a>
+
+## IWalletUpdateData
+Interface of data for wallet button `update` call.
+
+**Kind**: global interface  
+
+| Param | Type |
+| --- | --- |
+| success | <code>boolean</code> | 
+
 <a name="IWalletMeta" id="IWalletMeta" href="#IWalletMeta">&nbsp;</a>
 
 ## IWalletMeta : <code>object</code>
@@ -115,14 +227,19 @@ Class WalletButtons to work with different E-Wallets within html (currently supp
     * [.load()](#WalletButtons+load)
     * [.update()](#WalletButtons+update)
     * [.setEnv(env, [alias])](#WalletButtons+setEnv)
+    * [.enable()](#WalletButtons+enable)
+    * [.disable()](#WalletButtons+disable)
     * [.close()](#WalletButtons+close)
-    * [.on(eventName, [cb])](#WalletButtons+on) ⇒ <code>Promise.&lt;IEventData&gt;</code> \| <code>void</code>
+    * [.on(eventName, [cb])](#WalletButtons+on) ⇒ [<code>Promise.&lt;IEventData&gt;</code>](#IEventData) \| <code>void</code>
     * [.onUnavailable([handler])](#WalletButtons+onUnavailable)
     * [.onUpdate([handler])](#WalletButtons+onUpdate)
     * [.onPaymentSuccessful([handler])](#WalletButtons+onPaymentSuccessful)
     * [.onPaymentInReview([handler])](#WalletButtons+onPaymentInReview)
     * [.onPaymentError([handler])](#WalletButtons+onPaymentError)
     * [.onAuthTokensChanged([handler])](#WalletButtons+onAuthTokensChanged)
+    * [.onClick(handler)](#WalletButtons+onClick)
+    * [.onCheckoutOpen(handler)](#WalletButtons+onCheckoutOpen)
+    * [.onCheckoutClose(handler)](#WalletButtons+onCheckoutClose)
 
 <a name="new_WalletButtons_new" id="new_WalletButtons_new" href="#new_WalletButtons_new">&nbsp;</a>
 
@@ -233,6 +350,26 @@ Bear in mind that you must set an environment before calling `button.load()`.
 ```js
 button.setEnv('production', 'paydock.com');
 ```
+<a name="WalletButtons+enable" id="WalletButtons+enable" href="#WalletButtons+enable">&nbsp;</a>
+
+### walletButtons.enable()
+Current method can enable the payment button. This method is only supported for Flypay V2.
+
+**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
+**Example**  
+```js
+button.enable();
+```
+<a name="WalletButtons+disable" id="WalletButtons+disable" href="#WalletButtons+disable">&nbsp;</a>
+
+### walletButtons.disable()
+Current method can disable the payment button. This method is only supported for Flypay V2.
+
+**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
+**Example**  
+```js
+button.disable('production', 'paydock.com');
+```
 <a name="WalletButtons+close" id="WalletButtons+close" href="#WalletButtons+close">&nbsp;</a>
 
 ### walletButtons.close()
@@ -245,7 +382,7 @@ button.close();
 ```
 <a name="WalletButtons+on" id="WalletButtons+on" href="#WalletButtons+on">&nbsp;</a>
 
-### walletButtons.on(eventName, [cb]) ⇒ <code>Promise.&lt;IEventData&gt;</code> \| <code>void</code>
+### walletButtons.on(eventName, [cb]) ⇒ [<code>Promise.&lt;IEventData&gt;</code>](#IEventData) \| <code>void</code>
 Listen to events of button. `unavailable` returns no data, `paymentSuccessful` returns IWalletPaymentSuccessful
 for Stripe or full response for Flypay, and `paymentError` an error.
 
@@ -408,6 +545,63 @@ button.onAuthTokensChanged().then((eventData) => {
     console.log('Authentication tokens changed:', eventData);
 });
 ```
+<a name="WalletButtons+onClick" id="WalletButtons+onClick" href="#WalletButtons+onClick">&nbsp;</a>
+
+### walletButtons.onClick(handler)
+Registers a callback function to be invoked when the wallet button gets clicked.
+There are two operational modes supported, Synchronous and Asynchronous.
+When asynchronous operations need to occur on the callback handler, attaching the Promise via `attachResult` is required to have the wallet wait for a result.
+When synchronous operations occur on the callback handler, attaching a boolean result via `attachResult` is optional to control the execution flow.
+Note this is supported for Paypal, GooglePay and ApplePay wallet buttons at the moment.
+
+**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | <code>listener</code> | Function to be called when the wallet button is clicked. |
+
+**Example**  
+```js
+button.onClick((data) => {
+     performValidationLogic();
+});
+```
+<a name="WalletButtons+onCheckoutOpen" id="WalletButtons+onCheckoutOpen" href="#WalletButtons+onCheckoutOpen">&nbsp;</a>
+
+### walletButtons.onCheckoutOpen(handler)
+Registers a callback function to be invoked when the wallet checkout opens.
+Note this is supported for FlypayV2 wallet button at the moment.
+
+**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | <code>listener</code> | Function to be called when the wallet checkout opens. |
+
+**Example**  
+```js
+button.onCheckoutOpen((data) => {
+     console.log('Checkout opens');
+});
+```
+<a name="WalletButtons+onCheckoutClose" id="WalletButtons+onCheckoutClose" href="#WalletButtons+onCheckoutClose">&nbsp;</a>
+
+### walletButtons.onCheckoutClose(handler)
+Registers a callback function to be invoked when the wallet checkout closes.
+Note this is supported for FlypayV2 wallet button at the moment.
+
+**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | <code>listener</code> | Function to be called when the wallet checkout closes. |
+
+**Example**  
+```js
+button.onCheckoutClose(() => {
+     console.log('Wallet checkout closes');
+});
+```
 <a name="EVENT" id="EVENT" href="#EVENT">&nbsp;</a>
 
 ## EVENT : <code>object</code>
@@ -421,4 +615,5 @@ List of available event's name in the wallet button lifecycle
 | UPDATE | <code>string</code> | <code>&quot;update&quot;</code> | 
 | PAYMENT_SUCCESSFUL | <code>string</code> | <code>&quot;paymentSuccessful&quot;</code> | 
 | PAYMENT_ERROR | <code>string</code> | <code>&quot;paymentError&quot;</code> | 
+| ON_CLICK | <code>string</code> | <code>&quot;onClick&quot;</code> | 
 

package/examples/multi-html-widget/simple.html

@@ -16,7 +16,8 @@
 
 <div id="widget"></div>
 
-<script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
+<!-- <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script> -->
+<script src="../../bundles/widget.umd.js" ></script>
 
 <script>
 	var card = new paydock.Configuration('5c77d21fb8d0ce13df9bce3f');

package/package.json

@@ -104,7 +104,7 @@
     }
   },
   "name": "@paydock/client-sdk",
-  "version": "1.104.3-beta",
+  "version": "1.104.7-beta",
   "scripts": {
     "build:doc": "node docs/html/marked.js",
     "build:js": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
@@ -128,10 +128,14 @@
     "test": "run-s test:chromium",
     "tsc:cba": "tsc --project tsconfig.cba.json",
     "tsc:paydock": "tsc --project tsconfig.paydock.json",
-    "typecheck": "tsc -b"
+    "tidy:ci": "biome ci --no-errors-on-unmatched .",
+    "tidy:precommit": "biome ci --no-errors-on-unmatched --changed .",
+    "tidy": "biome check --apply --formatter-enabled=true --linter-enabled=true --organize-imports-enabled=true --no-errors-on-unmatched .",
+    "typecheck": "tsc --project tsconfig.json --noEmit"
   },
   "dependencies": {
     "@auspayplus/open-payments-checkout": "1.7.3",
+    "@newrelic/browser-agent": "^1.259.0",
     "@stripe/stripe-js": "^1.11.0"
   },
   "devDependencies": {
@@ -145,6 +149,7 @@
     "@babel/preset-env": "^7.24.0",
     "@babel/runtime": "^7.24.0",
     "@babel/runtime-corejs2": "^7.24.0",
+    "@biomejs/biome": "^1.7.3",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.1.0",
@@ -162,9 +167,10 @@
     "babelify": "^10.0.0",
     "base64-js": "^1.2.0",
     "browser-resolve": "^1.11.2",
-    "browserify": "^14.1.0",
+    "browserify": "^17.0.0",
     "browserify-istanbul": "^2.0.0",
     "buffer": "^5.0.5",
+    "dotenv": "^16.4.5",
     "fs": "0.0.2",
     "grunt": "^1.6.1",
     "grunt-cli": "^1.2.0",
@@ -187,33 +193,30 @@
     "karma-jasmine-ajax": "^0.1.13",
     "karma-mocha-reporter": "^2.2.2",
     "marked": "^4.0.14",
-    "npm-run-all": "^4.1.5",
+    "npm-run-all2": "^6.2.0",
     "process": "^0.11.9",
     "rimraf": "^5.0.5",
-    "rollup": "^4.13.0",
+    "rollup": "^4.17.2",
     "rollup-plugin-dts": "^6.1.0",
     "tsify": "^3.0.1",
     "tslib": "^2.6.2",
     "tslint": "^5.8.0",
-    "typescript": "^4.9.5",
+    "typescript": "^5.4.5",
     "zod": "^3.22.4"
   },
-  "overrides": {
-    "grunt-ts": {
-      "chokidar": {
-        "fsevents": {
-          "minimist": "^1.2.6"
-        }
-      }
-    }
+  "engines": {
+    "node": ">=16.0.0"
   },
   "license": "UNLICENSED",
   "keywords": [
     "client-sdk",
     "es2015",
+    "umd",
+    "cjs",
+    "esm",
     "paydock",
     "sdk",
-    "typeScript",
+    "typescript",
     "widget"
   ]
 }