@deenruv/payments-plugin 1.0.0

package/package/stripe/stripe-client.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeenruvStripeClient = void 0;
+const stripe_1 = __importDefault(require("stripe"));
+/**
+ * Wrapper around the Stripe client that exposes ApiKey and WebhookSecret
+ */
+class DeenruvStripeClient extends stripe_1.default {
+    constructor(apiKey, webhookSecret) {
+        super(apiKey, {
+            apiVersion: null, // Use accounts default version
+        });
+        this.apiKey = apiKey;
+        this.webhookSecret = webhookSecret;
+    }
+}
+exports.DeenruvStripeClient = DeenruvStripeClient;
+//# sourceMappingURL=stripe-client.js.map

package/package/stripe/stripe-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe-client.js","sourceRoot":"","sources":["../../src/stripe/stripe-client.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAE5B;;GAEG;AACH,MAAa,mBAAoB,SAAQ,gBAAM;IAC7C,YACU,MAAc,EACf,aAAqB;QAE5B,KAAK,CAAC,MAAM,EAAE;YACZ,UAAU,EAAE,IAA0C,EAAE,+BAA+B;SACxF,CAAC,CAAC;QALK,WAAM,GAAN,MAAM,CAAQ;QACf,kBAAa,GAAb,aAAa,CAAQ;IAK9B,CAAC;CACF;AATD,kDASC"}

package/package/stripe/stripe-utils.d.ts

@@ -0,0 +1,19 @@
+import { Order } from "@deenruv/core";
+/**
+ * @description
+ * From the [Stripe docs](https://stripe.com/docs/currencies#zero-decimal):
+ * > All API requests expect amounts to be provided in a currency’s smallest unit.
+ * > For example, to charge 10 USD, provide an amount value of 1000 (that is, 1000 cents).
+ * > For zero-decimal currencies, still provide amounts as an integer but without multiplying by 100.
+ * > For example, to charge ¥500, provide an amount value of 500.
+ *
+ * Therefore, for a fractionless currency like JPY, we need to divide the amount by 100 (since Deenruv always
+ * stores money amounts multiplied by 100). See https://github.com/deenruv-ecommerce/deenruv/issues/1630
+ */
+export declare function getAmountInStripeMinorUnits(order: Order): number;
+/**
+ * @description
+ * Performs the reverse of `getAmountInStripeMinorUnits` - converting the Stripe minor units into the format
+ * used by Deenruv.
+ */
+export declare function getAmountFromStripeMinorUnits(order: Order, stripeAmount: number): number;

package/package/stripe/stripe-utils.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAmountFromStripeMinorUnits = exports.getAmountInStripeMinorUnits = void 0;
+/**
+ * @description
+ * From the [Stripe docs](https://stripe.com/docs/currencies#zero-decimal):
+ * > All API requests expect amounts to be provided in a currency’s smallest unit.
+ * > For example, to charge 10 USD, provide an amount value of 1000 (that is, 1000 cents).
+ * > For zero-decimal currencies, still provide amounts as an integer but without multiplying by 100.
+ * > For example, to charge ¥500, provide an amount value of 500.
+ *
+ * Therefore, for a fractionless currency like JPY, we need to divide the amount by 100 (since Deenruv always
+ * stores money amounts multiplied by 100). See https://github.com/deenruv-ecommerce/deenruv/issues/1630
+ */
+function getAmountInStripeMinorUnits(order) {
+    return currencyHasFractionPart(order.currencyCode)
+        ? order.totalWithTax
+        : Math.round(order.totalWithTax / 100);
+}
+exports.getAmountInStripeMinorUnits = getAmountInStripeMinorUnits;
+/**
+ * @description
+ * Performs the reverse of `getAmountInStripeMinorUnits` - converting the Stripe minor units into the format
+ * used by Deenruv.
+ */
+function getAmountFromStripeMinorUnits(order, stripeAmount) {
+    return currencyHasFractionPart(order.currencyCode)
+        ? stripeAmount
+        : stripeAmount * 100;
+}
+exports.getAmountFromStripeMinorUnits = getAmountFromStripeMinorUnits;
+function currencyHasFractionPart(currencyCode) {
+    const parts = new Intl.NumberFormat(undefined, {
+        style: "currency",
+        currency: currencyCode,
+        currencyDisplay: "symbol",
+    }).formatToParts(123.45);
+    return !!parts.find((p) => p.type === "fraction");
+}
+//# sourceMappingURL=stripe-utils.js.map

