@vendure/payments-plugin 1.3.4 → 1.4.2

package/package/mollie/mollie.plugin.js

@@ -0,0 +1,116 @@
+"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 MolliePlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MolliePlugin = void 0;
+const core_1 = require("@vendure/core");
+const constants_1 = require("./constants");
+const mollie_controller_1 = require("./mollie.controller");
+const mollie_handler_1 = require("./mollie.handler");
+/**
+ * @description
+ * Plugin to enable payments through the [Mollie platform](https://docs.mollie.com/).
+ * This plugin uses the Payments API from Mollie, not the Orders API.
+ *
+ * ## Requirements
+ *
+ * 1. You will need to create a Mollie account and get your apiKey in the dashboard.
+ * 2. Install the Payments plugin and the Mollie client:
+ *
+ *     `yarn add \@vendure/payments-plugin \@mollie/api-client`
+ *
+ *     or
+ *
+ *     `npm install \@vendure/payments-plugin \@mollie/api-client`
+ *
+ * ## Setup
+ *
+ * 1. Add the plugin to your VendureConfig `plugins` array:
+ *     ```TypeScript
+ *     import { MolliePlugin } from '\@vendure/payments-plugin/package/mollie';
+ *
+ *     // ...
+ *
+ *     plugins: [
+ *       MolliePlugin.init({ vendureHost: 'https://yourhost.io/' }),
+ *     ]
+ *     ```
+ * 2. Create a new PaymentMethod in the Admin UI, and select "Mollie payments" as the handler.
+ * 3. Set the Redirect URL. This is the url that is used to redirect the end-user, e.g. `https://storefront/order`
+ * 4. Set your Mollie apiKey in the `API Key` field.
+ *
+ * ## Storefront usage
+ *
+ * In your storefront you add a payment to an order using the `addPaymentToOrder` mutation. In this example, our Mollie
+ * PaymentMethod was given the code "mollie-payment-method".
+ *
+ * ```GraphQL
+ * mutation AddPaymentToOrder {
+ *   addPaymentToOrder(input: {
+ *     method: "mollie-payment-method"
+ *     metadata: {}
+ *   }) {
+ *    ...on Order {
+ *      id
+ *      state
+ *      payments {
+ *          id
+ *          metadata
+ *      }
+ *    }
+ *    ...on ErrorResult {
+ *      errorCode
+ *      message
+ *    }
+ *   }
+ * }
+ * ```
+ * The response will have
+ * a `order.payments.metadata.public.redirectLink` in it, which can be used to redirect your customer to the Mollie
+ * platform.
+ *
+ * After completing payment on the Mollie platform,
+ * the user is redirected to the configured redirect url + orderCode: `https://storefront/order/CH234X5`
+ *
+ * ## Local development
+ *
+ * Use something like [localtunnel](https://github.com/localtunnel/localtunnel) to test on localhost.
+ *
+ * ```bash
+ * npx localtunnel --port 3000 --subdomain my-shop-local-dev
+ * > your url is: https://my-shop-local-dev.loca.lt     <- use this as the vendureHost for local dev.
+ * ```
+ *
+ * @docsCategory payments-plugin
+ * @docsPage MolliePlugin
+ * @docsWeight 0
+ */
+let MolliePlugin = MolliePlugin_1 = class MolliePlugin {
+    /**
+     * @description
+     * Initialize the mollie payment plugin
+     * @param vendureHost is needed to pass to mollie for callback
+     */
+    static init(options) {
+        this.options = options;
+        return MolliePlugin_1;
+    }
+};
+MolliePlugin = MolliePlugin_1 = __decorate([
+    core_1.VendurePlugin({
+        imports: [core_1.PluginCommonModule],
+        controllers: [mollie_controller_1.MollieController],
+        providers: [{ provide: constants_1.PLUGIN_INIT_OPTIONS, useFactory: () => MolliePlugin_1.options }],
+        configuration: (config) => {
+            config.paymentOptions.paymentMethodHandlers.push(mollie_handler_1.molliePaymentHandler);
+            return config;
+        },
+    })
+], MolliePlugin);
+exports.MolliePlugin = MolliePlugin;
+//# sourceMappingURL=mollie.plugin.js.map

