@deenruv/payments-plugin 1.0.0

package/package/stripe/stripe.plugin.js

@@ -0,0 +1,218 @@
+"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 StripePlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StripePlugin = void 0;
+const core_1 = require("@deenruv/core");
+const graphql_tag_1 = require("graphql-tag");
+const constants_1 = require("./constants");
+const raw_body_middleware_1 = require("./raw-body.middleware");
+const stripe_controller_1 = require("./stripe.controller");
+const stripe_handler_1 = require("./stripe.handler");
+const stripe_resolver_1 = require("./stripe.resolver");
+const stripe_service_1 = require("./stripe.service");
+/**
+ * @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
+ */
+let StripePlugin = exports.StripePlugin = StripePlugin_1 = class StripePlugin {
+    /**
+     * @description
+     * Initialize the Stripe payment plugin
+     */
+    static init(options) {
+        this.options = options;
+        return StripePlugin_1;
+    }
+};
+exports.StripePlugin = StripePlugin = StripePlugin_1 = __decorate([
+    (0, core_1.DeenruvPlugin)({
+        imports: [core_1.PluginCommonModule],
+        controllers: [stripe_controller_1.StripeController],
+        providers: [
+            {
+                provide: constants_1.STRIPE_PLUGIN_OPTIONS,
+                useFactory: () => StripePlugin_1.options,
+            },
+            stripe_service_1.StripeService,
+        ],
+        configuration: (config) => {
+            config.paymentOptions.paymentMethodHandlers.push(stripe_handler_1.stripePaymentMethodHandler);
+            config.apiOptions.middleware.push({
+                route: "/payments/stripe",
+                handler: raw_body_middleware_1.rawBodyMiddleware,
+                beforeListen: true,
+            });
+            if (StripePlugin_1.options.storeCustomersInStripe) {
+                config.customFields.Customer.push({
+                    name: "stripeCustomerId",
+                    type: "string",
+                    label: [{ languageCode: core_1.LanguageCode.en, value: "Stripe Customer ID" }],
+                    nullable: true,
+                    public: false,
+                    readonly: true,
+                });
+            }
+            return config;
+        },
+        shopApiExtensions: {
+            schema: (0, graphql_tag_1.gql) `
+      extend type Mutation {
+        createStripePaymentIntent: String!
+      }
+    `,
+            resolvers: [stripe_resolver_1.StripeResolver],
+        },
+        compatibility: "^0.0.0",
+    })
+], StripePlugin);
+//# sourceMappingURL=stripe.plugin.js.map

package/package/stripe/stripe.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe.plugin.js","sourceRoot":"","sources":["../../src/stripe/stripe.plugin.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,wCAKuB;AAEvB,6CAAkC;AAElC,2CAAoD;AACpD,+DAA0D;AAC1D,2DAAuD;AACvD,qDAA8D;AAC9D,uDAAmD;AACnD,qDAAiD;AAGjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmJG;AA6CI,IAAM,YAAY,2CAAlB,MAAM,YAAY;IAGvB;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,OAA4B;QACtC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,cAAY,CAAC;IACtB,CAAC;CACF,CAAA;uBAXY,YAAY;IA5CxB,IAAA,oBAAa,EAAC;QACb,OAAO,EAAE,CAAC,yBAAkB,CAAC;QAC7B,WAAW,EAAE,CAAC,oCAAgB,CAAC;QAC/B,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,iCAAqB;gBAC9B,UAAU,EAAE,GAAwB,EAAE,CAAC,cAAY,CAAC,OAAO;aAC5D;YACD,8BAAa;SACd;QACD,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE;YACxB,MAAM,CAAC,cAAc,CAAC,qBAAqB,CAAC,IAAI,CAC9C,2CAA0B,CAC3B,CAAC;YAEF,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;gBAChC,KAAK,EAAE,kBAAkB;gBACzB,OAAO,EAAE,uCAAiB;gBAC1B,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;YAEH,IAAI,cAAY,CAAC,OAAO,CAAC,sBAAsB,EAAE;gBAC/C,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAChC,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;oBACvE,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE,KAAK;oBACb,QAAQ,EAAE,IAAI;iBACf,CAAC,CAAC;aACJ;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,iBAAiB,EAAE;YACjB,MAAM,EAAE,IAAA,iBAAG,EAAA;;;;KAIV;YACD,SAAS,EAAE,CAAC,gCAAc,CAAC;SAC5B;QACD,aAAa,EAAE,QAAQ;KACxB,CAAC;GACW,YAAY,CAWxB"}