package/package/stripe/stripe-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe-utils.js","sourceRoot":"","sources":["../../src/stripe/stripe-utils.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACH,SAAgB,2BAA2B,CAAC,KAAY;IACtD,OAAO,uBAAuB,CAAC,KAAK,CAAC,YAAY,CAAC;QAChD,CAAC,CAAC,KAAK,CAAC,YAAY;QACpB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,GAAG,CAAC,CAAC;AAC3C,CAAC;AAJD,kEAIC;AAED;;;;GAIG;AACH,SAAgB,6BAA6B,CAC3C,KAAY,EACZ,YAAoB;IAEpB,OAAO,uBAAuB,CAAC,KAAK,CAAC,YAAY,CAAC;QAChD,CAAC,CAAC,YAAY;QACd,CAAC,CAAC,YAAY,GAAG,GAAG,CAAC;AACzB,CAAC;AAPD,sEAOC;AAED,SAAS,uBAAuB,CAAC,YAA0B;IACzD,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE;QAC7C,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,YAAY;QACtB,eAAe,EAAE,QAAQ;KAC1B,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAEzB,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;AACpD,CAAC"}

package/package/stripe/stripe.controller.d.ts

@@ -0,0 +1,15 @@
+import { OrderService, PaymentMethodService, RequestContextService, TransactionalConnection } from "@deenruv/core";
+import type { Response } from "express";
+import { StripeService } from "./stripe.service";
+import { RequestWithRawBody } from "./types";
+export declare class StripeController {
+    private paymentMethodService;
+    private orderService;
+    private stripeService;
+    private requestContextService;
+    private connection;
+    constructor(paymentMethodService: PaymentMethodService, orderService: OrderService, stripeService: StripeService, requestContextService: RequestContextService, connection: TransactionalConnection);
+    webhook(signature: string | undefined, request: RequestWithRawBody, response: Response): Promise<void>;
+    private createContext;
+    private getPaymentMethod;
+}

package/package/stripe/stripe.controller.js