package/package/mollie/mollie.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mollie.plugin.js","sourceRoot":"","sources":["../../src/mollie/mollie.plugin.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,wCAAwF;AAExF,2CAAkD;AAClD,2DAAuD;AACvD,qDAAwD;AAiBxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AAUH,IAAa,YAAY,oBAAzB,MAAa,YAAY;IAGrB;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,OAA4B;QACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,cAAY,CAAC;IACxB,CAAC;CACJ,CAAA;AAZY,YAAY;IATxB,oBAAa,CAAC;QACX,OAAO,EAAE,CAAC,yBAAkB,CAAC;QAC7B,WAAW,EAAE,CAAC,oCAAgB,CAAC;QAC/B,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,+BAAmB,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,cAAY,CAAC,OAAO,EAAE,CAAC;QACrF,aAAa,EAAE,CAAC,MAA4B,EAAE,EAAE;YAC5C,MAAM,CAAC,cAAc,CAAC,qBAAqB,CAAC,IAAI,CAAC,qCAAoB,CAAC,CAAC;YACvE,OAAO,MAAM,CAAC;QAClB,CAAC;KACJ,CAAC;GACW,YAAY,CAYxB;AAZY,oCAAY"}

package/package.json

@@ -1,31 +1,39 @@
 {
-  "name": "@vendure/payments-plugin",
-  "version": "1.3.4",
-  "license": "MIT",
-  "main": "package/index.js",
-  "types": "package/index.d.ts",
-  "files": [
-    "package/**/*"
-  ],
-  "private": false,
-  "scripts": {
-    "watch": "tsc -p ./tsconfig.build.json --watch",
-    "build": "rimraf package && tsc -p ./tsconfig.build.json",
-    "lint": "tslint --fix --project ./",
-    "ci": "yarn build"
-  },
-  "homepage": "https://www.vendure.io/",
-  "funding": "https://github.com/sponsors/michaelbromley",
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@types/braintree": "^2.22.15",
-    "@vendure/common": "^1.3.4",
-    "@vendure/core": "^1.3.4",
-    "braintree": "^3.0.0",
-    "rimraf": "^3.0.2",
-    "typescript": "4.3.5"
-  },
-  "gitHead": "c56b85f6d87b5687595ae79c8889bd633101e0d5"
+    "name": "@vendure/payments-plugin",
+    "version": "1.4.2",
+    "license": "MIT",
+    "main": "package/index.js",
+    "types": "package/index.d.ts",
+    "files": [
+        "package/**/*"
+    ],
+    "private": false,
+    "scripts": {
+        "watch": "tsc -p ./tsconfig.build.json --watch",
+        "build": "rimraf package && tsc -p ./tsconfig.build.json",
+        "e2e": "jest --config ../../e2e-common/jest-config.js --runInBand --package=payments-plugin",
+        "lint": "tslint --fix --project ./",
+        "ci": "yarn build"
+    },
+    "homepage": "https://www.vendure.io/",
+    "funding": "https://github.com/sponsors/michaelbromley",
+    "publishConfig": {
+        "access": "public"
+    },
+    "peerDependencies": {
+        "@mollie/api-client": "3.x",
+        "braintree": "3.x"
+    },
+    "devDependencies": {
+        "@mollie/api-client": "^3.5.1",
+        "@types/braintree": "^2.22.15",
+        "@vendure/common": "^1.4.2",
+        "@vendure/core": "^1.4.2",
+        "@vendure/testing": "^1.4.2",
+        "braintree": "^3.0.0",
+        "nock": "^13.1.4",
+        "rimraf": "^3.0.2",
+        "typescript": "4.3.5"
+    },
+    "gitHead": "0418d311a406ce475d83b96ff96c100e8b468cc6"
 }

package/package/braintree/braintree-payment-method.d.ts

@@ -1,15 +0,0 @@
-import { PaymentMethodHandler } from '@vendure/core';
-/**
- * The handler for Braintree payments.
- */
-export declare const braintreePaymentMethodHandler: PaymentMethodHandler<{
-    merchantId: {
-        type: "string";
-    };
-    publicKey: {
-        type: "string";
-    };
-    privateKey: {
-        type: "string";
-    };
-}>;

package/package/braintree/braintree-payment-method.js