package/package/stripe/stripe.resolver.d.ts

@@ -0,0 +1,8 @@
+import { ActiveOrderService, RequestContext } from "@deenruv/core";
+import { StripeService } from "./stripe.service";
+export declare class StripeResolver {
+    private stripeService;
+    private activeOrderService;
+    constructor(stripeService: StripeService, activeOrderService: ActiveOrderService);
+    createStripePaymentIntent(ctx: RequestContext): Promise<string>;
+}

package/package/stripe/stripe.resolver.js

@@ -0,0 +1,48 @@
+"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.StripeResolver = void 0;
+const graphql_1 = require("@nestjs/graphql");
+const core_1 = require("@deenruv/core");
+const stripe_service_1 = require("./stripe.service");
+let StripeResolver = exports.StripeResolver = class StripeResolver {
+    constructor(stripeService, activeOrderService) {
+        this.stripeService = stripeService;
+        this.activeOrderService = activeOrderService;
+    }
+    async createStripePaymentIntent(ctx) {
+        if (!ctx.authorizedAsOwnerOnly) {
+            throw new core_1.UnauthorizedError();
+        }
+        const sessionOrder = await this.activeOrderService.getActiveOrder(ctx, undefined);
+        if (!sessionOrder) {
+            throw new core_1.UserInputError("No active order found for session");
+        }
+        return this.stripeService.createPaymentIntent(ctx, sessionOrder);
+    }
+};
+__decorate([
+    (0, graphql_1.Mutation)(),
+    (0, core_1.Allow)(core_1.Permission.Owner),
+    __param(0, (0, core_1.Ctx)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [core_1.RequestContext]),
+    __metadata("design:returntype", Promise)
+], StripeResolver.prototype, "createStripePaymentIntent", null);
+exports.StripeResolver = StripeResolver = __decorate([
+    (0, graphql_1.Resolver)(),
+    __metadata("design:paramtypes", [stripe_service_1.StripeService,
+        core_1.ActiveOrderService])
+], StripeResolver);
+//# sourceMappingURL=stripe.resolver.js.map

package/package/stripe/stripe.resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe.resolver.js","sourceRoot":"","sources":["../../src/stripe/stripe.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,6CAAqD;AACrD,wCAQuB;AAEvB,qDAAiD;AAG1C,IAAM,cAAc,4BAApB,MAAM,cAAc;IACzB,YACU,aAA4B,EAC5B,kBAAsC;QADtC,kBAAa,GAAb,aAAa,CAAe;QAC5B,uBAAkB,GAAlB,kBAAkB,CAAoB;IAC7C,CAAC;IAIE,AAAN,KAAK,CAAC,yBAAyB,CAAQ,GAAmB;QACxD,IAAI,CAAC,GAAG,CAAC,qBAAqB,EAAE;YAC9B,MAAM,IAAI,wBAAiB,EAAE,CAAC;SAC/B;QACD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAC/D,GAAG,EACH,SAAS,CACV,CAAC;QACF,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,qBAAc,CAAC,mCAAmC,CAAC,CAAC;SAC/D;QACD,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IACnE,CAAC;CACF,CAAA;AAbO;IAFL,IAAA,kBAAQ,GAAE;IACV,IAAA,YAAK,EAAC,iBAAU,CAAC,KAAK,CAAC;IACS,WAAA,IAAA,UAAG,GAAE,CAAA;;qCAAM,qBAAc;;+DAYzD;yBApBU,cAAc;IAD1B,IAAA,kBAAQ,GAAE;qCAGgB,8BAAa;QACR,yBAAkB;GAHrC,cAAc,CAqB1B"}

