@tap-payments/apple-pay-button 1.0.1 → 1.0.4

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Tap Payments
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Tap Payments
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,194 +1,194 @@
-# apple-pay-button
-
-Handling Apple Pay button in React and vanilla JS
-
-## Install
-
-This is a [React](https://reactjs.org/) module available through the
-[npm registry](https://www.npmjs.com/). Installation is done using the
-[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
-
-```console
-npm install @tap-payments/apple-pay-button
-```
-
----------------------------- OR -------------------------
-
-```console
-yarn add @tap-payments/apple-pay-button
-```
-
-## Examples
-
-### ES6
-
-```javascript
-import React from 'react'
-import { ApplePayButton, ButtonStyle, SupportedNetworks, Scope } from '@tap-payments/apple-pay-button'
-
-const App = () => {
-	return (
-		<ApplePayButton
-			// required (The public Key provided by Tap)
-			publicKey={'pk_test_xxxxxxxxxxxxxxxzh'}
-			// required
-			merchant={{
-				// required (The merchant domain name)
-				domain: 'example.com',
-				// optional (The merchant identifier provided by Tap)
-				id: '1xxxxx8'
-			}}
-			// required
-			transaction={{
-				// required (The amount to be charged)
-				amount: '12',
-				// required (The currency of the amount)
-				currency: 'KWD'
-			}}
-			// optional (The scope of the SDK and it can be one of these scopes:
-			// [TapToken,AppleToken], by default it is TapToken)
-			scope={Scope.TapToken}
-			// optional (The supported networks for the Apple Pay button and it
-			// can be one of these networks: [Mada,Visa,MasterCard], by default
-			// we bring all the supported networks from tap merchant configuration)
-			supportedNetworks={[SupportedNetworks.Mada, SupportedNetworks.Visa, SupportedNetworks.MasterCard]}
-			// optional (The style of the Apple Pay button and it can be one of
-			// these styles: [White,WhiteOutline,Black], by default it is WhiteOutline)
-			buttonStyle={ButtonStyle.WhiteOutline}
-			// optional (The billing contact information)
-			billingContact={{
-				// required
-				email: {
-					// required
-					address: 'test@gmail.com'
-				},
-				// required
-				name: {
-					// required
-					first: 'test',
-					// required
-					last: 'tester',
-					// optional
-					middle: 'test'
-				},
-				// required
-				phone: {
-					number: '10XXXXXX56',
-					code: '+20'
-				}
-			}}
-			// optional (A callback function that will be called when you cancel
-			// the payment process)
-			onCancel={() => console.log('cancelled')}
-			// optional (A callback function that will be called when you have an error)
-			onError={(err) => console.error(err)}
-			// optional (A async function that will be called after creating the token
-			// successfully)
-			onSuccess={async (token) => {
-				// do your stuff here...
-				console.log(token)
-			}}
-		/>
-	)
-}
-```
-
-### Vanilla JS
-
-```html
-<!DOCTYPE html>
-<html lang="en">
-	<head>
-		<meta charset="UTF-8" />
-		<meta http-equiv="X-UA-Compatible" content="IE=edge" />
-		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
-		<title>apple pay button</title>
-		<link rel="stylesheet" href="https://apple-pay-button.b-cdn.net/build-1.0.1/main.css" />
-		<script src="https://apple-pay-button.b-cdn.net/build-1.0.1/main.js"></script>
-	</head>
-	<body>
-		<div id="apple-pay-button"></div>
-		<script type="text/javascript">
-			const { renderApplePayButton, ButtonStyle, Scope, SupportedNetworks } = window.TapSDKs
-			renderApplePayButton(
-				{
-					// required
-					publicKey: 'pk_test_xxxxxxxxxxxxxxxzh',
-					// required
-					merchant: {
-						// required
-						domain: 'example.com'
-						// optional
-						// id: '123...'
-					},
-					// required
-					transaction: {
-						// required
-						currency: 'USD',
-						// required
-						amount: '100'
-					},
-					// optional
-					scope: Scope.TapToken,
-					// optional
-					buttonStyle: ButtonStyle.WhiteOutline,
-					// optional
-					supportedNetworks: [SupportedNetworks.Visa, SupportedNetworks.MasterCard],
-					// optional (The billing contact information)
-					billingContact: {
-						// required
-						email: {
-							// required
-							address: 'test@gmail.com'
-						},
-						// required
-						name: {
-							// required
-							first: 'test',
-							// required
-							last: 'tester',
-							// optional
-							middle: 'test'
-						},
-						// required
-						phone: {
-							number: '10XXXXXX56',
-							code: '+20'
-						}
-					},
-					// optional
-					onCancel: () => {
-						console.log('onCancel')
-					},
-					// optional
-					onError: (error) => {
-						console.log('onError', error)
-					},
-					// optional
-					onSuccess: async (data) => {
-						console.log('onSuccess', data)
-					}
-				},
-				'apple-pay-button'
-			)
-		</script>
-	</body>
-</html>
-```
-
-## Configurations
-
-| Name                 | Type                  | R/O        | Description                                                                |
-| -------------------- | --------------------- | ---------- | -------------------------------------------------------------------------- |
-| publicKey            | `string`              | `required` | The public Key provided by Tap                                             |
-| merchant.id          | `string`              | `optional` | The merchant identifier provided by Tap                                    |
-| merchant.domain      | `string`              | `required` | The merchant domain name                                                   |
-| transaction.amount   | `string`              | `required` | The amount to be charged                                                   |
-| transaction.currency | `string`              | `required` | The currency of the amount                                                 |
-| scope                | `Scope`               | `optional` | The scope of the SDK                                                       |
-| supportedNetworks    | `SupportedNetworks[]` | `optional` | The supported networks for the Apple Pay button                            |
-| buttonStyle          | `ButtonStyle`         | `optional` | The style of the Apple Pay button                                          |
-| billingContact       | `BillingContact`      | `optional` | The billing contact information                                            |
-| onCancel             | `function`            | `optional` | A callback function that will be called when you cancel the process        |
-| onError              | `function`            | `optional` | A callback function that will be called when you have an error             |
-| onSuccess            | `function`            | `optional` | A async function that will be called after creating the token successfully |
+# apple-pay-button
+
+Handling Apple Pay button in React and vanilla JS
+
+## Install
+
+This is a [React](https://reactjs.org/) module available through the
+[npm registry](https://www.npmjs.com/). Installation is done using the
+[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
+
+```console
+npm install @tap-payments/apple-pay-button
+```
+
+---------------------------- OR -------------------------
+
+```console
+yarn add @tap-payments/apple-pay-button
+```
+
+## Examples
+
+### ES6
+
+```javascript
+import React from 'react'
+import { ApplePayButton, ButtonStyle, SupportedNetworks, Scope } from '@tap-payments/apple-pay-button'
+
+const App = () => {
+	return (
+		<ApplePayButton
+			// required (The public Key provided by Tap)
+			publicKey={'pk_test_xxxxxxxxxxxxxxxzh'}
+			// required
+			merchant={{
+				// required (The merchant domain name)
+				domain: 'example.com',
+				// optional (The merchant identifier provided by Tap)
+				id: '1xxxxx8'
+			}}
+			// required
+			transaction={{
+				// required (The amount to be charged)
+				amount: '12',
+				// required (The currency of the amount)
+				currency: 'KWD'
+			}}
+			// optional (The scope of the SDK and it can be one of these scopes:
+			// [TapToken,AppleToken], by default it is TapToken)
+			scope={Scope.TapToken}
+			// optional (The supported networks for the Apple Pay button and it
+			// can be one of these networks: [Mada,Visa,MasterCard], by default
+			// we bring all the supported networks from tap merchant configuration)
+			supportedNetworks={[SupportedNetworks.Mada, SupportedNetworks.Visa, SupportedNetworks.MasterCard]}
+			// optional (The style of the Apple Pay button and it can be one of
+			// these styles: [White,WhiteOutline,Black], by default it is WhiteOutline)
+			buttonStyle={ButtonStyle.WhiteOutline}
+			// optional (The billing contact information)
+			billingContact={{
+				// required
+				email: {
+					// required
+					address: 'test@gmail.com'
+				},
+				// required
+				name: {
+					// required
+					first: 'test',
+					// required
+					last: 'tester',
+					// optional
+					middle: 'test'
+				},
+				// required
+				phone: {
+					number: '10XXXXXX56',
+					code: '+20'
+				}
+			}}
+			// optional (A callback function that will be called when you cancel
+			// the payment process)
+			onCancel={() => console.log('cancelled')}
+			// optional (A callback function that will be called when you have an error)
+			onError={(err) => console.error(err)}
+			// optional (A async function that will be called after creating the token
+			// successfully)
+			onSuccess={async (token) => {
+				// do your stuff here...
+				console.log(token)
+			}}
+		/>
+	)
+}
+```
+
+### Vanilla JS
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta http-equiv="X-UA-Compatible" content="IE=edge" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>apple pay button</title>
+		<link rel="stylesheet" href="https://apple-pay-button.b-cdn.net/build-0.0.8-test/main.css" />
+		<script src="https://apple-pay-button.b-cdn.net/build-0.0.8-test/main.js"></script>
+	</head>
+	<body>
+		<div id="apple-pay-button"></div>
+		<script type="text/javascript">
+			const { renderApplePayButton, ButtonStyle, Scope, SupportedNetworks } = window.TapSDKs
+			renderApplePayButton(
+				{
+					// required
+					publicKey: 'pk_test_xxxxxxxxxxxxxxxzh',
+					// required
+					merchant: {
+						// required
+						domain: 'example.com'
+						// optional
+						// id: '123...'
+					},
+					// required
+					transaction: {
+						// required
+						currency: 'USD',
+						// required
+						amount: '100'
+					},
+					// optional
+					scope: Scope.TapToken,
+					// optional
+					buttonStyle: ButtonStyle.WhiteOutline,
+					// optional
+					supportedNetworks: [SupportedNetworks.Visa, SupportedNetworks.MasterCard],
+					// optional (The billing contact information)
+					billingContact: {
+						// required
+						email: {
+							// required
+							address: 'test@gmail.com'
+						},
+						// required
+						name: {
+							// required
+							first: 'test',
+							// required
+							last: 'tester',
+							// optional
+							middle: 'test'
+						},
+						// required
+						phone: {
+							number: '10XXXXXX56',
+							code: '+20'
+						}
+					},
+					// optional
+					onCancel: () => {
+						console.log('onCancel')
+					},
+					// optional
+					onError: (error) => {
+						console.log('onError', error)
+					},
+					// optional
+					onSuccess: async (data) => {
+						console.log('onSuccess', data)
+					}
+				},
+				'apple-pay-button'
+			)
+		</script>
+	</body>
+</html>
+```
+
+## Configurations
+
+| Name                 | Type                  | R/O        | Description                                                                |
+| -------------------- | --------------------- | ---------- | -------------------------------------------------------------------------- |
+| publicKey            | `string`              | `required` | The public Key provided by Tap                                             |
+| merchant.id          | `string`              | `optional` | The merchant identifier provided by Tap                                    |
+| merchant.domain      | `string`              | `required` | The merchant domain name                                                   |
+| transaction.amount   | `string`              | `required` | The amount to be charged                                                   |
+| transaction.currency | `string`              | `required` | The currency of the amount                                                 |
+| scope                | `Scope`               | `optional` | The scope of the SDK                                                       |
+| supportedNetworks    | `SupportedNetworks[]` | `optional` | The supported networks for the Apple Pay button                            |
+| buttonStyle          | `ButtonStyle`         | `optional` | The style of the Apple Pay button                                          |
+| billingContact       | `BillingContact`      | `optional` | The billing contact information                                            |
+| onCancel             | `function`            | `optional` | A callback function that will be called when you cancel the process        |
+| onError              | `function`            | `optional` | A callback function that will be called when you have an error             |
+| onSuccess            | `function`            | `optional` | A async function that will be called after creating the token successfully |

package/build/@types/index.d.ts

@@ -1,73 +1,82 @@
-import { Scope, ButtonStyle, MerchantCapabilities, SupportedNetworks } from '../constants';
-export interface ApplePayRequestData {
-    countryCode: string;
-    currencyCode: string;
-    merchantCapabilities: Array<typeof MerchantCapabilities[keyof typeof MerchantCapabilities]>;
-    supportedNetworks: Array<typeof SupportedNetworks[keyof typeof SupportedNetworks]>;
-    billingContact?: {
-        phoneNumber: string;
-        emailAddress: string;
-        givenName: string;
-        familyName: string;
-    };
-    total: {
-        label: string;
-        amount: number;
-    };
-}
-export interface ApplePayButtonProps {
-    publicKey: string;
-    merchant: {
-        id?: string;
-        domain: string;
-    };
-    scope?: typeof Scope[keyof typeof Scope];
-    supportedNetworks?: Array<typeof SupportedNetworks[keyof typeof SupportedNetworks]>;
-    buttonStyle?: typeof ButtonStyle[keyof typeof ButtonStyle];
-    billingContact?: {
-        name: {
-            first: string;
-            middle?: string;
-            last: string;
-        };
-        email: {
-            address: string;
-        };
-        phone: {
-            code: string;
-            number: string;
-        };
-    };
-    transaction: {
-        amount: string;
-        currency: string;
-    };
-    onCancel?: () => void;
-    onError?: (error: any) => void;
-    onSuccess?: (data: Record<string, any>) => Promise<void>;
-}
-export interface MerchantResponse {
-    id: string;
-    name: string;
-    country_code: string;
-    session_token: string;
-    [other: string]: string;
-}
-export interface PaymentMethod {
-    id: string;
-    image: string;
-    name: string;
-    payment_type: string;
-    supported_card_brands: Array<typeof SupportedNetworks[keyof typeof SupportedNetworks]>;
-    supported_currencies: string[];
-}
-export interface PaymentOptionsResponse {
-    id: string;
-    country: string;
-    currency: string;
-    payment_methods: PaymentMethod[];
-}
-export interface ProfileResponse {
-    merchant: MerchantResponse;
-    payment_options: PaymentOptionsResponse;
-}
+import { Scope, ButtonStyle, MerchantCapabilities, SupportedNetworks, ButtonType, Locale, Environment } from '../constants';
+export interface ApplePayRequestData {
+    countryCode: string;
+    currencyCode: string;
+    merchantCapabilities: Array<typeof MerchantCapabilities[keyof typeof MerchantCapabilities]>;
+    supportedNetworks: Array<typeof SupportedNetworks[keyof typeof SupportedNetworks]>;
+    billingContact?: {
+        phoneNumber: string;
+        emailAddress: string;
+        givenName: string;
+        familyName: string;
+    };
+    total: {
+        label: string;
+        amount: number;
+    };
+}
+export interface ApplePayButtonProps {
+    publicKey: string;
+    environment: typeof Environment[keyof typeof Environment];
+    merchantIdentifier: string;
+    merchant: {
+        id?: string;
+        domain: string;
+    };
+    scope?: typeof Scope[keyof typeof Scope];
+    supportedNetworks?: Array<typeof SupportedNetworks[keyof typeof SupportedNetworks]>;
+    buttonStyle?: typeof ButtonStyle[keyof typeof ButtonStyle];
+    billingContact?: {
+        name: {
+            first: string;
+            middle?: string;
+            last: string;
+        };
+        email: {
+            address: string;
+        };
+        phone: {
+            code: string;
+            number: string;
+        };
+    };
+    transaction: {
+        amount: string;
+        currency: string;
+    };
+    onCancel?: () => void;
+    onError?: (error: any) => void;
+    onSuccess?: (data: Record<string, any>) => Promise<void>;
+    onClick?: () => void;
+    onReady?: () => void;
+    metaData?: MetaData;
+    type?: typeof ButtonType[keyof typeof ButtonType];
+    locale?: typeof Locale[keyof typeof Locale];
+    debug?: boolean;
+}
+export interface MerchantResponse {
+    id: string;
+    name: string;
+    country_code: string;
+    session_token: string;
+    [other: string]: string;
+}
+export interface PaymentMethod {
+    id: string;
+    image: string;
+    name: string;
+    payment_type: string;
+    supported_card_brands: Array<typeof SupportedNetworks[keyof typeof SupportedNetworks]>;
+    supported_currencies: string[];
+}
+export interface PaymentOptionsResponse {
+    id: string;
+    country: string;
+    currency: string;
+    payment_methods: PaymentMethod[];
+}
+export interface MetaData {
+    merchant: MerchantResponse;
+    payment_options: PaymentOptionsResponse;
+    headers: Record<string, string>;
+}

package/build/@types/index.js

@@ -1 +1 @@
-export {};
+export {};

package/build/api/app.service.d.ts

@@ -1,11 +1,23 @@
-import { MerchantResponse, ApplePayRequestData, ProfileResponse } from '../@types';
-import BaseService from './base';
-declare class APPService extends BaseService {
-    constructor();
-    init(publicKey: string, merchantId?: string): Promise<ProfileResponse>;
-    appleSession(merchant: MerchantResponse, validationURL: string, merchantRegisteredDomain: string): Promise<any>;
-    tapTokenization(applePaymentData: Record<string, string>, merchant: MerchantResponse): Promise<any>;
-    createCharge(publicKey: string, merchant: MerchantResponse, request: ApplePayRequestData, cardToken: string): Promise<import("axios").AxiosResponse<any, any>>;
-}
-declare const appService: APPService;
-export default appService;
+import { MerchantResponse, ApplePayButtonProps } from '../@types';
+import BaseService from './base';
+declare class APPService extends BaseService {
+    private baseUrl;
+    private env;
+    constructor();
+    setEnv(env: ApplePayButtonProps['environment']): void;
+    setBaseUrl(): void;
+    getHeaderPublicKey(): "-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8AX++RtxPZFtns4XzXFlDIxPBh0umN4qRXZaKDIlb6a3MknaB7psJWmf2l+e4Cfh9b5tey/+rZqpQ065eXTZfGCAuBLt+fYLQBhLfjRpk8S6hlIzc1Kdjg65uqzMwcTd0p7I4KLwHk1I0oXzuEu53fU1LSZhWp4Mnd6wjVgXAsQIDAQAB\n-----END PUBLIC KEY-----" | "" | "-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC9hSRms7Ir1HmzdZxGXFYgmpi3\nez7VBFje0f8wwrxYS9oVoBtN4iAt0DOs3DbeuqtueI31wtpFVUMGg8W7R0SbtkZd\nGzszQNqt/wyqxpDC9q+97XdXwkWQFA72s76ud7eMXQlsWKsvgwhY+Ywzt0KlpNC3\nHj+N6UWFOYK98Xi+sQIDAQAB\n-----END PUBLIC KEY-----" | "-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCi9W5jyTvA4Iwv3V5sfNQ7VdSz\n7WqwBbnWFbIUL/GjaaE93mvDv4zbgRSznHaHQPH6pxrMhMh0tV58njkvjHvQ/tvg\npwM8SemNPKEEAPl69tnMvCrJRPh2dWL3OHY8yCW4c38Hyx4fy56Zd5cdoVWfCReu\njCsvASLGz+cfRrj2swIDAQAB\n-----END PUBLIC KEY-----";
+    setBrowserHeaders({ locale, pk, domain }: {
+        locale: string;
+        pk: string;
+        domain: string;
+    }): Promise<void>;
+    checkoutProfile(merchantId?: string): Promise<{
+        merchant: any;
+        payment_options: any;
+    }>;
+    appleSession(merchant: MerchantResponse, validationURL: string, merchantRegisteredDomain: string, merchantIdentifier: string): Promise<any>;
+    tapTokenization(applePaymentData: Record<string, string>): Promise<any>;
+}
+declare const appService: APPService;
+export default appService;