@@ -1,79 +0,0 @@
-"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");
-/**
- * The handler for Braintree payments.
- */
-exports.braintreePaymentMethodHandler = new core_1.PaymentMethodHandler({
-    code: 'braintree',
-    description: [{ languageCode: generated_types_1.LanguageCode.en, value: 'Braintree' }],
-    args: {
-        merchantId: { type: 'string' },
-        publicKey: { type: 'string' },
-        privateKey: { type: 'string' },
-    },
-    async createPayment(ctx, order, amount, args, metadata) {
-        const gateway = braintree_common_1.getGateway(args);
-        try {
-            const response = await gateway.transaction.sale({
-                amount: (amount / 100).toString(10),
-                orderId: order.code,
-                paymentMethodNonce: metadata.nonce,
-                options: {
-                    submitForSettlement: true,
-                },
-            });
-            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),
-            };
-        }
-        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);
-        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,
-        };
-    },
-});
-//# sourceMappingURL=braintree-payment-method.js.map

package/package/braintree/braintree-payment-method.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"braintree-payment-method.js","sourceRoot":"","sources":["../../src/braintree/braintree-payment-method.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AACnE,wCAA6D;AAE7D,yDAAgF;AAChF,2CAAwC;AAExC;;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,WAAW,EAAE,CAAC;IACpE,IAAI,EAAE;QACF,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KACjC;IAED,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ;QAClD,MAAM,OAAO,GAAG,6BAAU,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI;YACA,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;gBAC5C,MAAM,EAAE,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnC,OAAO,EAAE,KAAK,CAAC,IAAI;gBACnB,kBAAkB,EAAE,QAAQ,CAAC,KAAK;gBAClC,OAAO,EAAE;oBACL,mBAAmB,EAAE,IAAI;iBAC5B;aACJ,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;gBACnB,OAAO;oBACH,MAAM;oBACN,KAAK,EAAE,UAAmB;oBAC1B,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;oBACtC,YAAY,EAAE,QAAQ,CAAC,OAAO;oBAC9B,QAAQ,EAAE,iDAA8B,CAAC,QAAQ,CAAC,WAAW,CAAC;iBACjE,CAAC;aACL;YACD,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,SAAkB;gBACzB,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE;gBACtC,QAAQ,EAAE,iDAA8B,CAAC,QAAQ,CAAC,WAAW,CAAC;aACjE,CAAC;SACL;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,CAAC,CAAC;QACjC,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"}

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

@@ -1,5 +0,0 @@
-/**
- * This plugin implements the Braintree (https://www.braintreepayments.com/) payment provider.
- */
-export declare class BraintreePlugin {
-}

package/package/braintree/braintree-plugin.js

@@ -1,38 +0,0 @@
-"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;
-};
-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_payment_method_1 = require("./braintree-payment-method");
-const braintree_resolver_1 = require("./braintree.resolver");
-/**
- * This plugin implements the Braintree (https://www.braintreepayments.com/) payment provider.
- */
-let BraintreePlugin = class BraintreePlugin {
-};
-BraintreePlugin = __decorate([
-    core_1.VendurePlugin({
-        imports: [core_1.PluginCommonModule],
-        providers: [],
-        configuration: config => {
-            config.paymentOptions.paymentMethodHandlers.push(braintree_payment_method_1.braintreePaymentMethodHandler);
-            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

@@ -1 +0,0 @@
-{"version":3,"file":"braintree-plugin.js","sourceRoot":"","sources":["../../src/braintree/braintree-plugin.ts"],"names":[],"mappings":";;;;;;;;;AAAA,wCAAkE;AAClE,2DAAyC;AAEzC,yEAA2E;AAC3E,6DAAyD;AAEzD;;GAEG;AAiBH,IAAa,eAAe,GAA5B,MAAa,eAAe;CAAG,CAAA;AAAlB,eAAe;IAhB3B,oBAAa,CAAC;QACX,OAAO,EAAE,CAAC,yBAAkB,CAAC;QAC7B,SAAS,EAAE,EAAE;QACb,aAAa,EAAE,MAAM,CAAC,EAAE;YACpB,MAAM,CAAC,cAAc,CAAC,qBAAqB,CAAC,IAAI,CAAC,wDAA6B,CAAC,CAAC;YAChF,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,CAAG;AAAlB,0CAAe"}