package/package/stripe/stripe.service.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { ModuleRef } from "@nestjs/core";
+import { Order, Payment, PaymentMethodService, RequestContext, TransactionalConnection } from "@deenruv/core";
+import Stripe from "stripe";
+import { DeenruvStripeClient } from "./stripe-client";
+import { StripePluginOptions } from "./types";
+export declare class StripeService {
+    private options;
+    private connection;
+    private paymentMethodService;
+    private moduleRef;
+    constructor(options: StripePluginOptions, connection: TransactionalConnection, paymentMethodService: PaymentMethodService, moduleRef: ModuleRef);
+    createPaymentIntent(ctx: RequestContext, order: Order): Promise<string>;
+    constructEventFromPayload(ctx: RequestContext, order: Order, payload: Buffer, signature: string): Promise<Stripe.Event>;
+    createRefund(ctx: RequestContext, order: Order, payment: Payment, amount: number): Promise<Stripe.Response<Stripe.Refund>>;
+    /**
+     * Get Stripe client based on eligible payment methods for order
+     */
+    getStripeClient(ctx: RequestContext, order: Order): Promise<DeenruvStripeClient>;
+    private findOrThrowArgValue;
+    /**
+     * Returns the stripeCustomerId if the Customer has one. If that's not the case, queries Stripe to check
+     * if the customer is already registered, in which case it saves the id as stripeCustomerId and returns it.
+     * Otherwise, creates a new Customer record in Stripe and returns the generated id.
+     */
+    private getStripeCustomerId;
+}

package/package/stripe/stripe.service.js

