@tap-payments/apple-pay-button 1.0.0 → 1.0.1-test

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,240 @@
-# 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.0/main.css" />
-		<script src="https://apple-pay-button.b-cdn.net/build-1.0.0/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,
+ ThemeMode,
+ SupportedNetworks,
+ Scope,
+ Environment,
+ Locale,
+ ButtonType,
+ Edges
+} from '@tap-payments/apple-pay-button'
+
+const App = () => {
+ return (
+  <ApplePayButton
+   // The public Key provided by Tap
+   publicKey={'pk_test_xxxxxxxxxxxxxxxzh'}
+   //The environment of the SDK and it can be one of these environments
+   environment={Environment.Development}
+   //to enable the debug mode
+   debug
+   merchant={{
+    //  The merchant domain name
+    domain: 'example.com',
+    //  The merchant identifier provided by Tap
+    id: '1xxxxx8'
+   }}
+   transaction={{
+    // The amount to be charged
+    amount: '12',
+    // The currency of the amount
+    currency: 'KWD'
+   }}
+   // The scope of the SDK and it can be one of these scopes:
+   // [TapToken,AppleToken], by default it is TapToken)
+   scope={Scope.TapToken}
+   acceptance={{
+    // 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
+    supportedBrands: [SupportedNetworks.Mada, SupportedNetworks.Visa, SupportedNetworks.MasterCard]
+    supportedCards : ["DEBIT","CREDIT"],
+         supportedCardsWithAuthentications : ["3DS","EMV"]
+   }}
+   // The billing contact information
+   customer={{
+    id: 'cus_xxx',
+    name: [
+     {
+      //"en or ar",
+      lang: Locale.EN,
+      // "First name of the customer.",
+      first: 'test',
+      //"Last name of the customer.",
+      last: 'tester',
+      // "Middle name of the customer.",
+      middle: 'test'
+     }
+    ],
+    // Defines the contact details for the customer & to be used in creating the billing contact info in Apple pay request
+    contact: {
+     //"The customer's email",
+     email: 'test@gmail.com',
+     //"The customer's phone number"
+     phone: {
+      //"The customer's country code",
+      countryCode: '+20',
+      //"The customer's phone number
+      number: '10XXXXXX56'
+     }
+    }
+   }}
+   //for styling button
+   interface={{
+    //The locale of the Apple Pay button and it can be one of these locales:[EN,AR]
+    locale: Locale.EN,
+    // The theme of the Apple Pay button and it can be one of
+    // these values : [light,Dark], by default it is detected from user device
+    theme: ThemeMode.DARK,
+    // The type of the Apple Pay
+    type: ButtonType.BUY,
+    // The border of the Apple Pay button and it can be one of these values:[curved,straight]
+    edges: Edges.CURVED
+   }}
+   // 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)
+   }}
+   // optional (A callback function that will be called when you button is clickable)
+   onReady={() => {
+    console.log('Ready')
+   }}
+   // optional (A callback function that will be called when the button clicked)
+   onClick={() => {
+    console.log('Clicked')
+   }}
+  />
+ )
+}
+```
+
+### 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://tap-sdks.b-cdn.net/apple-pay/build-1.0.19/main.css" />
+		<script src="https://tap-sdks.b-cdn.net/apple-pay/build-1.0.19/main.js"></script>
+	</head>
+
+	<body>
+		<div id="apple-pay-button"></div>
+		<script type="text/javascript">
+			const { render, ThemeMode, SupportedNetworks, Scope, Environment, Locale, ButtonType, Edges } =
+				window.TapApplepaySDK
+			render(
+				{
+					publicKey: 'pk_test_7xxxxxxxxx',
+					environment: Environment.Development,
+					scope: Scope.TapToken,
+					merchant: {
+						domain: window.location.hostname,
+						id: 'merchant_xxxxxxxxxx'
+					},
+					transaction: {
+						currency: 'SAR',
+						amount: '3'
+					},
+					acceptance: {
+						supportedBrands: [SupportedNetworks.Mada, SupportedNetworks.Visa, SupportedNetworks.MasterCard],
+						supportedCards: ['DEBIT', 'CREDIT'],
+						supportedCardsWithAuthentications: ['3DS', 'EMV']
+					},
+
+					customer: {
+						id: 'cus_xxx',
+						name: [
+							{
+								locale: 'en',
+								first: 'test',
+								last: 'tester',
+								middle: 'test'
+							}
+						],
+						contact: {
+							email: 'test@gmail.com',
+							phone: {
+								number: '10XXXXXX56',
+								countryCode: '+20'
+							}
+						}
+					},
+					interface: {
+						locale: Locale.EN,
+						theme: ThemeMode.DARK,
+						type: ButtonType.BUY,
+						edges: Edges.CURVED
+					},
+					onCancel: async () => {
+						console.log('onCancel')
+					},
+					onError: async (error) => {
+						console.log('onError', error)
+					},
+					onSuccess: async (data) => {
+						console.log('onSuccess', data)
+					},
+					onReady: async () => {
+						console.log('onReady')
+					}
+				},
+				'apple-pay-button'
+			)
+		</script>
+	</body>
+</html>
+```
+
+## Configurations
+
+| Name                                         | Type         | R/O        | Description                                                                                                |
+| -------------------------------------------- | ------------ | ---------- | ---------------------------------------------------------------------------------------------------------- |
+| publicKey                                    | `string`     | `required` | The public Key provided by Tap                                                                             |
+| environment                                  | `enum`       | `optional` | The environment of the SDK and it can be one of these environments `Environment`: [Development,Production] |
+| debug                                        | `boolean`    | `optional` | To enable the debug mode                                                                                   |
+| merchant.id                                  | `string`     | `required` | 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                                        | `enum`       | `optional` | The scope of the SDK                                                                                       |
+| acceptance.supportedBrands                   | `array`      | `optional` | The supported networks for the Apple Pay button                                                            |
+| acceptance.supportedCards                    | `array`      | `optional` | The supported cards for the Apple Pay button                                                               |
+| acceptance.supportedCardsWithAuthentications | `array`      | `optional` | The supported cards with authentications for the Apple Pay button                                          |
+| interface.theme                              | `enum`       | `optional` | The theme of the Apple Pay button                                                                          |
+| interface.locale                             | `Locale`     | `optional` | The locale of the Apple Pay button                                                                         |
+| interface.type                               | `ButtonType` | `optional` | The type of the Apple Pay button                                                                           |
+| interface.edges                              | `ButtonType` | `optional` | The border of the Apple Pay button                                                                         |
+| customer                                     | `object`     | `optional` | The Customer details 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                                 |
+| onClick                                      | `function`   | `optional` | A callback function that will be called when the button clicked                                            |
+| onReady                                      | `function`   | `optional` | A callback function that will be called when you button is clickable                                       |

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

