@tap-payments/apple-pay-button 1.0.6 → 1.0.7-test

package/README.md

@@ -25,89 +25,109 @@ yarn add @tap-payments/apple-pay-button
 ```javascript
 import React from 'react'
 import {
-	ApplePayButton,
-	ButtonStyle,
-	SupportedNetworks,
-	Scope,
-	Environment,
-	ButtonType,
-	Locale
+ ApplePayButton,
+ ThemeMode,
+ SupportedNetworks,
+ Scope,
+ Environment,
+ Locale,
+ ButtonType,
+ Edges
 } from '@tap-payments/apple-pay-button'
 
 const App = () => {
-	return (
-		<ApplePayButton
-			// required (The public Key provided by Tap)
-			publicKey={'pk_test_xxxxxxxxxxxxxxxzh'}
-			// optional (The environment of the SDK and it can be one of these Environment)
-			environment={Environment.Development}
-			// optional (to enable the debug mode)
-			debug
-			// required (The merchant identifier provided by Tap)
-			merchantIdentifier='merchant.tap.applepay.test'
-			// 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 locale of the Apple Pay button and it can be one of these locales)
-			locale={Locale.EN}
-			// optional (The type of the Apple Pay button and it can be one of these types)
-			type={ButtonType.PLAIN}
-			// 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)
-			}}
-		/>
-	)
+ 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')
+   }}
+  />
+ )
 }
 ```
 