@@ -0,0 +1,149 @@
+"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.StripeService = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const core_2 = require("@deenruv/core");
+const constants_1 = require("./constants");
+const metadata_sanitize_1 = require("./metadata-sanitize");
+const stripe_client_1 = require("./stripe-client");
+const stripe_utils_1 = require("./stripe-utils");
+const stripe_handler_1 = require("./stripe.handler");
+let StripeService = exports.StripeService = class StripeService {
+    constructor(options, connection, paymentMethodService, moduleRef) {
+        this.options = options;
+        this.connection = connection;
+        this.paymentMethodService = paymentMethodService;
+        this.moduleRef = moduleRef;
+    }
+    async createPaymentIntent(ctx, order) {
+        var _a, _b, _c;
+        let customerId;
+        const stripe = await this.getStripeClient(ctx, order);
+        if (this.options.storeCustomersInStripe && ctx.activeUserId) {
+            customerId = await this.getStripeCustomerId(ctx, order);
+        }
+        const amountInMinorUnits = (0, stripe_utils_1.getAmountInStripeMinorUnits)(order);
+        const additionalParams = await ((_b = (_a = this.options).paymentIntentCreateParams) === null || _b === void 0 ? void 0 : _b.call(_a, new core_2.Injector(this.moduleRef), ctx, order));
+        const metadata = (0, metadata_sanitize_1.sanitizeMetadata)(Object.assign(Object.assign({}, (typeof this.options.metadata === "function"
+            ? await this.options.metadata(new core_2.Injector(this.moduleRef), ctx, order)
+            : {})), { channelToken: ctx.channel.token, orderId: order.id, orderCode: order.code }));
+        const allMetadata = Object.assign(Object.assign({}, metadata), (0, metadata_sanitize_1.sanitizeMetadata)((_c = additionalParams === null || additionalParams === void 0 ? void 0 : additionalParams.metadata) !== null && _c !== void 0 ? _c : {}));
+        const { client_secret } = await stripe.paymentIntents.create(Object.assign(Object.assign({ amount: amountInMinorUnits, currency: order.currencyCode.toLowerCase(), customer: customerId, automatic_payment_methods: {
+                enabled: true,
+            } }, (additionalParams !== null && additionalParams !== void 0 ? additionalParams : {})), { metadata: allMetadata }), { idempotencyKey: `${order.code}_${amountInMinorUnits}` });
+        if (!client_secret) {
+            // This should never happen
+            core_2.Logger.warn(`Payment intent creation for order ${order.code} did not return client secret`, constants_1.loggerCtx);
+            throw Error("Failed to create payment intent");
+        }
+        return client_secret !== null && client_secret !== void 0 ? client_secret : undefined;
+    }
+    async constructEventFromPayload(ctx, order, payload, signature) {
+        const stripe = await this.getStripeClient(ctx, order);
+        return stripe.webhooks.constructEvent(payload, signature, stripe.webhookSecret);
+    }
+    async createRefund(ctx, order, payment, amount) {
+        const stripe = await this.getStripeClient(ctx, order);
+        return stripe.refunds.create({
+            payment_intent: payment.transactionId,
+            amount,
+        });
+    }
+    /**
+     * Get Stripe client based on eligible payment methods for order
+     */
+    async getStripeClient(ctx, order) {
+        const [eligiblePaymentMethods, paymentMethods] = await Promise.all([
+            this.paymentMethodService.getEligiblePaymentMethods(ctx, order),
+            this.paymentMethodService.findAll(ctx, {
+                filter: {
+                    enabled: { eq: true },
+                },
+            }),
+        ]);
+        const stripePaymentMethod = paymentMethods.items.find((pm) => pm.handler.code === stripe_handler_1.stripePaymentMethodHandler.code);
+        if (!stripePaymentMethod) {
+            throw new core_2.UserInputError("No enabled Stripe payment method found");
+        }
+        const isEligible = eligiblePaymentMethods.some((pm) => pm.code === stripePaymentMethod.code);
+        if (!isEligible) {
+            throw new core_2.UserInputError(`Stripe payment method is not eligible for order ${order.code}`);
+        }
+        const apiKey = this.findOrThrowArgValue(stripePaymentMethod.handler.args, "apiKey");
+        const webhookSecret = this.findOrThrowArgValue(stripePaymentMethod.handler.args, "webhookSecret");
+        return new stripe_client_1.DeenruvStripeClient(apiKey, webhookSecret);
+    }
+    findOrThrowArgValue(args, name) {
+        var _a;
+        const value = (_a = args.find((arg) => arg.name === name)) === null || _a === void 0 ? void 0 : _a.value;
+        if (!value) {
+            throw Error(`No argument named '${name}' found!`);
+        }
+        return value;
+    }
+    /**
+     * Returns the stripeCustomerId if the Customer has one. If that's not the case, queries Stripe to check
+     * if the customer is already registered, in which case it saves the id as stripeCustomerId and returns it.
+     * Otherwise, creates a new Customer record in Stripe and returns the generated id.
+     */
+    async getStripeCustomerId(ctx, activeOrder) {
+        var _a, _b;
+        const [stripe, order] = await Promise.all([
+            this.getStripeClient(ctx, activeOrder),
+            // Load relation with customer not available in the response from activeOrderService.getOrderFromContext()
+            this.connection.getRepository(ctx, core_2.Order).findOne({
+                where: { id: activeOrder.id },
+                relations: ["customer"],
+            }),
+        ]);
+        if (!order || !order.customer) {
+            // This should never happen
+            return undefined;
+        }
+        const { customer } = order;
+        if (customer.customFields.stripeCustomerId) {
+            return customer.customFields.stripeCustomerId;
+        }
+        let stripeCustomerId;
+        const stripeCustomers = await stripe.customers.list({
+            email: customer.emailAddress,
+        });
+        if (stripeCustomers.data.length > 0) {
+            stripeCustomerId = stripeCustomers.data[0].id;
+        }
+        else {
+            const additionalParams = await ((_b = (_a = this.options).customerCreateParams) === null || _b === void 0 ? void 0 : _b.call(_a, new core_2.Injector(this.moduleRef), ctx, order));
+            const newStripeCustomer = await stripe.customers.create(Object.assign(Object.assign({ email: customer.emailAddress, name: `${customer.firstName} ${customer.lastName}` }, (additionalParams !== null && additionalParams !== void 0 ? additionalParams : {})), ((additionalParams === null || additionalParams === void 0 ? void 0 : additionalParams.metadata)
+                ? { metadata: (0, metadata_sanitize_1.sanitizeMetadata)(additionalParams.metadata) }
+                : {})));
+            stripeCustomerId = newStripeCustomer.id;
+            core_2.Logger.info(`Created Stripe Customer record for customerId ${customer.id}`, constants_1.loggerCtx);
+        }
+        customer.customFields.stripeCustomerId = stripeCustomerId;
+        await this.connection
+            .getRepository(ctx, core_2.Customer)
+            .save(customer, { reload: false });
+        return stripeCustomerId;
+    }
+};
+exports.StripeService = StripeService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(constants_1.STRIPE_PLUGIN_OPTIONS)),
+    __metadata("design:paramtypes", [Object, core_2.TransactionalConnection,
+        core_2.PaymentMethodService,
+        core_1.ModuleRef])
+], StripeService);
+//# sourceMappingURL=stripe.service.js.map