@@ -0,0 +1,135 @@
+"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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StripeController = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@deenruv/core");
+const generated_graphql_shop_errors_1 = require("@deenruv/core/dist/common/error/generated-graphql-shop-errors");
+const constants_1 = require("./constants");
+const stripe_handler_1 = require("./stripe.handler");
+const stripe_service_1 = require("./stripe.service");
+const missingHeaderErrorMessage = "Missing stripe-signature header";
+const signatureErrorMessage = "Error verifying Stripe webhook signature";
+const noPaymentIntentErrorMessage = "No payment intent in the event payload";
+let StripeController = exports.StripeController = class StripeController {
+    constructor(paymentMethodService, orderService, stripeService, requestContextService, connection) {
+        this.paymentMethodService = paymentMethodService;
+        this.orderService = orderService;
+        this.stripeService = stripeService;
+        this.requestContextService = requestContextService;
+        this.connection = connection;
+    }
+    async webhook(signature, request, response) {
+        if (!signature) {
+            core_1.Logger.error(missingHeaderErrorMessage, constants_1.loggerCtx);
+            response.status(common_1.HttpStatus.BAD_REQUEST).send(missingHeaderErrorMessage);
+            return;
+        }
+        const event = JSON.parse(request.body.toString());
+        const paymentIntent = event.data.object;
+        if (!paymentIntent) {
+            core_1.Logger.error(noPaymentIntentErrorMessage, constants_1.loggerCtx);
+            response.status(common_1.HttpStatus.BAD_REQUEST).send(noPaymentIntentErrorMessage);
+            return;
+        }
+        const { metadata: { channelToken, orderCode, orderId } = {} } = paymentIntent;
+        const outerCtx = await this.createContext(channelToken, request);
+        await this.connection.withTransaction(outerCtx, async (ctx) => {
+            var _a, _b;
+            const order = await this.orderService.findOneByCode(ctx, orderCode);
+            if (!order) {
+                throw new Error(`Unable to find order ${orderCode}, unable to settle payment ${paymentIntent.id}!`);
+            }
+            try {
+                // Throws an error if the signature is invalid
+                await this.stripeService.constructEventFromPayload(ctx, order, request.rawBody, signature);
+            }
+            catch (e) {
+                core_1.Logger.error(`${signatureErrorMessage} ${signature}: ${e === null || e === void 0 ? void 0 : e.message}`, constants_1.loggerCtx);
+                response.status(common_1.HttpStatus.BAD_REQUEST).send(signatureErrorMessage);
+                return;
+            }
+            if (event.type === "payment_intent.payment_failed") {
+                const message = (_b = (_a = paymentIntent.last_payment_error) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : "unknown error";
+                core_1.Logger.warn(`Payment for order ${orderCode} failed: ${message}`, constants_1.loggerCtx);
+                response.status(common_1.HttpStatus.OK).send("Ok");
+                return;
+            }
+            if (event.type !== "payment_intent.succeeded") {
+                // This should never happen as the webhook is configured to receive
+                // payment_intent.succeeded and payment_intent.payment_failed events only
+                core_1.Logger.info(`Received ${event.type} status update for order ${orderCode}`, constants_1.loggerCtx);
+                return;
+            }
+            if (order.state !== "ArrangingPayment") {
+                const transitionToStateResult = await this.orderService.transitionToState(ctx, orderId, "ArrangingPayment");
+                if (transitionToStateResult instanceof generated_graphql_shop_errors_1.OrderStateTransitionError) {
+                    core_1.Logger.error(`Error transitioning order ${orderCode} to ArrangingPayment state: ${transitionToStateResult.message}`, constants_1.loggerCtx);
+                    return;
+                }
+            }
+            const paymentMethod = await this.getPaymentMethod(ctx);
+            const addPaymentToOrderResult = await this.orderService.addPaymentToOrder(ctx, orderId, {
+                method: paymentMethod.code,
+                metadata: {
+                    paymentIntentAmountReceived: paymentIntent.amount_received,
+                    paymentIntentId: paymentIntent.id,
+                },
+            });
+            if (!(addPaymentToOrderResult instanceof core_1.Order)) {
+                core_1.Logger.error(`Error adding payment to order ${orderCode}: ${addPaymentToOrderResult.message}`, constants_1.loggerCtx);
+                return;
+            }
+            // The payment intent ID is added to the order only if we can reach this point.
+            core_1.Logger.info(`Stripe payment intent id ${paymentIntent.id} added to order ${orderCode}`, constants_1.loggerCtx);
+        });
+        // Send the response status only if we didn't sent anything yet.
+        if (!response.headersSent) {
+            response.status(common_1.HttpStatus.OK).send("Ok");
+        }
+    }
+    async createContext(channelToken, req) {
+        return this.requestContextService.create({
+            apiType: "admin",
+            channelOrToken: channelToken,
+            req,
+            languageCode: core_1.LanguageCode.en,
+        });
+    }
+    async getPaymentMethod(ctx) {
+        const method = (await this.paymentMethodService.findAll(ctx)).items.find((m) => m.handler.code === stripe_handler_1.stripePaymentMethodHandler.code);
+        if (!method) {
+            throw new core_1.InternalServerError(`[${constants_1.loggerCtx}] Could not find Stripe PaymentMethod`);
+        }
+        return method;
+    }
+};
+__decorate([
+    (0, common_1.Post)("stripe"),
+    __param(0, (0, common_1.Headers)("stripe-signature")),
+    __param(1, (0, common_1.Req)()),
+    __param(2, (0, common_1.Res)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], StripeController.prototype, "webhook", null);
+exports.StripeController = StripeController = __decorate([
+    (0, common_1.Controller)("payments"),
+    __metadata("design:paramtypes", [core_1.PaymentMethodService,
+        core_1.OrderService,
+        stripe_service_1.StripeService,
+        core_1.RequestContextService,
+        core_1.TransactionalConnection])
+], StripeController);
+//# sourceMappingURL=stripe.controller.js.map

package/package/stripe/stripe.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe.controller.js","sourceRoot":"","sources":["../../src/stripe/stripe.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAOwB;AAExB,wCASuB;AACvB,iHAA0G;AAI1G,2CAAwC;AACxC,qDAA8D;AAC9D,qDAAiD;AAGjD,MAAM,yBAAyB,GAAG,iCAAiC,CAAC;AACpE,MAAM,qBAAqB,GAAG,0CAA0C,CAAC;AACzE,MAAM,2BAA2B,GAAG,wCAAwC,CAAC;AAGtE,IAAM,gBAAgB,8BAAtB,MAAM,gBAAgB;IAC3B,YACU,oBAA0C,EAC1C,YAA0B,EAC1B,aAA4B,EAC5B,qBAA4C,EAC5C,UAAmC;QAJnC,yBAAoB,GAApB,oBAAoB,CAAsB;QAC1C,iBAAY,GAAZ,YAAY,CAAc;QAC1B,kBAAa,GAAb,aAAa,CAAe;QAC5B,0BAAqB,GAArB,qBAAqB,CAAuB;QAC5C,eAAU,GAAV,UAAU,CAAyB;IAC1C,CAAC;IAGE,AAAN,KAAK,CAAC,OAAO,CACkB,SAA6B,EACnD,OAA2B,EAC3B,QAAkB;QAEzB,IAAI,CAAC,SAAS,EAAE;YACd,aAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,qBAAS,CAAC,CAAC;YACnD,QAAQ,CAAC,MAAM,CAAC,mBAAU,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;YACxE,OAAO;SACR;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAiB,CAAC;QAClE,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,MAA8B,CAAC;QAEhE,IAAI,CAAC,aAAa,EAAE;YAClB,aAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE,qBAAS,CAAC,CAAC;YACrD,QAAQ,CAAC,MAAM,CAAC,mBAAU,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;YAC1E,OAAO;SACR;QAED,MAAM,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,GAC3D,aAAa,CAAC;QAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAEjE,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;;YAC5D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAEpE,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,KAAK,CACb,wBAAwB,SAAS,8BAA8B,aAAa,CAAC,EAAE,GAAG,CACnF,CAAC;aACH;YAED,IAAI;gBACF,8CAA8C;gBAC9C,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAChD,GAAG,EACH,KAAK,EACL,OAAO,CAAC,OAAO,EACf,SAAS,CACV,CAAC;aACH;YAAC,OAAO,CAAM,EAAE;gBACf,aAAM,CAAC,KAAK,CACV,GAAG,qBAAqB,IAAI,SAAS,KAAM,CAAW,aAAX,CAAC,uBAAD,CAAC,CAAY,OAAO,EAAE,EACjE,qBAAS,CACV,CAAC;gBACF,QAAQ,CAAC,MAAM,CAAC,mBAAU,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;gBACpE,OAAO;aACR;YAED,IAAI,KAAK,CAAC,IAAI,KAAK,+BAA+B,EAAE;gBAClD,MAAM,OAAO,GACX,MAAA,MAAA,aAAa,CAAC,kBAAkB,0CAAE,OAAO,mCAAI,eAAe,CAAC;gBAC/D,aAAM,CAAC,IAAI,CACT,qBAAqB,SAAS,YAAY,OAAO,EAAE,EACnD,qBAAS,CACV,CAAC;gBACF,QAAQ,CAAC,MAAM,CAAC,mBAAU,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1C,OAAO;aACR;YAED,IAAI,KAAK,CAAC,IAAI,KAAK,0BAA0B,EAAE;gBAC7C,mEAAmE;gBACnE,yEAAyE;gBACzE,aAAM,CAAC,IAAI,CACT,YAAY,KAAK,CAAC,IAAI,4BAA4B,SAAS,EAAE,EAC7D,qBAAS,CACV,CAAC;gBACF,OAAO;aACR;YAED,IAAI,KAAK,CAAC,KAAK,KAAK,kBAAkB,EAAE;gBACtC,MAAM,uBAAuB,GAC3B,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,CACvC,GAAG,EACH,OAAO,EACP,kBAAkB,CACnB,CAAC;gBAEJ,IAAI,uBAAuB,YAAY,yDAAyB,EAAE;oBAChE,aAAM,CAAC,KAAK,CACV,6BAA6B,SAAS,+BAA+B,uBAAuB,CAAC,OAAO,EAAE,EACtG,qBAAS,CACV,CAAC;oBACF,OAAO;iBACR;aACF;YAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YAEvD,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,CACvE,GAAG,EACH,OAAO,EACP;gBACE,MAAM,EAAE,aAAa,CAAC,IAAI;gBAC1B,QAAQ,EAAE;oBACR,2BAA2B,EAAE,aAAa,CAAC,eAAe;oBAC1D,eAAe,EAAE,aAAa,CAAC,EAAE;iBAClC;aACF,CACF,CAAC;YAEF,IAAI,CAAC,CAAC,uBAAuB,YAAY,YAAK,CAAC,EAAE;gBAC/C,aAAM,CAAC,KAAK,CACV,iCAAiC,SAAS,KAAK,uBAAuB,CAAC,OAAO,EAAE,EAChF,qBAAS,CACV,CAAC;gBACF,OAAO;aACR;YAED,+EAA+E;YAC/E,aAAM,CAAC,IAAI,CACT,4BAA4B,aAAa,CAAC,EAAE,mBAAmB,SAAS,EAAE,EAC1E,qBAAS,CACV,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,gEAAgE;QAChE,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE;YACzB,QAAQ,CAAC,MAAM,CAAC,mBAAU,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC3C;IACH,CAAC;IAEO,KAAK,CAAC,aAAa,CACzB,YAAoB,EACpB,GAAuB;QAEvB,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;YACvC,OAAO,EAAE,OAAO;YAChB,cAAc,EAAE,YAAY;YAC5B,GAAG;YACH,YAAY,EAAE,mBAAY,CAAC,EAAE;SAC9B,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,GAAmB;QAChD,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CACtE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,2CAA0B,CAAC,IAAI,CAC1D,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,0BAAmB,CAC3B,IAAI,qBAAS,uCAAuC,CACrD,CAAC;SACH;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AApJO;IADL,IAAA,aAAI,EAAC,QAAQ,CAAC;IAEZ,WAAA,IAAA,gBAAO,EAAC,kBAAkB,CAAC,CAAA;IAC3B,WAAA,IAAA,YAAG,GAAE,CAAA;IACL,WAAA,IAAA,YAAG,GAAE,CAAA;;;;+CAsHP;2BAnIU,gBAAgB;IAD5B,IAAA,mBAAU,EAAC,UAAU,CAAC;qCAGW,2BAAoB;QAC5B,mBAAY;QACX,8BAAa;QACL,4BAAqB;QAChC,8BAAuB;GANlC,gBAAgB,CA8J5B"}

package/package/stripe/stripe.handler.d.ts

@@ -0,0 +1,30 @@
+import { LanguageCode, PaymentMethodHandler } from "@deenruv/core";
+/**
+ * The handler for Stripe payments.
+ */
+export declare const stripePaymentMethodHandler: PaymentMethodHandler<{
+    apiKey: {
+        type: "string";
+        label: {
+            languageCode: LanguageCode.en;
+            value: string;
+        }[];
+        ui: {
+            component: string;
+        };
+    };
+    webhookSecret: {
+        type: "string";
+        label: {
+            languageCode: LanguageCode.en;
+            value: string;
+        }[];
+        description: {
+            languageCode: LanguageCode.en;
+            value: string;
+        }[];
+        ui: {
+            component: string;
+        };
+    };
+}>;

package/package/stripe/stripe.handler.js

@@ -0,0 +1,103 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripePaymentMethodHandler = void 0;
+const core_1 = require("@deenruv/core");
+const stripe_1 = __importDefault(require("stripe"));
+const stripe_utils_1 = require("./stripe-utils");
+const stripe_service_1 = require("./stripe.service");
+const { StripeError } = stripe_1.default.errors;
+let stripeService;
+/**
+ * The handler for Stripe payments.
+ */
+exports.stripePaymentMethodHandler = new core_1.PaymentMethodHandler({
+    code: "stripe",
+    description: [{ languageCode: core_1.LanguageCode.en, value: "Stripe payments" }],
+    args: {
+        apiKey: {
+            type: "string",
+            label: [{ languageCode: core_1.LanguageCode.en, value: "API Key" }],
+            ui: { component: "password-form-input" },
+        },
+        webhookSecret: {
+            type: "string",
+            label: [
+                {
+                    languageCode: core_1.LanguageCode.en,
+                    value: "Webhook secret",
+                },
+            ],
+            description: [
+                {
+                    languageCode: core_1.LanguageCode.en,
+                    value: "Secret to validate incoming webhooks. Get this from your Stripe dashboard",
+                },
+            ],
+            ui: { component: "password-form-input" },
+        },
+    },
+    init(injector) {
+        stripeService = injector.get(stripe_service_1.StripeService);
+    },
+    createPayment(ctx, order, amount, ___, metadata) {
+        // Payment is already settled in Stripe by the time the webhook in stripe.controller.ts
+        // adds the payment to the order
+        if (ctx.apiType !== "admin") {
+            throw Error(`CreatePayment is not allowed for apiType '${ctx.apiType}'`);
+        }
+        const amountInMinorUnits = (0, stripe_utils_1.getAmountFromStripeMinorUnits)(order, metadata.paymentIntentAmountReceived);
+        return {
+            amount: amountInMinorUnits,
+            state: "Settled",
+            transactionId: metadata.paymentIntentId,
+        };
+    },
+    settlePayment() {
+        return {
+            success: true,
+        };
+    },
+    async createRefund(ctx, input, amount, order, payment, args) {
+        // TODO: Consider passing the "reason" property once this feature request is addressed:
+        // https://github.com/deenruv-ecommerce/deenruv/issues/893
+        try {
+            const refund = await stripeService.createRefund(ctx, order, payment, amount);
+            if (refund.status === "succeeded") {
+                return {
+                    state: "Settled",
+                    transactionId: payment.transactionId,
+                };
+            }
+            if (refund.status === "pending") {
+                return {
+                    state: "Pending",
+                    transactionId: payment.transactionId,
+                };
+            }
+            return {
+                state: "Failed",
+                transactionId: payment.transactionId,
+                metadata: {
+                    message: refund.failure_reason,
+                },
+            };
+        }
+        catch (e) {
+            if (e instanceof StripeError) {
+                return {
+                    state: "Failed",
+                    transactionId: payment.transactionId,
+                    metadata: {
+                        type: e.type,
+                        message: e.message,
+                    },
+                };
+            }
+            throw e;
+        }
+    },
+});
+//# sourceMappingURL=stripe.handler.js.map

package/package/stripe/stripe.handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe.handler.js","sourceRoot":"","sources":["../../src/stripe/stripe.handler.ts"],"names":[],"mappings":";;;;;;AAAA,wCAOuB;AACvB,oDAA4B;AAE5B,iDAA+D;AAC/D,qDAAiD;AAEjD,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAM,CAAC,MAAM,CAAC;AAEtC,IAAI,aAA4B,CAAC;AAEjC;;GAEG;AACU,QAAA,0BAA0B,GAAG,IAAI,2BAAoB,CAAC;IACjE,IAAI,EAAE,QAAQ;IAEd,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAE1E,IAAI,EAAE;QACJ,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;YAC5D,EAAE,EAAE,EAAE,SAAS,EAAE,qBAAqB,EAAE;SACzC;QACD,aAAa,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE;gBACL;oBACE,YAAY,EAAE,mBAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,gBAAgB;iBACxB;aACF;YACD,WAAW,EAAE;gBACX;oBACE,YAAY,EAAE,mBAAY,CAAC,EAAE;oBAC7B,KAAK,EACH,2EAA2E;iBAC9E;aACF;YACD,EAAE,EAAE,EAAE,SAAS,EAAE,qBAAqB,EAAE;SACzC;KACF;IAED,IAAI,CAAC,QAAkB;QACrB,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,8BAAa,CAAC,CAAC;IAC9C,CAAC;IAED,aAAa,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ;QAC7C,uFAAuF;QACvF,gCAAgC;QAChC,IAAI,GAAG,CAAC,OAAO,KAAK,OAAO,EAAE;YAC3B,MAAM,KAAK,CAAC,6CAA6C,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC;SAC1E;QACD,MAAM,kBAAkB,GAAG,IAAA,4CAA6B,EACtD,KAAK,EACL,QAAQ,CAAC,2BAA2B,CACrC,CAAC;QACF,OAAO;YACL,MAAM,EAAE,kBAAkB;YAC1B,KAAK,EAAE,SAAkB;YACzB,aAAa,EAAE,QAAQ,CAAC,eAAe;SACxC,CAAC;IACJ,CAAC;IAED,aAAa;QACX,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,GAAG,EACH,KAAK,EACL,MAAM,EACN,KAAK,EACL,OAAO,EACP,IAAI;QAEJ,uFAAuF;QACvF,0DAA0D;QAC1D,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,YAAY,CAC7C,GAAG,EACH,KAAK,EACL,OAAO,EACP,MAAM,CACP,CAAC;YACF,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE;gBACjC,OAAO;oBACL,KAAK,EAAE,SAAkB;oBACzB,aAAa,EAAE,OAAO,CAAC,aAAa;iBACrC,CAAC;aACH;YAED,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;gBAC/B,OAAO;oBACL,KAAK,EAAE,SAAkB;oBACzB,aAAa,EAAE,OAAO,CAAC,aAAa;iBACrC,CAAC;aACH;YAED,OAAO;gBACL,KAAK,EAAE,QAAiB;gBACxB,aAAa,EAAE,OAAO,CAAC,aAAa;gBACpC,QAAQ,EAAE;oBACR,OAAO,EAAE,MAAM,CAAC,cAAc;iBAC/B;aACF,CAAC;SACH;QAAC,OAAO,CAAM,EAAE;YACf,IAAI,CAAC,YAAY,WAAW,EAAE;gBAC5B,OAAO;oBACL,KAAK,EAAE,QAAiB;oBACxB,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,QAAQ,EAAE;wBACR,IAAI,EAAE,CAAC,CAAC,IAAI;wBACZ,OAAO,EAAE,CAAC,CAAC,OAAO;qBACnB;iBACF,CAAC;aACH;YACD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;CACF,CAAC,CAAC"}

package/package/stripe/stripe.plugin.d.ts

@@ -0,0 +1,158 @@
+import { Type } from "@deenruv/core";
+import { StripePluginOptions } from "./types";
+/**
+ * @description
+ * Plugin to enable payments through [Stripe](https://stripe.com/docs) via the Payment Intents API.
+ *
+ * ## Requirements
+ *
+ * 1. You will need to create a Stripe account and get your secret key in the dashboard.
+ * 2. Create a webhook endpoint in the Stripe dashboard (Developers -> Webhooks, "Add an endpoint") which listens to the `payment_intent.succeeded`
+ * and `payment_intent.payment_failed` events. The URL should be `https://my-server.com/payments/stripe`, where
+ * `my-server.com` is the host of your Deenruv server. *Note:* for local development, you'll need to use
+ * the Stripe CLI to test your webhook locally. See the _local development_ section below.
+ * 3. Get the signing secret for the newly created webhook.
+ * 4. Install the Payments plugin and the Stripe Node library:
+ *
+ *     `yarn add \@deenruv/payments-plugin stripe`
+ *
+ *     or
+ *
+ *     `npm install \@deenruv/payments-plugin stripe`
+ *
+ * ## Setup
+ *
+ * 1. Add the plugin to your DeenruvConfig `plugins` array:
+ *     ```ts
+ *     import { StripePlugin } from '\@deenruv/payments-plugin/package/stripe';
+ *
+ *     // ...
+ *
+ *     plugins: [
+ *       StripePlugin.init({
+ *         // This prevents different customers from using the same PaymentIntent
+ *         storeCustomersInStripe: true,
+ *       }),
+ *     ]
+ *     ````
+ *     For all the plugin options, see the {@link StripePluginOptions} type.
+ * 2. Create a new PaymentMethod in the Admin UI, and select "Stripe payments" as the handler.
+ * 3. Set the webhook secret and API key in the PaymentMethod form.
+ *
+ * ## Storefront usage
+ *
+ * The plugin is designed to work with the [Custom payment flow](https://stripe.com/docs/payments/accept-a-payment?platform=web&ui=elements).
+ * In this flow, Stripe provides libraries which handle the payment UI and confirmation for you. You can install it in your storefront project
+ * with:
+ *
+ * ```shell
+ * yarn add \@stripe/stripe-js
+ * # or
+ * npm install \@stripe/stripe-js
+ * ```
+ *
+ * If you are using React, you should also consider installing `@stripe/react-stripe-js`, which is a wrapper around Stripe Elements.
+ *
+ * The high-level workflow is:
+ * 1. Create a "payment intent" on the server by executing the `createStripePaymentIntent` mutation which is exposed by this plugin.
+ * 2. Use the returned client secret to instantiate the Stripe Payment Element:
+ *    ```ts
+ *    import { Elements } from '\@stripe/react-stripe-js';
+ *    import { loadStripe, Stripe } from '\@stripe/stripe-js';
+ *    import { CheckoutForm } from './CheckoutForm';
+ *
+ *    const stripePromise = getStripe('pk_test_....wr83u');
+ *
+ *    type StripePaymentsProps = {
+ *      clientSecret: string;
+ *      orderCode: string;
+ *    }
+ *
+ *    export function StripePayments({ clientSecret, orderCode }: StripePaymentsProps) {
+ *      const options = {
+ *        // passing the client secret obtained from the server
+ *        clientSecret,
+ *      }
+ *      return (
+ *        <Elements stripe={stripePromise} options={options}>
+ *          <CheckoutForm orderCode={orderCode} />
+ *        </Elements>
+ *      );
+ *    }
+ *    ```
+ *    ```ts
+ *    // CheckoutForm.tsx
+ *    import { useStripe, useElements, PaymentElement } from '\@stripe/react-stripe-js';
+ *    import { FormEvent } from 'react';
+ *
+ *    export const CheckoutForm = ({ orderCode }: { orderCode: string }) => {
+ *      const stripe = useStripe();
+ *      const elements = useElements();
+ *
+ *      const handleSubmit = async (event: FormEvent) => {
+ *        // We don't want to let default form submission happen here,
+ *        // which would refresh the page.
+ *        event.preventDefault();
+ *
+ *        if (!stripe || !elements) {
+ *          // Stripe.js has not yet loaded.
+ *          // Make sure to disable form submission until Stripe.js has loaded.
+ *          return;
+ *        }
+ *
+ *        const result = await stripe.confirmPayment({
+ *          //`Elements` instance that was used to create the Payment Element
+ *          elements,
+ *          confirmParams: {
+ *            return_url: location.origin + `/checkout/confirmation/${orderCode}`,
+ *          },
+ *        });
+ *
+ *        if (result.error) {
+ *          // Show error to your customer (for example, payment details incomplete)
+ *          console.log(result.error.message);
+ *        } else {
+ *          // Your customer will be redirected to your `return_url`. For some payment
+ *          // methods like iDEAL, your customer will be redirected to an intermediate
+ *          // site first to authorize the payment, then redirected to the `return_url`.
+ *        }
+ *      };
+ *
+ *      return (
+ *        <form onSubmit={handleSubmit}>
+ *          <PaymentElement />
+ *          <button disabled={!stripe}>Submit</button>
+ *        </form>
+ *      );
+ *    };
+ *    ```
+ * 3. Once the form is submitted and Stripe processes the payment, the webhook takes care of updating the order without additional action
+ * in the storefront. As in the code above, the customer will be redirected to `/checkout/confirmation/${orderCode}`.
+ *
+ * :::info
+ * A full working storefront example of the Stripe integration can be found in the
+ * [Remix Starter repo](https://github.com/deenruv-ecommerce/storefront-remix-starter/tree/master/app/components/checkout/stripe)
+ * :::
+ *
+ * ## Local development
+ *
+ * 1. Download & install the Stripe CLI: https://stripe.com/docs/stripe-cli
+ * 2. From your Stripe dashboard, go to Developers -> Webhooks and click "Add an endpoint" and follow the instructions
+ * under "Test in a local environment".
+ * 3. The Stripe CLI command will look like
+ *    ```shell
+ *    stripe listen --forward-to localhost:3000/payments/stripe
+ *    ```
+ * 4. The Stripe CLI will create a webhook signing secret you can then use in your config of the StripePlugin.
+ *
+ * @docsCategory core plugins/PaymentsPlugin
+ * @docsPage StripePlugin
+ */
+export declare class StripePlugin {
+    static options: StripePluginOptions;
+    /**
+     * @description
+     * Initialize the Stripe payment plugin
+     */
+    static init(options: StripePluginOptions): Type<StripePlugin>;
+}