@@ -121,79 +141,69 @@ const App = () => {
 		<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.6/main.css" />
-		<script src="https://apple-pay-button.b-cdn.net/build-1.0.6/main.js"></script>
+		<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 { renderApplePayButton, ButtonStyle, Scope, SupportedNetworks, Locale, ButtonType } = window.TapSDKs
-			renderApplePayButton(
+			const { render, ThemeMode, SupportedNetworks, Scope, Environment, Locale, ButtonType, Edges } =
+				window.TapApplepaySDK
+			render(
 				{
-					// required
-					publicKey: 'pk_test_xxxxxxxxxxxxxxxzh',
-					// optional (The environment of the SDK and it can be one of these Environment)
+					publicKey: 'pk_test_7xxxxxxxxx',
 					environment: Environment.Development,
-					// optional (to enable the debug mode)
-					debug: true,
-					// required (The merchant identifier provided by Tap)
-					merchantIdentifier: 'merchant.tap.applepay.test',
+					scope: Scope.TapToken,
 					merchant: {
-						// required
-						domain: 'example.com'
-						// optional
-						// id: '123...'
+						domain: window.location.hostname,
+						id: 'merchant_xxxxxxxxxx'
 					},
-					// required
 					transaction: {
-						// required
-						currency: 'USD',
-						// required
-						amount: '100'
+						currency: 'SAR',
+						amount: '3'
 					},
-					// optional
-					scope: Scope.TapToken,
-					// optional
-					buttonStyle: ButtonStyle.WhiteOutline,
-					// optional (The locale of the Apple Pay button and it can be one of these locales)
-					locale: Locale.EN,
-					// optional (The type of the Apple Pay button and it can be one of these types)
-					type: ButtonType.PLAIN,
-					// 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'
+					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'
+							}
 						}
 					},
-					// optional
-					onCancel: () => {
+					interface: {
+						locale: Locale.EN,
+						theme: ThemeMode.DARK,
+						type: ButtonType.BUY,
+						edges: Edges.CURVED
+					},
+					onCancel: async () => {
 						console.log('onCancel')
 					},
-					// optional
-					onError: (error) => {
+					onError: async (error) => {
 						console.log('onError', error)
 					},
-					// optional
 					onSuccess: async (data) => {
 						console.log('onSuccess', data)
+					},
+					onReady: async () => {
+						console.log('onReady')
 					}
 				},
 				'apple-pay-button'
@@ -205,22 +215,26 @@ const App = () => {
 
 ## Configurations
 
-| Name                 | Type                  | R/O        | Description                                                                      |
-| -------------------- | --------------------- | ---------- | -------------------------------------------------------------------------------- |
-| publicKey            | `string`              | `required` | The public Key provided by Tap                                                   |
-| environment          | `Environment`         | `optional` | The environment of the SDK and it can be one of these environments `Environment` |
-| debug                | `boolean`             | `optional` | To enable the debug mode                                                         |
-| merchantIdentifier   | `string`              | `required` | The merchant identifier 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                                                |
-| locale               | `Locale`              | `optional` | The locale of the Apple Pay button                                               |
-| type                 | `ButtonType`          | `optional` | The type 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       |
+| 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,110 @@
+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 ApplePayPaymentTokenContext {
+    merchantIdentifier: string;
+    externalIdentifier: string;
+    merchantName: string;
+    merchantDomain?: string;
+    amount: string;
+}
+export interface ApplePayPaymentMethod {
+    displayName?: string;
+    network?: string;
+    type?: ApplePayPaymentMethodType;
+    billingContact?: ApplePayPaymentContact;
+}
+export interface ApplePayAutomaticReloadPaymentRequest {
+    paymentDescription: string;
+    automaticReloadBilling: ApplePayLineItem;
+    billingAgreement?: string;
+    managementURL: string;
+    tokenNotificationURL?: string;
+}
+export interface ApplePayRecurringPaymentRequest {
+    paymentDescription: string;
+    regularBilling: ApplePayLineItem;
+    trialBilling?: ApplePayLineItem;
+    billingAgreement?: string;
+    managementURL: string;
+    tokenNotificationURL?: string;
+}
+export interface ApplePayDeferredPaymentRequest {
+    billingAgreement?: string;
+    deferredBilling: ApplePayLineItem;
+    freeCancellationDate?: Date;
+    freeCancellationDateTimeZone?: string;
+    managementURL: string;
+    paymentDescription: string;
+    tokenNotificationURL?: string;
+}
+export interface ApplePayError {
+    code: string;
+    contactField: string;
+    message: string;
+}
+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[];
+    newMultiTokenContexts?: ApplePayPaymentTokenContext[];
+    newAutomaticReloadPaymentRequest?: ApplePayAutomaticReloadPaymentRequest;
+    newRecurringPaymentRequest?: ApplePayRecurringPaymentRequest;
+    newDeferredPaymentRequest?: ApplePayDeferredPaymentRequest;
+    errors?: ApplePayError[];
+    newShippingMethods?: ApplePayShippingMethod[];
+}
+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[];
+    lineItems?: ApplePayLineItem[];
+}

package/build/@types/ApplePaySession.js

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

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

@@ -1,57 +1,86 @@
-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;
+import { Scope, SupportedNetworks, ButtonType, Locale, Environment, ThemeMode, Edges } from '../constants';
+import { ApplePayPaymentContact, ApplePayPaymentMethod, ApplePayShippingMethod, ApplePayUpdateData, RequiredShippingContactField } from './ApplePaySession';
+export * from './ApplePaySession';
+export interface Interface {
+    locale?: typeof Locale[keyof typeof Locale];
+    theme?: typeof ThemeMode[keyof typeof ThemeMode];
+    edges?: typeof Edges[keyof typeof Edges];
+    type?: typeof ButtonType[keyof typeof ButtonType];
+}
+export interface Customer {
+    id?: string;
+    name?: {
+        lang: typeof Locale[keyof typeof Locale];
+        first: string;
+        last: string;
+        middle?: string;
+    }[];
+    contact?: {
+        email?: string;
+        phone?: {
+            countryCode: string;
+            number: string;
+        };
     };
 }
+export interface Acceptance {
+    supportedBrands?: Array<typeof SupportedNetworks[keyof typeof SupportedNetworks]>;
+    supportedCards?: Array<string>;
+    supportedCardsWithAuthentications?: Array<string>;
+}
+export interface Transaction {
+    amount: string;
+    currency: string;
+    couponCode?: string;
+    shipping?: ApplePayShippingMethod[];
+    items?: Array<{
+        type?: 'final' | 'pending';
+        label?: string;
+        amount?: string;
+        paymentTiming?: 'immediate' | 'recurring' | 'deferred' | 'automaticReload';
+        scheduledPayment?: {
+            recurringStartDate?: Date;
+            recurringEndDate?: Date;
+            recurringIntervalUnit?: 'year' | 'month' | 'day' | 'hour' | 'minute';
+            recurringIntervalCount?: number;
+        };
+        deferredPayment?: {
+            deferredPaymentDate?: Date;
+        };
+        automaticReloadPayment?: {
+            thresholdAmount?: string;
+        };
+    }>;
+}
+export interface Features {
+    shippingContactFields?: Array<RequiredShippingContactField>;
+    supportsCouponCode?: boolean;
+}
 export interface ApplePayButtonProps {
+    scope?: typeof Scope[keyof typeof Scope];
     publicKey: string;
     environment: typeof Environment[keyof typeof Environment];
-    merchantIdentifier: string;
     merchant: {
-        id?: string;
+        id: string;
         domain: string;
+        identifier?: 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;
-    };
+    interface?: Interface;
+    customer?: Customer;
+    acceptance: Acceptance;
+    transaction: Transaction;
+    features: Features;
     onCancel?: () => void;
     onError?: (error: any) => void;
     onSuccess?: (data: Record<string, any>) => Promise<void>;
     onClick?: () => void;
     onReady?: () => void;
+    onMerchantValidation?: (status: 'initiated' | 'completed' | 'error') => void;
+    onShippingMethodSelected?: (shippingMethod: ApplePayShippingMethod) => Promise<ApplePayUpdateData>;
+    onShippingContactSelected?: (shippingContact: ApplePayPaymentContact) => Promise<ApplePayUpdateData>;
+    onPaymentMethodSelected?: (paymentMethod: ApplePayPaymentMethod) => Promise<ApplePayUpdateData>;
+    onCouponChanged?: (couponCode: string) => Promise<ApplePayUpdateData>;
     metaData?: MetaData;
-    type?: typeof ButtonType[keyof typeof ButtonType];
-    locale?: typeof Locale[keyof typeof Locale];
     debug?: boolean;
 }
 export interface MerchantResponse {
@@ -80,3 +109,32 @@ export interface MetaData {
     payment_options: PaymentOptionsResponse;
     headers: Record<string, string>;
 }
+export interface CheckoutProfileRequest {
+    currency: string;
+    merchant_id: string;
+    total_amount: number;
+    order: {
+        amount: number;
+        currency: string;
+        customer?: {
+            id?: string;
+            email?: string;
+            first_name?: string;
+            last_name?: string;
+            phone?: {
+                country_code: string;
+                number: string;
+            };
+        };
+        items: {
+            quantity: number;
+            amount: number;
+            currency: string;
+            name: string;
+            requiresShipping: string;
+        }[];
+        merchant: {
+            id: string;
+        };
+    };
+}

package/build/@types/index.js

@@ -1 +1 @@
-export {};
+export * from './ApplePaySession';