package/package/stripe/stripe.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe.service.js","sourceRoot":"","sources":["../../src/stripe/stripe.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAoD;AACpD,uCAAyC;AAEzC,wCAUuB;AAGvB,2CAA+D;AAC/D,2DAAuD;AACvD,mDAAsD;AACtD,iDAA6D;AAC7D,qDAA8D;AAIvD,IAAM,aAAa,2BAAnB,MAAM,aAAa;IACxB,YACyC,OAA4B,EAC3D,UAAmC,EACnC,oBAA0C,EAC1C,SAAoB;QAHW,YAAO,GAAP,OAAO,CAAqB;QAC3D,eAAU,GAAV,UAAU,CAAyB;QACnC,yBAAoB,GAApB,oBAAoB,CAAsB;QAC1C,cAAS,GAAT,SAAS,CAAW;IAC3B,CAAC;IAEJ,KAAK,CAAC,mBAAmB,CACvB,GAAmB,EACnB,KAAY;;QAEZ,IAAI,UAA8B,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAEtD,IAAI,IAAI,CAAC,OAAO,CAAC,sBAAsB,IAAI,GAAG,CAAC,YAAY,EAAE;YAC3D,UAAU,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACzD;QACD,MAAM,kBAAkB,GAAG,IAAA,0CAA2B,EAAC,KAAK,CAAC,CAAC;QAE9D,MAAM,gBAAgB,GAAG,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,yBAAyB,mDACnE,IAAI,eAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAC5B,GAAG,EACH,KAAK,CACN,CAAA,CAAC;QACF,MAAM,QAAQ,GAAG,IAAA,oCAAgB,kCAC5B,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,UAAU;YAC7C,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,eAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC;YACvE,CAAC,CAAC,EAAE,CAAC,KACP,YAAY,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,EAC/B,OAAO,EAAE,KAAK,CAAC,EAAE,EACjB,SAAS,EAAE,KAAK,CAAC,IAAI,IACrB,CAAC;QAEH,MAAM,WAAW,mCACZ,QAAQ,GACR,IAAA,oCAAgB,EAAC,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,mCAAI,EAAE,CAAC,CACtD,CAAC;QAEF,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,MAAM,+BAExD,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,WAAW,EAAE,EAC1C,QAAQ,EAAE,UAAU,EACpB,yBAAyB,EAAE;gBACzB,OAAO,EAAE,IAAI;aACd,IACE,CAAC,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,EAAE,CAAC,KAC3B,QAAQ,EAAE,WAAW,KAEvB,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC,IAAI,IAAI,kBAAkB,EAAE,EAAE,CAC1D,CAAC;QAEF,IAAI,CAAC,aAAa,EAAE;YAClB,2BAA2B;YAC3B,aAAM,CAAC,IAAI,CACT,qCAAqC,KAAK,CAAC,IAAI,+BAA+B,EAC9E,qBAAS,CACV,CAAC;YACF,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAC;SAChD;QAED,OAAO,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,SAAS,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,yBAAyB,CAC7B,GAAmB,EACnB,KAAY,EACZ,OAAe,EACf,SAAiB;QAEjB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC,QAAQ,CAAC,cAAc,CACnC,OAAO,EACP,SAAS,EACT,MAAM,CAAC,aAAa,CACrB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,GAAmB,EACnB,KAAY,EACZ,OAAgB,EAChB,MAAc;QAEd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;YAC3B,cAAc,EAAE,OAAO,CAAC,aAAa;YACrC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,GAAmB,EACnB,KAAY;QAEZ,MAAM,CAAC,sBAAsB,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACjE,IAAI,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,GAAG,EAAE,KAAK,CAAC;YAC/D,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE;gBACrC,MAAM,EAAE;oBACN,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;iBACtB;aACF,CAAC;SACH,CAAC,CAAC;QACH,MAAM,mBAAmB,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,CACnD,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,2CAA0B,CAAC,IAAI,CAC5D,CAAC;QACF,IAAI,CAAC,mBAAmB,EAAE;YACxB,MAAM,IAAI,qBAAc,CAAC,wCAAwC,CAAC,CAAC;SACpE;QACD,MAAM,UAAU,GAAG,sBAAsB,CAAC,IAAI,CAC5C,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,mBAAmB,CAAC,IAAI,CAC7C,CAAC;QACF,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,qBAAc,CACtB,mDAAmD,KAAK,CAAC,IAAI,EAAE,CAChE,CAAC;SACH;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CACrC,mBAAmB,CAAC,OAAO,CAAC,IAAI,EAChC,QAAQ,CACT,CAAC;QACF,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAC5C,mBAAmB,CAAC,OAAO,CAAC,IAAI,EAChC,eAAe,CAChB,CAAC;QACF,OAAO,IAAI,mCAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAEO,mBAAmB,CAAC,IAAiB,EAAE,IAAY;;QACzD,MAAM,KAAK,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,0CAAE,KAAK,CAAC;QAC3D,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,KAAK,CAAC,sBAAsB,IAAI,UAAU,CAAC,CAAC;SACnD;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,mBAAmB,CAC/B,GAAmB,EACnB,WAAkB;;QAElB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACxC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,CAAC;YACtC,0GAA0G;YAC1G,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,YAAK,CAAC,CAAC,OAAO,CAAC;gBAChD,KAAK,EAAE,EAAE,EAAE,EAAE,WAAW,CAAC,EAAE,EAAE;gBAC7B,SAAS,EAAE,CAAC,UAAU,CAAC;aACxB,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC7B,2BAA2B;YAC3B,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;QAE3B,IAAI,QAAQ,CAAC,YAAY,CAAC,gBAAgB,EAAE;YAC1C,OAAO,QAAQ,CAAC,YAAY,CAAC,gBAAgB,CAAC;SAC/C;QAED,IAAI,gBAAgB,CAAC;QAErB,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC;YAClD,KAAK,EAAE,QAAQ,CAAC,YAAY;SAC7B,CAAC,CAAC;QACH,IAAI,eAAe,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACnC,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/C;aAAM;YACL,MAAM,gBAAgB,GAAG,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,oBAAoB,mDAC9D,IAAI,eAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAC5B,GAAG,EACH,KAAK,CACN,CAAA,CAAC;YACF,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,MAAM,+BACrD,KAAK,EAAE,QAAQ,CAAC,YAAY,EAC5B,IAAI,EAAE,GAAG,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,QAAQ,EAAE,IAC/C,CAAC,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,EAAE,CAAC,GACxB,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ;gBAC5B,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAA,oCAAgB,EAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE;gBAC3D,CAAC,CAAC,EAAE,CAAC,EACP,CAAC;YAEH,gBAAgB,GAAG,iBAAiB,CAAC,EAAE,CAAC;YAExC,aAAM,CAAC,IAAI,CACT,iDAAiD,QAAQ,CAAC,EAAE,EAAE,EAC9D,qBAAS,CACV,CAAC;SACH;QAED,QAAQ,CAAC,YAAY,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAC1D,MAAM,IAAI,CAAC,UAAU;aAClB,aAAa,CAAC,GAAG,EAAE,eAAQ,CAAC;aAC5B,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAErC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF,CAAA;wBA9MY,aAAa;IADzB,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,eAAM,EAAC,iCAAqB,CAAC,CAAA;6CACV,8BAAuB;QACb,2BAAoB;QAC/B,gBAAS;GALnB,aAAa,CA8MzB"}

