'use strict';
var frameService = require('../../lib/frame-service/external');
var BraintreeError = require('../../lib/braintree-error');
var convertToBraintreeError = require('../../lib/convert-to-braintree-error');
var useMin = require('../../lib/use-min');
var once = require('../../lib/once');
var VERSION = process.env.npm_package_version;
var constants = require('../shared/constants');
var INTEGRATION_TIMEOUT_MS = require('../../lib/constants').INTEGRATION_TIMEOUT_MS;
var analytics = require('../../lib/analytics');
var methods = require('../../lib/methods');
var deferred = require('../../lib/deferred');
var errors = require('../shared/errors');
var convertMethodsToError = require('../../lib/convert-methods-to-error');
var querystring = require('../../lib/querystring');
var Promise = require('../../lib/promise');
var wrapPromise = require('@braintree/wrap-promise');
/**
* @typedef {object} PayPal~tokenizePayload
* @property {string} nonce The payment method nonce.
* @property {string} type The payment method type, always `PayPalAccount`.
* @property {object} details Additional PayPal account details.
* @property {string} details.email User's email address.
* @property {string} details.payerId User's payer ID, the unique identifier for each PayPal account.
* @property {string} details.firstName User's given name.
* @property {string} details.lastName User's surname.
* @property {?string} details.countryCode User's 2 character country code.
* @property {?string} details.phone User's phone number (e.g. 555-867-5309).
* @property {?object} details.shippingAddress User's shipping address details, only available if shipping address is enabled.
* @property {string} details.shippingAddress.recipientName Recipient of postage.
* @property {string} details.shippingAddress.line1 Street number and name.
* @property {string} details.shippingAddress.line2 Extended address.
* @property {string} details.shippingAddress.city City or locality.
* @property {string} details.shippingAddress.state State or region.
* @property {string} details.shippingAddress.postalCode Postal code.
* @property {string} details.shippingAddress.countryCode 2 character country code (e.g. US).
* @property {?object} details.billingAddress User's billing address details.
* Not available to all merchants; [contact PayPal](https://developers.braintreepayments.com/support/guides/paypal/setup-guide#contacting-paypal-support) for details on eligibility and enabling this feature.
* Alternatively, see `shippingAddress` above as an available client option.
* @property {string} details.billingAddress.line1 Street number and name.
* @property {string} details.billingAddress.line2 Extended address.
* @property {string} details.billingAddress.city City or locality.
* @property {string} details.billingAddress.state State or region.
* @property {string} details.billingAddress.postalCode Postal code.
* @property {string} details.billingAddress.countryCode 2 character country code (e.g. US).
* @property {?object} creditFinancingOffered This property will only be present when the customer pays with PayPal Credit.
* @property {object} creditFinancingOffered.totalCost This is the estimated total payment amount including interest and fees the user will pay during the lifetime of the loan.
* @property {string} creditFinancingOffered.totalCost.value An amount defined by [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm) for the given currency.
* @property {string} creditFinancingOffered.totalCost.currency 3 letter currency code as defined by [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
* @property {number} creditFinancingOffered.term Length of financing terms in months.
* @property {object} creditFinancingOffered.monthlyPayment This is the estimated amount per month that the customer will need to pay including fees and interest.
* @property {string} creditFinancingOffered.monthlyPayment.value An amount defined by [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm) for the given currency.
* @property {string} creditFinancingOffered.monthlyPayment.currency 3 letter currency code as defined by [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
* @property {object} creditFinancingOffered.totalInterest Estimated interest or fees amount the payer will have to pay during the lifetime of the loan.
* @property {string} creditFinancingOffered.totalInterest.value An amount defined by [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm) for the given currency.
* @property {string} creditFinancingOffered.totalInterest.currency 3 letter currency code as defined by [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
* @property {boolean} creditFinancingOffered.payerAcceptance Status of whether the customer ultimately was approved for and chose to make the payment using the approved installment credit.
* @property {boolean} creditFinancingOffered.cartAmountImmutable Indicates whether the cart amount is editable after payer's acceptance on PayPal side.
*
*/
/**
* @typedef {object} PayPal~tokenizeReturn
* @property {Function} close A handle to close the PayPal checkout flow.
* @property {Function} focus A handle to focus the PayPal checkout flow. Note that some browsers (notably iOS Safari) do not support focusing popups. Firefox requires the focus call to occur as the result of a user interaction, such as a button click.
*/
/**
* @class
* @param {object} options see {@link module:braintree-web/paypal.create|paypal.create}
* @classdesc This class represents a PayPal component. Instances of this class can open a PayPal window for authenticating a PayPal account. Any additional UI, such as disabling the page while authentication is taking place, is up to the developer.
*
* This component has been deprecated in favor of the {@link PayPalCheckout|PayPal Checkout component}, which provides a fully managed UI. New features will not be added to this component.
* @description <strong>Do not use this constructor directly. Use {@link module:braintree-web/paypal.create|braintree-web.paypal.create} instead.</strong>
*/
function PayPal(options) {
this._client = options.client;
this._assetsUrl = options.client.getConfiguration().gatewayConfiguration.paypal.assetsUrl + '/web/' + VERSION;
this._isDebug = options.client.getConfiguration().isDebug;
this._loadingFrameUrl = this._assetsUrl + '/html/paypal-landing-frame' + useMin(this._isDebug) + '.html';
this._authorizationInProgress = false;
}
PayPal.prototype._initialize = function () {
var self = this;
var client = this._client;
var failureTimeout = setTimeout(function () {
analytics.sendEvent(client, 'paypal.load.timed-out');
}, INTEGRATION_TIMEOUT_MS);
return new Promise(function (resolve) {
frameService.create({
name: constants.LANDING_FRAME_NAME,
dispatchFrameUrl: self._assetsUrl + '/html/dispatch-frame' + useMin(self._isDebug) + '.html',
openFrameUrl: self._loadingFrameUrl
}, function (service) {
self._frameService = service;
clearTimeout(failureTimeout);
analytics.sendEvent(client, 'paypal.load.succeeded');
resolve(self);
});
});
};
/**
* Launches the PayPal login flow and returns a nonce payload. Only one PayPal login flow should be active at a time. One way to achieve this is to disable your PayPal button while the flow is open.
* @public
* @param {object} options All tokenization options for the PayPal component.
* @param {string} options.flow Set to 'checkout' for one-time payment flow, or 'vault' for Vault flow. If 'vault' is used with a client token generated with a customer id, the PayPal account will be added to that customer as a saved payment method.
* @param {string} [options.intent=authorize]
* * `authorize` - Submits the transaction for authorization but not settlement.
* * `order` - Validates the transaction without an authorization (i.e. without holding funds). Useful for authorizing and capturing funds up to 90 days after the order has been placed. Only available for Checkout flow.
* * `sale` - Payment will be immediately submitted for settlement upon creating a transaction.
* @param {boolean} [options.offerCredit=false] Offers PayPal Credit as the default funding instrument for the transaction. If the customer isn't pre-approved for PayPal Credit, they will be prompted to apply for it.
* @param {string} [options.useraction]
* Changes the call-to-action in the PayPal flow. By default the final button will show the localized
* word for "Continue" and implies that the final amount billed is not yet known.
*
* Setting this option to `commit` changes the button text to "Pay Now" and page text will convey to
* the user that billing will take place immediately.
* @param {string|number} [options.amount] The amount of the transaction. Required when using the Checkout flow.
* @param {string} [options.currency] The currency code of the amount, such as 'USD'. Required when using the Checkout flow.
* @param {string} [options.displayName] The merchant name displayed inside of the PayPal lightbox; defaults to the company name on your Braintree account
* @param {string} [options.locale=en_US] Use this option to change the language, links, and terminology used in the PayPal flow. This locale will be used unless the buyer has set a preferred locale for their account. If an unsupported locale is supplied, a fallback locale (determined by buyer preference or browser data) will be used and no error will be thrown.
*
* Supported locales are:
* `da_DK`,
* `de_DE`,
* `en_AU`,
* `en_GB`,
* `en_US`,
* `es_ES`,
* `fr_CA`,
* `fr_FR`,
* `id_ID`,
* `it_IT`,
* `ja_JP`,
* `ko_KR`,
* `nl_NL`,
* `no_NO`,
* `pl_PL`,
* `pt_BR`,
* `pt_PT`,
* `ru_RU`,
* `sv_SE`,
* `th_TH`,
* `zh_CN`,
* `zh_HK`,
* and `zh_TW`.
*
* @param {boolean} [options.enableShippingAddress=false] Returns a shipping address object in {@link PayPal#tokenize}.
* @param {object} [options.shippingAddressOverride] Allows you to pass a shipping address you have already collected into the PayPal payment flow.
* @param {string} options.shippingAddressOverride.line1 Street address.
* @param {string} [options.shippingAddressOverride.line2] Street address (extended).
* @param {string} options.shippingAddressOverride.city City.
* @param {string} options.shippingAddressOverride.state State.
* @param {string} options.shippingAddressOverride.postalCode Postal code.
* @param {string} options.shippingAddressOverride.countryCode Country.
* @param {string} [options.shippingAddressOverride.phone] Phone number.
* @param {string} [options.shippingAddressOverride.recipientName] Recipient's name.
* @param {boolean} [options.shippingAddressEditable=true] Set to false to disable user editing of the shipping address.
* @param {string} [options.billingAgreementDescription] Use this option to set the description of the preapproved payment agreement visible to customers in their PayPal profile during Vault flows. Max 255 characters.
* @param {string} [options.landingPageType] Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.
* * `login` - A PayPal account login page is used.
* * `billing` - A non-PayPal account landing page is used.
* @param {callback} callback The second argument, <code>data</code>, is a {@link PayPal~tokenizePayload|tokenizePayload}.
* @example
* <caption>Tokenizing with the vault flow</caption>
* button.addEventListener('click', function () {
* // Disable the button so that we don't attempt to open multiple popups.
* button.setAttribute('disabled', 'disabled');
*
* // if there is any other part of the page that must be disabled
* // while authentication is in progress, do so now
*
* // Because PayPal tokenization opens a popup, this must be called
* // as a result of a user action, such as a button click.
* paypalInstance.tokenize({
* flow: 'vault' // Required
* // Any other tokenization options
* }, function (tokenizeErr, payload) {
* button.removeAttribute('disabled');
*
* // if any other part of the page was disabled, re-enable now
*
* if (tokenizeErr) {
* // Handle tokenization errors or premature flow closure
*
* switch (tokenizeErr.code) {
* case 'PAYPAL_POPUP_CLOSED':
* console.error('Customer closed PayPal popup.');
* break;
* case 'PAYPAL_ACCOUNT_TOKENIZATION_FAILED':
* console.error('PayPal tokenization failed. See details:', tokenizeErr.details);
* break;
* case 'PAYPAL_FLOW_FAILED':
* console.error('Unable to initialize PayPal flow. Are your options correct?', tokenizeErr.details);
* break;
* default:
* console.error('Error!', tokenizeErr);
* }
* } else {
* // Submit payload.nonce to your server
* }
* });
* });
* @example
* <caption>Tokenizing with the checkout flow</caption>
* button.addEventListener('click', function () {
* // Disable the button so that we don't attempt to open multiple popups.
* button.setAttribute('disabled', 'disabled');
*
* // Because PayPal tokenization opens a popup, this must be called
* // as a result of a user action, such as a button click.
* paypalInstance.tokenize({
* flow: 'checkout', // Required
* amount: '10.00', // Required
* currency: 'USD' // Required
* // Any other tokenization options
* }, function (tokenizeErr, payload) {
* button.removeAttribute('disabled');
*
* if (tokenizeErr) {
* // Handle tokenization errors or premature flow closure
*
* switch (tokenizeErr.code) {
* case 'PAYPAL_POPUP_CLOSED':
* console.error('Customer closed PayPal popup.');
* break;
* case 'PAYPAL_ACCOUNT_TOKENIZATION_FAILED':
* console.error('PayPal tokenization failed. See details:', tokenizeErr.details);
* break;
* case 'PAYPAL_FLOW_FAILED':
* console.error('Unable to initialize PayPal flow. Are your options correct?', tokenizeErr.details);
* break;
* default:
* console.error('Error!', tokenizeErr);
* }
* } else {
* // Submit payload.nonce to your server
* }
* });
* });
* @returns {Promise|PayPal~tokenizeReturn} A handle to manage the PayPal checkout frame. If no callback is provided, returns a promise.
*/
PayPal.prototype.tokenize = function (options, callback) {
var self = this;
var client = this._client;
var tokenizePromise, optionError;
if (callback) {
callback = once(deferred(callback));
}
if (!options || !constants.FLOW_ENDPOINTS.hasOwnProperty(options.flow)) {
optionError = new BraintreeError(errors.PAYPAL_FLOW_OPTION_REQUIRED);
if (callback) {
callback(optionError);
return this._frameService.createNoopHandler();
}
return Promise.reject(optionError);
}
tokenizePromise = new Promise(function (resolve, reject) {
if (self._authorizationInProgress) {
analytics.sendEvent(client, 'paypal.tokenization.error.already-opened');
reject(new BraintreeError(errors.PAYPAL_TOKENIZATION_REQUEST_ACTIVE));
} else {
self._authorizationInProgress = true;
if (!global.popupBridge) {
analytics.sendEvent(client, 'paypal.tokenization.opened');
}
if (options.offerCredit === true) {
analytics.sendEvent(client, 'paypal.credit.offered');
}
self._navigateFrameToAuth(options).catch(reject);
// self MUST happen after _navigateFrameToAuth for Metro browsers to work.
self._frameService.open({}, self._createFrameServiceCallback(options, resolve, reject));
}
});
if (callback) {
tokenizePromise.then(function (res) {
callback(null, res);
}).catch(callback);
return this._frameService.createHandler({
beforeClose: function () {
analytics.sendEvent(client, 'paypal.tokenization.closed.by-merchant');
}
});
}
return tokenizePromise;
};
PayPal.prototype._createFrameServiceCallback = function (options, resolve, reject) {
var self = this;
var client = this._client;
if (global.popupBridge) {
return function (err, payload) {
var cancelled = payload && payload.path && payload.path.substring(0, 7) === '/cancel';
self._authorizationInProgress = false;
// `err` exists when the user clicks "Done" button of browser view
if (err || cancelled) {
analytics.sendEvent(client, 'paypal.tokenization.closed-popupbridge.by-user');
// Call merchant's tokenize callback with an error
reject(new BraintreeError(errors.PAYPAL_POPUP_CLOSED));
} else if (payload) {
self._tokenizePayPal(options, payload.queryItems).then(resolve).catch(reject);
}
};
}
return function (err, params) {
self._authorizationInProgress = false;
if (err) {
if (err.code === 'FRAME_SERVICE_FRAME_CLOSED') {
analytics.sendEvent(client, 'paypal.tokenization.closed.by-user');
reject(new BraintreeError(errors.PAYPAL_POPUP_CLOSED));
} else if (err.code && err.code.indexOf('FRAME_SERVICE_FRAME_OPEN_FAILED') > -1) {
reject(new BraintreeError({
code: errors.PAYPAL_POPUP_OPEN_FAILED.code,
type: errors.PAYPAL_POPUP_OPEN_FAILED.type,
message: errors.PAYPAL_POPUP_OPEN_FAILED.message,
details: {
originalError: err
}
}));
}
} else if (params) {
self._tokenizePayPal(options, params).then(resolve).catch(reject);
}
};
};
PayPal.prototype._tokenizePayPal = function (options, params) {
var self = this;
var client = this._client;
if (!global.popupBridge) {
this._frameService.redirect(this._loadingFrameUrl);
}
return client.request({
endpoint: 'payment_methods/paypal_accounts',
method: 'post',
data: this._formatTokenizeData(options, params)
}).then(function (response) {
var payload = self._formatTokenizePayload(response);
if (global.popupBridge) {
analytics.sendEvent(client, 'paypal.tokenization.success-popupbridge');
} else {
analytics.sendEvent(client, 'paypal.tokenization.success');
}
if (payload.creditFinancingOffered) {
analytics.sendEvent(client, 'paypal.credit.accepted');
}
self._frameService.close();
return payload;
}).catch(function (err) {
if (global.popupBridge) {
analytics.sendEvent(client, 'paypal.tokenization.failed-popupbridge');
} else {
analytics.sendEvent(client, 'paypal.tokenization.failed');
}
self._frameService.close();
return Promise.reject(convertToBraintreeError(err, {
type: errors.PAYPAL_ACCOUNT_TOKENIZATION_FAILED.type,
code: errors.PAYPAL_ACCOUNT_TOKENIZATION_FAILED.code,
message: errors.PAYPAL_ACCOUNT_TOKENIZATION_FAILED.message
}));
});
};
PayPal.prototype._formatTokenizePayload = function (response) {
var payload;
var account = {};
if (response.paypalAccounts) {
account = response.paypalAccounts[0];
}
payload = {
nonce: account.nonce,
details: {},
type: account.type
};
if (account.details && account.details.payerInfo) {
payload.details = account.details.payerInfo;
}
if (account.details && account.details.creditFinancingOffered) {
payload.creditFinancingOffered = account.details.creditFinancingOffered;
}
return payload;
};
PayPal.prototype._formatTokenizeData = function (options, params) {
var clientConfiguration = this._client.getConfiguration();
var gatewayConfiguration = clientConfiguration.gatewayConfiguration;
var isTokenizationKey = clientConfiguration.authorizationType === 'TOKENIZATION_KEY';
var data = {
paypalAccount: {
correlationId: params.ba_token || params.token,
options: {
validate: options.flow === 'vault' && !isTokenizationKey
}
}
};
if (params.ba_token) {
data.paypalAccount.billingAgreementToken = params.ba_token;
} else {
data.paypalAccount.paymentToken = params.paymentId;
data.paypalAccount.payerId = params.PayerID;
data.paypalAccount.unilateral = gatewayConfiguration.paypal.unvettedMerchant;
if (options.hasOwnProperty('intent')) {
data.paypalAccount.intent = options.intent;
}
}
return data;
};
PayPal.prototype._navigateFrameToAuth = function (options) {
var self = this;
var client = this._client;
var endpoint = 'paypal_hermes/' + constants.FLOW_ENDPOINTS[options.flow];
return client.request({
endpoint: endpoint,
method: 'post',
data: this._formatPaymentResourceData(options)
}).then(function (response) {
var redirectUrl;
if (options.flow === 'checkout') {
redirectUrl = response.paymentResource.redirectUrl;
} else {
redirectUrl = response.agreementSetup.approvalUrl;
}
if (options.useraction === 'commit') {
redirectUrl = querystring.queryify(redirectUrl, {useraction: 'commit'});
}
if (global.popupBridge) {
analytics.sendEvent(client, 'paypal.tokenization.opened-popupbridge');
}
self._frameService.redirect(redirectUrl);
}).catch(function (err) {
var status = err.details && err.details.httpStatus;
self._frameService.close();
self._authorizationInProgress = false;
if (status === 422) {
return Promise.reject(new BraintreeError({
type: errors.PAYPAL_INVALID_PAYMENT_OPTION.type,
code: errors.PAYPAL_INVALID_PAYMENT_OPTION.code,
message: errors.PAYPAL_INVALID_PAYMENT_OPTION.message,
details: {
originalError: err
}
}));
}
return Promise.reject(convertToBraintreeError(err, {
type: errors.PAYPAL_FLOW_FAILED.type,
code: errors.PAYPAL_FLOW_FAILED.code,
message: errors.PAYPAL_FLOW_FAILED.message
}));
});
};
PayPal.prototype._formatPaymentResourceData = function (options) {
var key;
var gatewayConfiguration = this._client.getConfiguration().gatewayConfiguration;
var serviceId = this._frameService._serviceId;
var paymentResource = {
returnUrl: gatewayConfiguration.paypal.assetsUrl + '/web/' + VERSION + '/html/paypal-redirect-frame' + useMin(this._isDebug) + '.html?channel=' + serviceId,
cancelUrl: gatewayConfiguration.paypal.assetsUrl + '/web/' + VERSION + '/html/paypal-cancel-frame' + useMin(this._isDebug) + '.html?channel=' + serviceId,
offerPaypalCredit: options.offerCredit === true,
experienceProfile: {
brandName: options.displayName || gatewayConfiguration.paypal.displayName,
localeCode: options.locale,
noShipping: (!options.enableShippingAddress).toString(),
addressOverride: options.shippingAddressEditable === false,
landingPageType: options.landingPageType
}
};
if (global.popupBridge && typeof global.popupBridge.getReturnUrlPrefix === 'function') {
paymentResource.returnUrl = global.popupBridge.getReturnUrlPrefix() + 'return';
paymentResource.cancelUrl = global.popupBridge.getReturnUrlPrefix() + 'cancel';
}
if (options.flow === 'checkout') {
paymentResource.amount = options.amount;
paymentResource.currencyIsoCode = options.currency;
if (options.hasOwnProperty('intent')) {
paymentResource.intent = options.intent;
}
for (key in options.shippingAddressOverride) {
if (options.shippingAddressOverride.hasOwnProperty(key)) {
paymentResource[key] = options.shippingAddressOverride[key];
}
}
} else {
paymentResource.shippingAddress = options.shippingAddressOverride;
if (options.billingAgreementDescription) {
paymentResource.description = options.billingAgreementDescription;
}
}
return paymentResource;
};
/**
* Closes the PayPal window if it is open.
* @public
* @example
* paypalInstance.closeWindow();
* @returns {void}
*/
PayPal.prototype.closeWindow = function () {
if (this._authorizationInProgress) {
analytics.sendEvent(this._client, 'paypal.tokenize.closed.by-merchant');
}
this._frameService.close();
};
/**
* Focuses the PayPal window if it is open.
* @public
* @example
* paypalInstance.focusWindow();
* @returns {void}
*/
PayPal.prototype.focusWindow = function () {
this._frameService.focus();
};
/**
* Cleanly remove anything set up by {@link module:braintree-web/paypal.create|create}.
* @public
* @param {callback} [callback] Called on completion.
* @example
* paypalInstance.teardown();
* @example <caption>With callback</caption>
* paypalInstance.teardown(function () {
* // teardown is complete
* });
* @returns {Promise|void} Returns a promise if no callback is provided.
*/
PayPal.prototype.teardown = wrapPromise(function () {
var self = this; // eslint-disable-line no-invalid-this
self._frameService.teardown();
convertMethodsToError(self, methods(PayPal.prototype));
analytics.sendEvent(self._client, 'paypal.teardown-completed');
return Promise.resolve();
});
module.exports = PayPal;