@@ -0,0 +1,67 @@
+import { MerchantCapabilities, SupportedNetworks } from '../constants';
+export declare type RequiredShippingContactField = 'postalAddress' | 'name' | 'phoneticName' | 'phone' | 'email';
+export declare type ApplePayPaymentMethodType = 'debit' | 'credit' | 'prepaid' | 'store';
+export interface ApplePayShippingMethod {
+    label: string;
+    detail: string;
+    amount: string;
+    identifier: string;
+}
+export interface ApplePayPaymentContact {
+    phoneNumber?: string;
+    emailAddress?: string;
+    givenName?: string;
+    familyName?: string;
+    phoneticGivenName?: string;
+    phoneticFamilyName?: string;
+    addressLines?: string[];
+    subLocality?: string;
+    locality?: string;
+    postalCode?: string;
+    subAdministrativeArea?: string;
+    administrativeArea?: string;
+    country?: string;
+    countryCode?: string;
+}
+export interface ApplePayPaymentMethod {
+    displayName?: string;
+    network?: string;
+    type?: ApplePayPaymentMethodType;
+    billingContact?: ApplePayPaymentContact;
+}
+export interface ApplePayLineItem {
+    type?: 'final' | 'pending';
+    label?: string;
+    amount?: string;
+    paymentTiming?: 'immediate' | 'recurring' | 'deferred' | 'automaticReload';
+    recurringPaymentStartDate?: Date;
+    recurringPaymentIntervalUnit?: 'year' | 'month' | 'day' | 'hour' | 'minute';
+    recurringPaymentIntervalCount?: number;
+    recurringPaymentEndDate?: Date;
+    deferredPaymentDate?: Date;
+    automaticReloadPaymentThresholdAmount?: string;
+}
+export interface ApplePayUpdateData {
+    newTotal: ApplePayLineItem;
+    newLineItems?: ApplePayLineItem[];
+}
+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;
+    };
+    requiredShippingContactFields?: Array<RequiredShippingContactField>;
+    supportsCouponCode?: boolean;
+    couponCode?: string;
+    shippingMethods?: ApplePayShippingMethod[];
+}

package/build/@types/ApplePaySession.js

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