package/package/stripe/types.d.ts

@@ -0,0 +1,137 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import "@deenruv/core/dist/entity/custom-entity-fields";
+import type { Injector, Order, RequestContext } from "@deenruv/core";
+import type { Request } from "express";
+import type Stripe from "stripe";
+declare module "@deenruv/core/dist/entity/custom-entity-fields" {
+    interface CustomCustomerFields {
+        stripeCustomerId?: string;
+    }
+}
+type AdditionalPaymentIntentCreateParams = Partial<Omit<Stripe.PaymentIntentCreateParams, "amount" | "currency" | "customer">>;
+type AdditionalCustomerCreateParams = Partial<Omit<Stripe.CustomerCreateParams, "email">>;
+/**
+ * @description
+ * Configuration options for the Stripe payments plugin.
+ *
+ * @docsCategory core plugins/PaymentsPlugin
+ * @docsPage StripePlugin
+ */
+export interface StripePluginOptions {
+    /**
+     * @description
+     * If set to `true`, a [Customer](https://stripe.com/docs/api/customers) object will be created in Stripe - if
+     * it doesn't already exist - for authenticated users, which prevents payment methods attached to other Customers
+     * to be used with the same PaymentIntent. This is done by adding a custom field to the Customer entity to store
+     * the Stripe customer ID, so switching this on will require a database migration / synchronization.
+     *
+     * @default false
+     */
+    storeCustomersInStripe?: boolean;
+    /**
+     * @description
+     * Attach extra metadata to Stripe payment intent creation call.
+     *
+     * @example
+     * ```ts
+     * import { EntityHydrator, DeenruvConfig } from '\@deenruv/core';
+     * import { StripePlugin } from '\@deenruv/payments-plugin/package/stripe';
+     *
+     * export const config: DeenruvConfig = {
+     *   // ...
+     *   plugins: [
+     *     StripePlugin.init({
+     *       metadata: async (injector, ctx, order) => {
+     *         const hydrator = injector.get(EntityHydrator);
+     *         await hydrator.hydrate(ctx, order, { relations: ['customer'] });
+     *         return {
+     *           description: `Order #${order.code} for ${order.customer!.emailAddress}`
+     *         },
+     *       }
+     *     }),
+     *   ],
+     * };
+     * ```
+     *
+     * Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` key, then the values
+     * returned by both functions will be merged.
+     *
+     * @since 1.9.7
+     */
+    metadata?: (injector: Injector, ctx: RequestContext, order: Order) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>;
+    /**
+     * @description
+     * Provide additional parameters to the Stripe payment intent creation. By default,
+     * the plugin will already pass the `amount`, `currency`, `customer` and `automatic_payment_methods: { enabled: true }` parameters.
+     *
+     * For example, if you want to provide a `description` for the payment intent, you can do so like this:
+     *
+     * @example
+     * ```ts
+     * import { DeenruvConfig } from '\@deenruv/core';
+     * import { StripePlugin } from '\@deenruv/payments-plugin/package/stripe';
+     *
+     * export const config: DeenruvConfig = {
+     *   // ...
+     *   plugins: [
+     *     StripePlugin.init({
+     *       paymentIntentCreateParams: (injector, ctx, order) => {
+     *         return {
+     *           description: `Order #${order.code} for ${order.customer?.emailAddress}`
+     *         },
+     *       }
+     *     }),
+     *   ],
+     * };
+     * ```
+     *
+     * @since 2.1.0
+     *
+     */
+    paymentIntentCreateParams?: (injector: Injector, ctx: RequestContext, order: Order) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>;
+    /**
+     * @description
+     * Provide additional parameters to the Stripe customer creation. By default,
+     * the plugin will already pass the `email` and `name` parameters.
+     *
+     * For example, if you want to provide an address for the customer:
+     *
+     * @example
+     * ```ts
+     * import { EntityHydrator, DeenruvConfig } from '\@deenruv/core';
+     * import { StripePlugin } from '\@deenruv/payments-plugin/package/stripe';
+     *
+     * export const config: DeenruvConfig = {
+     *   // ...
+     *   plugins: [
+     *     StripePlugin.init({
+     *       storeCustomersInStripe: true,
+     *       customerCreateParams: async (injector, ctx, order) => {
+     *         const entityHydrator = injector.get(EntityHydrator);
+     *         const customer = order.customer;
+     *         await entityHydrator.hydrate(ctx, customer, { relations: ['addresses'] });
+     *         const defaultBillingAddress = customer.addresses.find(a => a.defaultBillingAddress) ?? customer.addresses[0];
+     *         return {
+     *           address: {
+     *               line1: defaultBillingAddress.streetLine1 || order.shippingAddress?.streetLine1,
+     *               postal_code: defaultBillingAddress.postalCode || order.shippingAddress?.postalCode,
+     *               city: defaultBillingAddress.city || order.shippingAddress?.city,
+     *               state: defaultBillingAddress.province || order.shippingAddress?.province,
+     *               country: defaultBillingAddress.country.code || order.shippingAddress?.countryCode,
+     *           },
+     *         },
+     *       }
+     *     }),
+     *   ],
+     * };
+     * ```
+     *
+     * @since 2.1.0
+     */
+    customerCreateParams?: (injector: Injector, ctx: RequestContext, order: Order) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>;
+}
+export interface RequestWithRawBody extends Request {
+    rawBody: Buffer;
+}
+export {};

package/package/stripe/types.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("@deenruv/core/dist/entity/custom-entity-fields");
+//# sourceMappingURL=types.js.map

package/package/stripe/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/stripe/types.ts"],"names":[],"mappings":";;AAAA,0DAAwD"}