@vendure/payments-plugin 1.3.3 → 1.4.1

package/package/braintree/braintree-common.d.ts

@@ -1,6 +1,6 @@
 import { BraintreeGateway, Transaction } from 'braintree';
-import { PaymentMethodArgsHash } from './types';
-export declare function getGateway(args: PaymentMethodArgsHash): BraintreeGateway;
+import { BraintreePluginOptions, PaymentMethodArgsHash } from './types';
+export declare function getGateway(args: PaymentMethodArgsHash, options: BraintreePluginOptions): BraintreeGateway;
 /**
  * Returns a subset of the Transaction object of interest to the Administrator.
  */

package/package/braintree/braintree-common.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractMetadataFromTransaction = exports.getGateway = void 0;
 const braintree_1 = require("braintree");
-function getGateway(args) {
+function getGateway(args, options) {
     return new braintree_1.BraintreeGateway({
-        environment: braintree_1.Environment.Sandbox,
+        environment: options.environment || braintree_1.Environment.Sandbox,
         merchantId: args.merchantId,
         privateKey: args.privateKey,
         publicKey: args.publicKey,

package/package/braintree/braintree-common.js.map

@@ -1 +1 @@
-{"version":3,"file":"braintree-common.js","sourceRoot":"","sources":["../../src/braintree/braintree-common.ts"],"names":[],"mappings":";;;AAAA,yCAAuE;AAIvE,SAAgB,UAAU,CAAC,IAA2B;IAClD,OAAO,IAAI,4BAAgB,CAAC;QACxB,WAAW,EAAE,uBAAW,CAAC,OAAO;QAChC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;KAC5B,CAAC,CAAC;AACP,CAAC;AAPD,gCAOC;AAED;;GAEG;AACH,SAAgB,8BAA8B,CAAC,WAAwB;IACnE,MAAM,QAAQ,GAA2B;QACrC,MAAM,EAAE,WAAW,CAAC,MAAM;QAC1B,eAAe,EAAE,WAAW,CAAC,eAAe;QAC5C,iBAAiB,EAAE,WAAW,CAAC,iBAAiB;QAChD,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,eAAe,CAAC;QACpD,gBAAgB,EAAE,aAAa,CAAC,WAAW,CAAC,yBAAyB,CAAC;QACtE,qBAAqB,EAAE,aAAa,CAAC,WAAW,CAAC,4BAA4B,CAAC;QAC9E,0BAA0B,EAAE,WAAW,CAAC,0BAA0B;QAClE,qBAAqB,EAAE,WAAW,CAAC,qBAAqB;QACxD,aAAa,EAAE,WAAW,CAAC,qBAAqB;KACnD,CAAC;IACF,IAAI,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE;QAC3D,QAAQ,CAAC,QAAQ,GAAG;YAChB,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,QAAQ;YACzC,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK;YACnC,cAAc,EAAE,WAAW,CAAC,UAAU,CAAC,cAAc;SACxD,CAAC;KACL;IACD,IAAI,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE;QACxE,QAAQ,CAAC,UAAU,GAAG;YAClB,UAAU,EAAE,WAAW,CAAC,aAAa,CAAC,UAAU;YAChD,SAAS,EAAE,WAAW,CAAC,aAAa,CAAC,SAAS;YAC9C,eAAe,EAAE,WAAW,CAAC,aAAa,CAAC,eAAe;YAC1D,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,WAAW;YAClD,sBAAsB,EAAE,WAAW,CAAC,aAAa,CAAC,sBAAsB;YACxE,oBAAoB,EAAE,WAAW,CAAC,aAAa,CAAC,oBAAoB;SACvE,CAAC;KACL;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AA9BD,wEA8BC;AAED,SAAS,aAAa,CAAC,IAAY;IAC/B,QAAQ,IAAI,EAAE;QACV,KAAK,GAAG;YACJ,OAAO,cAAc,CAAC;QAC1B,KAAK,GAAG;YACJ,OAAO,SAAS,CAAC;QACrB,KAAK,GAAG;YACJ,OAAO,aAAa,CAAC;QACzB,KAAK,GAAG;YACJ,OAAO,cAAc,CAAC;QAC1B,KAAK,GAAG;YACJ,OAAO,eAAe,CAAC;QAC3B,KAAK,GAAG;YACJ,OAAO,kBAAkB,CAAC;QAC9B,KAAK,GAAG;YACJ,OAAO,gBAAgB,CAAC;QAC5B,KAAK,GAAG;YACJ,OAAO,SAAS,CAAC;QACrB;YACI,OAAO,SAAS,CAAC;KACxB;AACL,CAAC"}
+{"version":3,"file":"braintree-common.js","sourceRoot":"","sources":["../../src/braintree/braintree-common.ts"],"names":[],"mappings":";;;AAAA,yCAAuE;AAIvE,SAAgB,UAAU,CAAC,IAA2B,EAAE,OAA+B;IACnF,OAAO,IAAI,4BAAgB,CAAC;QACxB,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,uBAAW,CAAC,OAAO;QACvD,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;KAC5B,CAAC,CAAC;AACP,CAAC;AAPD,gCAOC;AAED;;GAEG;AACH,SAAgB,8BAA8B,CAAC,WAAwB;IACnE,MAAM,QAAQ,GAA2B;QACrC,MAAM,EAAE,WAAW,CAAC,MAAM;QAC1B,eAAe,EAAE,WAAW,CAAC,eAAe;QAC5C,iBAAiB,EAAE,WAAW,CAAC,iBAAiB;QAChD,QAAQ,EAAE,aAAa,CAAC,WAAW,CAAC,eAAe,CAAC;QACpD,gBAAgB,EAAE,aAAa,CAAC,WAAW,CAAC,yBAAyB,CAAC;QACtE,qBAAqB,EAAE,aAAa,CAAC,WAAW,CAAC,4BAA4B,CAAC;QAC9E,0BAA0B,EAAE,WAAW,CAAC,0BAA0B;QAClE,qBAAqB,EAAE,WAAW,CAAC,qBAAqB;QACxD,aAAa,EAAE,WAAW,CAAC,qBAAqB;KACnD,CAAC;IACF,IAAI,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE;QAC3D,QAAQ,CAAC,QAAQ,GAAG;YAChB,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,QAAQ;YACzC,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK;YACnC,cAAc,EAAE,WAAW,CAAC,UAAU,CAAC,cAAc;SACxD,CAAC;KACL;IACD,IAAI,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE;QACxE,QAAQ,CAAC,UAAU,GAAG;YAClB,UAAU,EAAE,WAAW,CAAC,aAAa,CAAC,UAAU;YAChD,SAAS,EAAE,WAAW,CAAC,aAAa,CAAC,SAAS;YAC9C,eAAe,EAAE,WAAW,CAAC,aAAa,CAAC,eAAe;YAC1D,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,WAAW;YAClD,sBAAsB,EAAE,WAAW,CAAC,aAAa,CAAC,sBAAsB;YACxE,oBAAoB,EAAE,WAAW,CAAC,aAAa,CAAC,oBAAoB;SACvE,CAAC;KACL;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AA9BD,wEA8BC;AAED,SAAS,aAAa,CAAC,IAAY;IAC/B,QAAQ,IAAI,EAAE;QACV,KAAK,GAAG;YACJ,OAAO,cAAc,CAAC;QAC1B,KAAK,GAAG;YACJ,OAAO,SAAS,CAAC;QACrB,KAAK,GAAG;YACJ,OAAO,aAAa,CAAC;QACzB,KAAK,GAAG;YACJ,OAAO,cAAc,CAAC;QAC1B,KAAK,GAAG;YACJ,OAAO,eAAe,CAAC;QAC3B,KAAK,GAAG;YACJ,OAAO,kBAAkB,CAAC;QAC9B,KAAK,GAAG;YACJ,OAAO,gBAAgB,CAAC;QAC5B,KAAK,GAAG;YACJ,OAAO,SAAS,CAAC;QACrB;YACI,OAAO,SAAS,CAAC;KACxB;AACL,CAAC"}

package/package/braintree/braintree.handler.d.ts

@@ -0,0 +1,28 @@
+import { LanguageCode } from '@vendure/common/lib/generated-types';
+import { PaymentMethodHandler } from '@vendure/core';
+/**
+ * The handler for Braintree payments.
+ */
+export declare const braintreePaymentMethodHandler: PaymentMethodHandler<{
+    merchantId: {
+        type: "string";
+        label: {
+            languageCode: LanguageCode.en;
+            value: string;
+        }[];
+    };
+    publicKey: {
+        type: "string";
+        label: {
+            languageCode: LanguageCode.en;
+            value: string;
+        }[];
+    };
+    privateKey: {
+        type: "string";
+        label: {
+            languageCode: LanguageCode.en;
+            value: string;
+        }[];
+    };
+}>;

package/package/braintree/braintree.handler.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.braintreePaymentMethodHandler = void 0;
+const generated_types_1 = require("@vendure/common/lib/generated-types");
+const core_1 = require("@vendure/core");
+const braintree_common_1 = require("./braintree-common");
+const constants_1 = require("./constants");
+let options;
+let connection;
+let entityHydrator;
+/**
+ * The handler for Braintree payments.
+ */
+exports.braintreePaymentMethodHandler = new core_1.PaymentMethodHandler({
+    code: 'braintree',
+    description: [{ languageCode: generated_types_1.LanguageCode.en, value: 'Braintree payments' }],
+    args: {
+        merchantId: { type: 'string', label: [{ languageCode: generated_types_1.LanguageCode.en, value: 'Merchant ID' }] },
+        publicKey: { type: 'string', label: [{ languageCode: generated_types_1.LanguageCode.en, value: 'Public Key' }] },
+        privateKey: { type: 'string', label: [{ languageCode: generated_types_1.LanguageCode.en, value: 'Private Key' }] },
+    },
+    init(injector) {
+        options = injector.get(constants_1.BRAINTREE_PLUGIN_OPTIONS);
+        connection = injector.get(core_1.TransactionalConnection);
+        entityHydrator = injector.get(core_1.EntityHydrator);
+    },
+    async createPayment(ctx, order, amount, args, metadata) {
+        const gateway = braintree_common_1.getGateway(args, options);
+        let customerId;
+        try {
+            await entityHydrator.hydrate(ctx, order, { relations: ['customer'] });
+            const customer = order.customer;
+            if (options.storeCustomersInBraintree && ctx.activeUserId && customer) {
+                customerId = await getBraintreeCustomerId(ctx, gateway, customer);
+            }
+            return processPayment(ctx, gateway, order, amount, metadata.nonce, customerId);
+        }
+        catch (e) {
+            core_1.Logger.error(e, constants_1.loggerCtx);
+            return {
+                amount: order.total,
+                state: 'Error',
+                transactionId: '',
+                errorMessage: e.toString(),
+                metadata: e,
+            };
+        }
+    },
+    settlePayment() {
+        return {
+            success: true,
+        };
+    },
+    async createRefund(ctx, input, total, order, payment, args) {
+        const gateway = braintree_common_1.getGateway(args, options);
+        const response = await gateway.transaction.refund(payment.transactionId, (total / 100).toString(10));
+        if (!response.success) {
+            return {
+                state: 'Failed',
+                transactionId: response.transaction.id,
+                metadata: response,
+            };
+        }
+        return {
+            state: 'Settled',
+            transactionId: response.transaction.id,
+            metadata: response,
+        };
+    },
+});
+async function processPayment(ctx, gateway, order, amount, paymentMethodNonce, customerId) {
+    const response = await gateway.transaction.sale({
+        customerId,
+        amount: (amount / 100).toString(10),
+        orderId: order.code,
+        paymentMethodNonce,
+        options: {
+            submitForSettlement: true,
+            storeInVaultOnSuccess: !!customerId,
+        },
+    });
+    if (!response.success) {
+        return {
+            amount,
+            state: 'Declined',
+            transactionId: response.transaction.id,
+            errorMessage: response.message,
+            metadata: braintree_common_1.extractMetadataFromTransaction(response.transaction),
+        };
+    }
+    return {
+        amount,
+        state: 'Settled',
+        transactionId: response.transaction.id,
+        metadata: braintree_common_1.extractMetadataFromTransaction(response.transaction),
+    };
+}
+/**
+ * If the Customer has no braintreeCustomerId, create one, else return the existing braintreeCustomerId.
+ */
+async function getBraintreeCustomerId(ctx, gateway, customer) {
+    if (!customer.customFields.braintreeCustomerId) {
+        try {
+            const result = await gateway.customer.create({
+                firstName: customer.firstName,
+                lastName: customer.lastName,
+                email: customer.emailAddress,
+            });
+            if (result.success) {
+                const customerId = result.customer.id;
+                core_1.Logger.verbose(`Created Braintree Customer record for customerId ${customer.id}`, constants_1.loggerCtx);
+                customer.customFields.braintreeCustomerId = customerId;
+                await connection.getRepository(ctx, core_1.Customer).save(customer, { reload: false });
+                return customerId;
+            }
+            else {
+                core_1.Logger.error(`Failed to create Braintree Customer record for customerId ${customer.id}. View Debug level logs for details.`, constants_1.loggerCtx);
+                core_1.Logger.debug(JSON.stringify(result.errors, null, 2), constants_1.loggerCtx);
+            }
+        }
+        catch (e) {
+            core_1.Logger.error(e.message, constants_1.loggerCtx, e.stack);
+        }
+    }
+    else {
+        return customer.customFields.braintreeCustomerId;
+    }
+}
+//# sourceMappingURL=braintree.handler.js.map

package/package/braintree/braintree.handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"braintree.handler.js","sourceRoot":"","sources":["../../src/braintree/braintree.handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AACnE,wCASuB;AAGvB,yDAAgF;AAChF,2CAAkE;AAGlE,IAAI,OAA+B,CAAC;AACpC,IAAI,UAAmC,CAAC;AACxC,IAAI,cAA8B,CAAC;AAEnC;;GAEG;AACU,QAAA,6BAA6B,GAAG,IAAI,2BAAoB,CAAC;IAClE,IAAI,EAAE,WAAW;IACjB,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC7E,IAAI,EAAE;QACF,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,EAAE;QAChG,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,EAAE;QAC9F,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,EAAE;KACnG;IACD,IAAI,CAAC,QAAkB;QACnB,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAyB,oCAAwB,CAAC,CAAC;QACzE,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,8BAAuB,CAAC,CAAC;QACnD,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,qBAAc,CAAC,CAAC;IAClD,CAAC;IACD,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ;QAClD,MAAM,OAAO,GAAG,6BAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1C,IAAI,UAA8B,CAAC;QACnC,IAAI;YACA,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YACtE,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAChC,IAAI,OAAO,CAAC,yBAAyB,IAAI,GAAG,CAAC,YAAY,IAAI,QAAQ,EAAE;gBACnE,UAAU,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;aACrE;YACD,OAAO,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;SAClF;QAAC,OAAO,CAAC,EAAE;YACR,aAAM,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAS,CAAC,CAAC;YAC3B,OAAO;gBACH,MAAM,EAAE,KAAK,CAAC,KAAK;gBACnB,KAAK,EAAE,OAAgB;gBACvB,aAAa,EAAE,EAAE;gBACjB,YAAY,EAAE,CAAC,CAAC,QAAQ,EAAE;gBAC1B,QAAQ,EAAE,CAAC;aACd,CAAC;SACL;IACL,CAAC;IAED,aAAa;QACT,OAAO;YACH,OAAO,EAAE,IAAI;SAChB,CAAC;IACN,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI;QACtD,MAAM,OAAO,GAAG,6BAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QACrG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACnB,OAAO;gBACH,KAAK,EAAE,QAAiB;gBACxB,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;gBACtC,QAAQ,EAAE,QAAQ;aACrB,CAAC;SACL;QACD,OAAO;YACH,KAAK,EAAE,SAAkB;YACzB,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;YACtC,QAAQ,EAAE,QAAQ;SACrB,CAAC;IACN,CAAC;CACJ,CAAC,CAAC;AAEH,KAAK,UAAU,cAAc,CACzB,GAAmB,EACnB,OAAyB,EACzB,KAAY,EACZ,MAAc,EACd,kBAAuB,EACvB,UAA8B;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QAC5C,UAAU;QACV,MAAM,EAAE,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,EAAE,KAAK,CAAC,IAAI;QACnB,kBAAkB;QAClB,OAAO,EAAE;YACL,mBAAmB,EAAE,IAAI;YACzB,qBAAqB,EAAE,CAAC,CAAC,UAAU;SACtC;KACJ,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;QACnB,OAAO;YACH,MAAM;YACN,KAAK,EAAE,UAAmB;YAC1B,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;YACtC,YAAY,EAAE,QAAQ,CAAC,OAAO;YAC9B,QAAQ,EAAE,iDAA8B,CAAC,QAAQ,CAAC,WAAW,CAAC;SACjE,CAAC;KACL;IACD,OAAO;QACH,MAAM;QACN,KAAK,EAAE,SAAkB;QACzB,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;QACtC,QAAQ,EAAE,iDAA8B,CAAC,QAAQ,CAAC,WAAW,CAAC;KACjE,CAAC;AACN,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,sBAAsB,CACjC,GAAmB,EACnB,OAAyB,EACzB,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,mBAAmB,EAAE;QAC5C,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACzC,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,KAAK,EAAE,QAAQ,CAAC,YAAY;aAC/B,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,OAAO,EAAE;gBAChB,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtC,aAAM,CAAC,OAAO,CAAC,oDAAoD,QAAQ,CAAC,EAAE,EAAE,EAAE,qBAAS,CAAC,CAAC;gBAC7F,QAAQ,CAAC,YAAY,CAAC,mBAAmB,GAAG,UAAU,CAAC;gBACvD,MAAM,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,eAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAChF,OAAO,UAAU,CAAC;aACrB;iBAAM;gBACH,aAAM,CAAC,KAAK,CACR,6DAA6D,QAAQ,CAAC,EAAE,sCAAsC,EAC9G,qBAAS,CACZ,CAAC;gBACF,aAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,qBAAS,CAAC,CAAC;aACnE;SACJ;QAAC,OAAO,CAAC,EAAE;YACR,aAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,qBAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;SAC/C;KACJ;SAAM;QACH,OAAO,QAAQ,CAAC,YAAY,CAAC,mBAAmB,CAAC;KACpD;AACL,CAAC"}

package/package/braintree/braintree.plugin.d.ts

@@ -0,0 +1,190 @@
+import { Type } from '@vendure/core';
+import { BraintreePluginOptions } from './types';
+/**
+ * @description
+ * This plugin enables payments to be processed by [Braintree](https://www.braintreepayments.com/), a popular payment provider.
+ *
+ * ## Requirements
+ *
+ * 1. You will need to create a Braintree sandbox account as outlined in https://developers.braintreepayments.com/start/overview.
+ * 2. Then install `braintree` and `@types/braintree` from npm. This plugin was written with `v3.x` of the Braintree lib.
+ *     ```shell
+ *     yarn add \@vendure/payments-plugin braintree
+ *     yarn add -D \@types/braintree
+ *     ```
+ *     or
+ *     ```shell
+ *     npm install \@vendure/payments-plugin braintree
+ *     npm install -D \@types/braintree
+ *     ```
+ *
+ * ## Setup
+ *
+ * 1. Add the plugin to your VendureConfig `plugins` array:
+ *     ```TypeScript
+ *     import { BraintreePlugin } from '\@vendure/payments-plugin/package/braintree';
+ *     import { Environment } from 'braintree';
+ *
+ *     // ...
+ *
+ *     plugins: [
+ *       BraintreePlugin.init({
+ *         environment: Environment.Sandbox,
+ *         // This allows saving customer payment
+ *         // methods with Braintree
+ *         storeCustomersInBraintree: true,
+ *       }),
+ *     ]
+ *     ```
+ * 2. Create a new PaymentMethod in the Admin UI, and select "Braintree payments" as the handler.
+ * 2. Fill in the `Merchant ID`, `Public Key` & `Private Key` from your Braintree sandbox account.
+ *
+ * ## Storefront usage
+ *
+ * The plugin is designed to work with the [Braintree drop-in UI](https://developers.braintreepayments.com/guides/drop-in/overview/javascript/v3).
+ * This is a library provided by Braintree which will handle the payment UI for you. You can install it in your storefront project
+ * with:
+ *
+ * ```shell
+ * yarn add braintree-web-drop-in
+ * # or
+ * npm install braintree-web-drop-in
+ * ```
+ *
+ * The high-level workflow is:
+ * 1. Generate a "client token" on the server by executing the `generateBraintreeClientToken` mutation which is exposed by this plugin.
+ * 2. Use this client token to instantiate the Braintree Dropin UI.
+ * 3. Listen for the `"paymentMethodRequestable"` event which emitted by the Dropin.
+ * 4. Use the Dropin's `requestPaymentMethod()` method to get the required payment metadata.
+ * 5. Pass that metadata to the `addPaymentToOrder` mutation.
+ *
+ * Here is an example of how your storefront code will look. Note that this example is attempting to
+ * be framework-agnostic, so you'll need to adapt it to fit to your framework of choice.
+ *
+ * ```TypeScript
+ * // The Braintree Dropin instance
+ * let dropin: import('braintree-web-drop-in').Dropin;
+ *
+ * // Used to show/hide a "submit" button, which would be bound to the
+ * // `submitPayment()` method below.
+ * let showSubmitButton = false;
+ *
+ * // Used to display a "processing..." spinner
+ * let processing = false;
+ *
+ * //
+ * // This method would be invoked when the payment screen is mounted/created.
+ * //
+ * async function renderDropin(order: Order, clientToken: string) {
+ *   // Lazy load braintree dropin because it has a reference
+ *   // to `window` which breaks SSR
+ *   dropin = await import('braintree-web-drop-in').then((module) =>
+ *     module.default.create({
+ *       authorization: clientToken,
+ *       // This assumes a div in your view with the corresponding ID
+ *       container: '#dropin-container',
+ *       card: {
+ *         cardholderName: {
+ *             required: true,
+ *         },
+ *         overrides: {},
+ *       },
+ *       // Additional config is passed here depending on
+ *       // which payment methods you have enabled in your
+ *       // Braintree account.
+ *       paypal: {
+ *         flow: 'checkout',
+ *         amount: order.totalWithTax,
+ *         currency: 'GBP',
+ *       },
+ *     }),
+ *   );
+ *
+ *   // If you are using the `storeCustomersInBraintree` option, then the
+ *   // customer might already have a stored payment method selected as
+ *   // soon as the dropin script loads. In this case, show the submit
+ *   // button immediately.
+ *   if (dropin.isPaymentMethodRequestable()) {
+ *     showSubmitButton = true;
+ *   }
+ *
+ *   dropin.on('paymentMethodRequestable', (payload) => {
+ *     if (payload.type === 'CreditCard') {
+ *       showSubmitButton = true;
+ *     }
+ *     if (payload.type === 'PayPalAccount') {
+ *       this.submitPayment();
+ *     }
+ *   });
+ *
+ *   dropin.on('noPaymentMethodRequestable', () => {
+ *     // Display an error
+ *   });
+ * }
+ *
+ * async function generateClientToken(orderId: string) {
+ *   const { generateBraintreeClientToken } = await graphQlClient.query(gql`
+ *     query GenerateBraintreeClientToken($orderId: ID!) {
+ *       generateBraintreeClientToken(orderId: $orderId)
+ *     }
+ *   `, { orderId });
+ *   return generateBraintreeClientToken;
+ * }
+ *
+ * async submitPayment() {
+ *   if (!dropin.isPaymentMethodRequestable()) {
+ *     return;
+ *   }
+ *   showSubmitButton = false;
+ *   processing = true;
+ *
+ *   const paymentResult = await dropin.requestPaymentMethod();
+ *
+ *   const { addPaymentToOrder } = await graphQlClient.query(gql`
+ *     mutation AddPayment($input: PaymentInput!) {
+ *       addPaymentToOrder(input: $input) {
+ *         ... on Order {
+ *           id
+ *           payments {
+ *             id
+ *             amount
+ *             errorMessage
+ *             method
+ *             state
+ *             transactionId
+ *             createdAt
+ *           }
+ *         }
+ *         ... on ErrorResult {
+ *           errorCode
+ *           message
+ *         }
+ *       }
+ *     }`, {
+ *       input: {
+ *         method: 'braintree', // The code of you Braintree PaymentMethod
+ *         metadata: paymentResult,
+ *       },
+ *     },
+ *   );
+ *
+ *   switch (addPaymentToOrder?.__typename) {
+ *       case 'Order':
+ *           // Adding payment succeeded!
+ *           break;
+ *       case 'OrderStateTransitionError':
+ *       case 'OrderPaymentStateError':
+ *       case 'PaymentDeclinedError':
+ *       case 'PaymentFailedError':
+ *         // Display an error to the customer
+ *         dropin.clearSelectedPaymentMethod();
+ *   }
+ * }
+ * ```
+ * @docsCategory payments-plugin
+ * @docsPage BraintreePlugin
+ */
+export declare class BraintreePlugin {
+    static options: BraintreePluginOptions;
+    static init(options: BraintreePluginOptions): Type<BraintreePlugin>;
+}

package/package/braintree/braintree.plugin.js

@@ -0,0 +1,241 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var BraintreePlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BraintreePlugin = void 0;
+const core_1 = require("@vendure/core");
+const apollo_server_core_1 = require("apollo-server-core");
+const braintree_handler_1 = require("./braintree.handler");
+const braintree_resolver_1 = require("./braintree.resolver");
+const constants_1 = require("./constants");
+/**
+ * @description
+ * This plugin enables payments to be processed by [Braintree](https://www.braintreepayments.com/), a popular payment provider.
+ *
+ * ## Requirements
+ *
+ * 1. You will need to create a Braintree sandbox account as outlined in https://developers.braintreepayments.com/start/overview.
+ * 2. Then install `braintree` and `@types/braintree` from npm. This plugin was written with `v3.x` of the Braintree lib.
+ *     ```shell
+ *     yarn add \@vendure/payments-plugin braintree
+ *     yarn add -D \@types/braintree
+ *     ```
+ *     or
+ *     ```shell
+ *     npm install \@vendure/payments-plugin braintree
+ *     npm install -D \@types/braintree
+ *     ```
+ *
+ * ## Setup
+ *
+ * 1. Add the plugin to your VendureConfig `plugins` array:
+ *     ```TypeScript
+ *     import { BraintreePlugin } from '\@vendure/payments-plugin/package/braintree';
+ *     import { Environment } from 'braintree';
+ *
+ *     // ...
+ *
+ *     plugins: [
+ *       BraintreePlugin.init({
+ *         environment: Environment.Sandbox,
+ *         // This allows saving customer payment
+ *         // methods with Braintree
+ *         storeCustomersInBraintree: true,
+ *       }),
+ *     ]
+ *     ```
+ * 2. Create a new PaymentMethod in the Admin UI, and select "Braintree payments" as the handler.
+ * 2. Fill in the `Merchant ID`, `Public Key` & `Private Key` from your Braintree sandbox account.
+ *
+ * ## Storefront usage
+ *
+ * The plugin is designed to work with the [Braintree drop-in UI](https://developers.braintreepayments.com/guides/drop-in/overview/javascript/v3).
+ * This is a library provided by Braintree which will handle the payment UI for you. You can install it in your storefront project
+ * with:
+ *
+ * ```shell
+ * yarn add braintree-web-drop-in
+ * # or
+ * npm install braintree-web-drop-in
+ * ```
+ *
+ * The high-level workflow is:
+ * 1. Generate a "client token" on the server by executing the `generateBraintreeClientToken` mutation which is exposed by this plugin.
+ * 2. Use this client token to instantiate the Braintree Dropin UI.
+ * 3. Listen for the `"paymentMethodRequestable"` event which emitted by the Dropin.
+ * 4. Use the Dropin's `requestPaymentMethod()` method to get the required payment metadata.
+ * 5. Pass that metadata to the `addPaymentToOrder` mutation.
+ *
+ * Here is an example of how your storefront code will look. Note that this example is attempting to
+ * be framework-agnostic, so you'll need to adapt it to fit to your framework of choice.
+ *
+ * ```TypeScript
+ * // The Braintree Dropin instance
+ * let dropin: import('braintree-web-drop-in').Dropin;
+ *
+ * // Used to show/hide a "submit" button, which would be bound to the
+ * // `submitPayment()` method below.
+ * let showSubmitButton = false;
+ *
+ * // Used to display a "processing..." spinner
+ * let processing = false;
+ *
+ * //
+ * // This method would be invoked when the payment screen is mounted/created.
+ * //
+ * async function renderDropin(order: Order, clientToken: string) {
+ *   // Lazy load braintree dropin because it has a reference
+ *   // to `window` which breaks SSR
+ *   dropin = await import('braintree-web-drop-in').then((module) =>
+ *     module.default.create({
+ *       authorization: clientToken,
+ *       // This assumes a div in your view with the corresponding ID
+ *       container: '#dropin-container',
+ *       card: {
+ *         cardholderName: {
+ *             required: true,
+ *         },
+ *         overrides: {},
+ *       },
+ *       // Additional config is passed here depending on
+ *       // which payment methods you have enabled in your
+ *       // Braintree account.
+ *       paypal: {
+ *         flow: 'checkout',
+ *         amount: order.totalWithTax,
+ *         currency: 'GBP',
+ *       },
+ *     }),
+ *   );
+ *
+ *   // If you are using the `storeCustomersInBraintree` option, then the
+ *   // customer might already have a stored payment method selected as
+ *   // soon as the dropin script loads. In this case, show the submit
+ *   // button immediately.
+ *   if (dropin.isPaymentMethodRequestable()) {
+ *     showSubmitButton = true;
+ *   }
+ *
+ *   dropin.on('paymentMethodRequestable', (payload) => {
+ *     if (payload.type === 'CreditCard') {
+ *       showSubmitButton = true;
+ *     }
+ *     if (payload.type === 'PayPalAccount') {
+ *       this.submitPayment();
+ *     }
+ *   });
+ *
+ *   dropin.on('noPaymentMethodRequestable', () => {
+ *     // Display an error
+ *   });
+ * }
+ *
+ * async function generateClientToken(orderId: string) {
+ *   const { generateBraintreeClientToken } = await graphQlClient.query(gql`
+ *     query GenerateBraintreeClientToken($orderId: ID!) {
+ *       generateBraintreeClientToken(orderId: $orderId)
+ *     }
+ *   `, { orderId });
+ *   return generateBraintreeClientToken;
+ * }
+ *
+ * async submitPayment() {
+ *   if (!dropin.isPaymentMethodRequestable()) {
+ *     return;
+ *   }
+ *   showSubmitButton = false;
+ *   processing = true;
+ *
+ *   const paymentResult = await dropin.requestPaymentMethod();
+ *
+ *   const { addPaymentToOrder } = await graphQlClient.query(gql`
+ *     mutation AddPayment($input: PaymentInput!) {
+ *       addPaymentToOrder(input: $input) {
+ *         ... on Order {
+ *           id
+ *           payments {
+ *             id
+ *             amount
+ *             errorMessage
+ *             method
+ *             state
+ *             transactionId
+ *             createdAt
+ *           }
+ *         }
+ *         ... on ErrorResult {
+ *           errorCode
+ *           message
+ *         }
+ *       }
+ *     }`, {
+ *       input: {
+ *         method: 'braintree', // The code of you Braintree PaymentMethod
+ *         metadata: paymentResult,
+ *       },
+ *     },
+ *   );
+ *
+ *   switch (addPaymentToOrder?.__typename) {
+ *       case 'Order':
+ *           // Adding payment succeeded!
+ *           break;
+ *       case 'OrderStateTransitionError':
+ *       case 'OrderPaymentStateError':
+ *       case 'PaymentDeclinedError':
+ *       case 'PaymentFailedError':
+ *         // Display an error to the customer
+ *         dropin.clearSelectedPaymentMethod();
+ *   }
+ * }
+ * ```
+ * @docsCategory payments-plugin
+ * @docsPage BraintreePlugin
+ */
+let BraintreePlugin = BraintreePlugin_1 = class BraintreePlugin {
+    static init(options) {
+        this.options = options;
+        return BraintreePlugin_1;
+    }
+};
+BraintreePlugin.options = {};
+BraintreePlugin = BraintreePlugin_1 = __decorate([
+    core_1.VendurePlugin({
+        imports: [core_1.PluginCommonModule],
+        providers: [
+            {
+                provide: constants_1.BRAINTREE_PLUGIN_OPTIONS,
+                useFactory: () => BraintreePlugin_1.options,
+            },
+        ],
+        configuration: config => {
+            config.paymentOptions.paymentMethodHandlers.push(braintree_handler_1.braintreePaymentMethodHandler);
+            if (BraintreePlugin_1.options.storeCustomersInBraintree === true) {
+                config.customFields.Customer.push({
+                    name: 'braintreeCustomerId',
+                    type: 'string',
+                    label: [{ languageCode: core_1.LanguageCode.en, value: 'Braintree Customer ID' }],
+                    nullable: true,
+                    public: false,
+                    readonly: true,
+                });
+            }
+            return config;
+        },
+        shopApiExtensions: {
+            schema: apollo_server_core_1.gql `
+            extend type Query {
+                generateBraintreeClientToken(orderId: ID!): String!
+            }
+        `,
+            resolvers: [braintree_resolver_1.BraintreeResolver],
+        },
+    })
+], BraintreePlugin);
+exports.BraintreePlugin = BraintreePlugin;
+//# sourceMappingURL=braintree.plugin.js.map

package/package/braintree/braintree.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"braintree.plugin.js","sourceRoot":"","sources":["../../src/braintree/braintree.plugin.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,wCAAsF;AACtF,2DAAyC;AAEzC,2DAAoE;AACpE,6DAAyD;AACzD,2CAAuD;AAGvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AAgCH,IAAa,eAAe,uBAA5B,MAAa,eAAe;IAExB,MAAM,CAAC,IAAI,CAAC,OAA+B;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,iBAAe,CAAC;IAC3B,CAAC;CACJ,CAAA;AALU,uBAAO,GAA2B,EAAE,CAAC;AADnC,eAAe;IA/B3B,oBAAa,CAAC;QACX,OAAO,EAAE,CAAC,yBAAkB,CAAC;QAC7B,SAAS,EAAE;YACP;gBACI,OAAO,EAAE,oCAAwB;gBACjC,UAAU,EAAE,GAAG,EAAE,CAAC,iBAAe,CAAC,OAAO;aAC5C;SACJ;QACD,aAAa,EAAE,MAAM,CAAC,EAAE;YACpB,MAAM,CAAC,cAAc,CAAC,qBAAqB,CAAC,IAAI,CAAC,iDAA6B,CAAC,CAAC;YAChF,IAAI,iBAAe,CAAC,OAAO,CAAC,yBAAyB,KAAK,IAAI,EAAE;gBAC5D,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAC9B,IAAI,EAAE,qBAAqB;oBAC3B,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC;oBAC1E,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE,KAAK;oBACb,QAAQ,EAAE,IAAI;iBACjB,CAAC,CAAC;aACN;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,iBAAiB,EAAE;YACf,MAAM,EAAE,wBAAG,CAAA;;;;SAIV;YACD,SAAS,EAAE,CAAC,sCAAiB,CAAC;SACjC;KACJ,CAAC;GACW,eAAe,CAM3B;AANY,0CAAe"}

package/package/braintree/braintree.resolver.d.ts

@@ -1,10 +1,12 @@
 import { ID, OrderService, RequestContext, TransactionalConnection } from '@vendure/core';
+import { BraintreePluginOptions } from './types';
 export declare class BraintreeResolver {
     private connection;
     private orderService;
-    constructor(connection: TransactionalConnection, orderService: OrderService);
+    private options;
+    constructor(connection: TransactionalConnection, orderService: OrderService, options: BraintreePluginOptions);
     generateBraintreeClientToken(ctx: RequestContext, { orderId }: {
         orderId: ID;
-    }): Promise<string | undefined>;
+    }): Promise<string>;
     private getPaymentMethodArgs;
 }