@vendure/core 2.0.0-next.9 → 2.0.1

package/dist/config/order/guest-checkout-strategy.d.ts

@@ -0,0 +1,30 @@
+import { CreateCustomerInput, SetCustomerForOrderResult } from '@vendure/common/lib/generated-shop-types';
+import { RequestContext } from '../../api/common/request-context';
+import { ErrorResultUnion } from '../../common/index';
+import { InjectableStrategy } from '../../common/types/injectable-strategy';
+import { Customer, Order } from '../../entity/index';
+/**
+ * @description
+ * A strategy that determines how to deal with guest checkouts - i.e. when a customer
+ * checks out without being logged in. For example, a strategy could be used to implement
+ * business rules such as:
+ *
+ * - No guest checkouts allowed
+ * - No guest checkouts allowed for customers who already have an account
+ * - No guest checkouts allowed for customers who have previously placed an order
+ * - Allow guest checkouts, but create a new Customer entity if the email address
+ *   is already in use
+ * - Allow guest checkouts, but update the existing Customer entity if the email address
+ *   is already in use
+ *
+ * @docsCategory orders
+ * @since 2.0.0
+ */
+export interface GuestCheckoutStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * This method is called when the `setCustomerForOrder` mutation is executed.
+     * It should return either a Customer object or an ErrorResult.
+     */
+    setCustomerForOrder(ctx: RequestContext, order: Order, input: CreateCustomerInput): ErrorResultUnion<SetCustomerForOrderResult, Customer> | Promise<ErrorResultUnion<SetCustomerForOrderResult, Customer>>;
+}

package/dist/config/order/guest-checkout-strategy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=guest-checkout-strategy.js.map

package/dist/config/order/guest-checkout-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guest-checkout-strategy.js","sourceRoot":"","sources":["../../../src/config/order/guest-checkout-strategy.ts"],"names":[],"mappings":""}

package/dist/config/order/order-item-price-calculation-strategy.d.ts

@@ -1,10 +1,11 @@
 import { RequestContext } from '../../api/common/request-context';
 import { PriceCalculationResult } from '../../common/types/common-types';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
+import { Order } from '../../entity/order/order.entity';
 import { ProductVariant } from '../../entity/product-variant/product-variant.entity';
 /**
  * @description
- * The OrderItemPriceCalculationStrategy defines the price of an OrderItem. By default the
+ * The OrderItemPriceCalculationStrategy defines the listPrice of an OrderLine when adding an item to an Order. By default the
  * {@link DefaultOrderItemPriceCalculationStrategy} is used.
  *
  * ### When is the strategy invoked ?
@@ -16,9 +17,13 @@ import { ProductVariant } from '../../entity/product-variant/product-variant.ent
  * ### OrderItemPriceCalculationStrategy vs Promotions
  * Both the OrderItemPriceCalculationStrategy and Promotions can be used to alter the price paid for a product.
  *
+ * The main difference is when a Promotion is applied, it adds a `discount` line to the Order, and the regular
+ * price is used for the value of `OrderLine.listPrice` property, whereas
+ * the OrderItemPriceCalculationStrategy actually alters the value of `OrderLine.listPrice` itself, and does not
+ * add any discounts to the Order.
+ *
  * Use OrderItemPriceCalculationStrategy if:
  *
- * * The price is not dependent on quantity or on the other contents of the Order.
  * * The price calculation is based on the properties of the ProductVariant and any CustomFields
  *   specified on the OrderLine, for example via a product configurator.
  * * The logic is a permanent part of your business requirements.
@@ -39,6 +44,8 @@ import { ProductVariant } from '../../entity/product-variant/product-variant.ent
  *   a gift-wrapping surcharge would be added to the price.
  * * A product-configurator where e.g. various finishes, colors, and materials can be selected and stored
  *   as OrderLine custom fields (see [Customizing models](/docs/developer-guide/customizing-models/#configurable-order-products).
+ * * Price lists or bulk pricing, where different price bands are stored e.g. in a customField on the ProductVariant, and this
+ *   is used to calculate the price based on the current quantity.
  *
  * @docsCategory Orders
  */
@@ -47,8 +54,14 @@ export interface OrderItemPriceCalculationStrategy extends InjectableStrategy {
      * @description
      * Receives the ProductVariant to be added to the Order as well as any OrderLine custom fields and returns
      * the price for a single unit.
+     *
+     * Note: if you have any `relation` type custom fields defined on the OrderLine entity, they will only be
+     * passed in to this method if they are set to `eager: true`. Otherwise, you can use the {@link EntityHydrator}
+     * to join the missing relations.
+     *
+     * Note: the `quantity` argument was added in v2.0.0
      */
     calculateUnitPrice(ctx: RequestContext, productVariant: ProductVariant, orderLineCustomFields: {
         [key: string]: any;
-    }): PriceCalculationResult | Promise<PriceCalculationResult>;
+    }, order: Order, quantity: number): PriceCalculationResult | Promise<PriceCalculationResult>;
 }

package/dist/config/order/order-merge-strategy.d.ts

@@ -1,8 +1,8 @@
 import { ID } from '@vendure/common/lib/shared-types';
 import { RequestContext } from '../../api/common/request-context';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
-import { OrderLine } from '../../entity/order-line/order-line.entity';
 import { Order } from '../../entity/order/order.entity';
+import { OrderLine } from '../../entity/order-line/order-line.entity';
 /**
  * @description
  * The result of the {@link OrderMergeStrategy} `merge` method.

package/dist/config/order/order-process.d.ts

@@ -0,0 +1,30 @@
+import { OnTransitionEndFn, OnTransitionErrorFn, OnTransitionStartFn, Transitions } from '../../common/finite-state-machine/types';
+import { InjectableStrategy } from '../../common/types/injectable-strategy';
+import { CustomOrderStates, OrderState, OrderTransitionData } from '../../service/helpers/order-state-machine/order-state';
+/**
+ * @description
+ * An OrderProcess is used to define the way the order process works as in: what states an Order can be
+ * in, and how it may transition from one state to another. Using the `onTransitionStart()` hook, an
+ * OrderProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
+ * hook allows logic to be executed after a state change.
+ *
+ * For detailed description of the interface members, see the {@link StateMachineConfig} docs.
+ *
+ * @docsCategory orders
+ * @docsPage OrderProcess
+ * @docsWeight 0
+ */
+export interface OrderProcess<State extends keyof CustomOrderStates | string> extends InjectableStrategy {
+    transitions?: Transitions<State, State | OrderState> & Partial<Transitions<OrderState | State>>;
+    onTransitionStart?: OnTransitionStartFn<State | OrderState, OrderTransitionData>;
+    onTransitionEnd?: OnTransitionEndFn<State | OrderState, OrderTransitionData>;
+    onTransitionError?: OnTransitionErrorFn<State | OrderState>;
+}
+/**
+ * @description
+ * Used to define extensions to or modifications of the default order process.
+ *
+ * @deprecated Use OrderProcess
+ */
+export interface CustomOrderProcess<State extends keyof CustomOrderStates | string> extends OrderProcess<State> {
+}

package/dist/config/order/order-process.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=order-process.js.map

package/dist/config/order/order-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-process.js","sourceRoot":"","sources":["../../../src/config/order/order-process.ts"],"names":[],"mappings":""}

package/dist/config/order/order-seller-strategy.d.ts

@@ -0,0 +1,56 @@
+import { ID } from '@vendure/common/lib/shared-types';
+import { RequestContext } from '../../api/index';
+import { InjectableStrategy } from '../../common/index';
+import { Channel } from '../../entity/channel/channel.entity';
+import { Order } from '../../entity/order/order.entity';
+import { OrderLine } from '../../entity/order-line/order-line.entity';
+import { ShippingLine } from '../../entity/shipping-line/shipping-line.entity';
+import { OrderState } from '../../service/index';
+/**
+ * @description
+ * The contents of the aggregate Order which make up a single seller Order.
+ *
+ * @since 2.0.0
+ * @docsCategory orders
+ * @docsPage OrderSellerStrategy
+ */
+export interface SplitOrderContents {
+    channelId: ID;
+    state: OrderState;
+    lines: OrderLine[];
+    shippingLines: ShippingLine[];
+}
+/**
+ * @description
+ * This strategy defines how an Order can be split into multiple sub-orders for the use-case of
+ * a multivendor application.
+ *
+ * @since 2.0.0
+ * @docsCategory orders
+ * @docsPage OrderSellerStrategy
+ * @docsWeight 0
+ */
+export interface OrderSellerStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * This method is called whenever a new OrderLine is added to the Order via the `addItemToOrder` mutation or the
+     * underlying `addItemToOrder()` method of the {@link OrderService}.
+     *
+     * It should return the ID of the Channel to which this OrderLine will be assigned, which will be used to set the
+     * {@link OrderLine} `sellerChannel` property.
+     */
+    setOrderLineSellerChannel?(ctx: RequestContext, orderLine: OrderLine): Channel | undefined | Promise<Channel | undefined>;
+    /**
+     * @description
+     * Upon checkout (by default, when the Order moves from "active" to "inactive" according to the {@link OrderPlacedStrategy}),
+     * this method will be called in order to split the Order into multiple Orders, one for each Seller.
+     */
+    splitOrder?(ctx: RequestContext, order: Order): SplitOrderContents[] | Promise<SplitOrderContents[]>;
+    /**
+     * @description
+     * This method is called after splitting the orders, including calculating the totals for each of the seller Orders.
+     * This method can be used to set platform fee surcharges on the seller Orders as well as perform any payment processing
+     * needed.
+     */
+    afterSellerOrdersCreated?(ctx: RequestContext, aggregateOrder: Order, sellerOrders: Order[]): void | Promise<void>;
+}

package/dist/config/order/order-seller-strategy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=order-seller-strategy.js.map

package/dist/config/order/order-seller-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-seller-strategy.js","sourceRoot":"","sources":["../../../src/config/order/order-seller-strategy.ts"],"names":[],"mappings":""}

package/dist/config/payment/default-payment-process.d.ts

@@ -0,0 +1,16 @@
+import { PaymentState } from '../../service/index';
+import { PaymentProcess } from './payment-process';
+declare module '../../service/helpers/payment-state-machine/payment-state' {
+    interface PaymentStates {
+        Authorized: never;
+        Settled: never;
+        Declined: never;
+    }
+}
+/**
+ * @description
+ * The default {@link PaymentProcess}
+ *
+ * @docsCategory payment
+ */
+export declare const defaultPaymentProcess: PaymentProcess<PaymentState>;

package/dist/config/payment/default-payment-process.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultPaymentProcess = void 0;
+const generated_types_1 = require("@vendure/common/lib/generated-types");
+const order_utils_1 = require("../../service/helpers/utils/order-utils");
+let configService;
+let orderService;
+let historyService;
+/**
+ * @description
+ * The default {@link PaymentProcess}
+ *
+ * @docsCategory payment
+ */
+exports.defaultPaymentProcess = {
+    transitions: {
+        Created: {
+            to: ['Authorized', 'Settled', 'Declined', 'Error', 'Cancelled'],
+        },
+        Authorized: {
+            to: ['Settled', 'Error', 'Cancelled'],
+        },
+        Settled: {
+            to: ['Cancelled'],
+        },
+        Declined: {
+            to: ['Cancelled'],
+        },
+        Error: {
+            to: ['Cancelled'],
+        },
+        Cancelled: {
+            to: [],
+        },
+    },
+    async init(injector) {
+        // Lazily import these services to avoid a circular dependency error
+        // due to this being used as part of the DefaultConfig
+        const ConfigService = await import('../config.service.js').then(m => m.ConfigService);
+        const HistoryService = await import('../../service/index.js').then(m => m.HistoryService);
+        const OrderService = await import('../../service/services/order.service.js').then(m => m.OrderService);
+        configService = injector.get(ConfigService);
+        historyService = injector.get(HistoryService);
+        orderService = injector.get(OrderService);
+    },
+    async onTransitionStart(fromState, toState, data) {
+        // nothing here by default
+    },
+    async onTransitionEnd(fromState, toState, data) {
+        const { ctx, payment, order } = data;
+        order.payments = await orderService.getOrderPayments(ctx, order.id);
+        await historyService.createHistoryEntryForOrder({
+            ctx: data.ctx,
+            orderId: data.order.id,
+            type: generated_types_1.HistoryEntryType.ORDER_PAYMENT_TRANSITION,
+            data: {
+                paymentId: data.payment.id,
+                from: fromState,
+                to: toState,
+            },
+        });
+        if ((0, order_utils_1.orderTotalIsCovered)(order, 'Settled') &&
+            order.state !== 'PaymentSettled' &&
+            order.state !== 'ArrangingAdditionalPayment') {
+            await orderService.transitionToState(ctx, order.id, 'PaymentSettled');
+        }
+        else if ((0, order_utils_1.orderTotalIsCovered)(order, ['Authorized', 'Settled']) &&
+            order.state !== 'PaymentAuthorized' &&
+            order.state !== 'ArrangingAdditionalPayment') {
+            await orderService.transitionToState(ctx, order.id, 'PaymentAuthorized');
+        }
+    },
+};
+//# sourceMappingURL=default-payment-process.js.map

package/dist/config/payment/default-payment-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-payment-process.js","sourceRoot":"","sources":["../../../src/config/payment/default-payment-process.ts"],"names":[],"mappings":";;;AAAA,yEAAuE;AAEvE,yEAA8E;AAa9E,IAAI,aAAwD,CAAC;AAC7D,IAAI,YAAyE,CAAC;AAC9E,IAAI,cAA4D,CAAC;AAEjE;;;;;GAKG;AACU,QAAA,qBAAqB,GAAiC;IAC/D,WAAW,EAAE;QACT,OAAO,EAAE;YACL,EAAE,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,CAAC;SAClE;QACD,UAAU,EAAE;YACR,EAAE,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,WAAW,CAAC;SACxC;QACD,OAAO,EAAE;YACL,EAAE,EAAE,CAAC,WAAW,CAAC;SACpB;QACD,QAAQ,EAAE;YACN,EAAE,EAAE,CAAC,WAAW,CAAC;SACpB;QACD,KAAK,EAAE;YACH,EAAE,EAAE,CAAC,WAAW,CAAC;SACpB;QACD,SAAS,EAAE;YACP,EAAE,EAAE,EAAE;SACT;KACJ;IACD,KAAK,CAAC,IAAI,CAAC,QAAQ;QACf,oEAAoE;QACpE,sDAAsD;QACtD,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;QACtF,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAC1F,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,yCAAyC,CAAC,CAAC,IAAI,CAC7E,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CACtB,CAAC;QACF,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC5C,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9C,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IACD,KAAK,CAAC,iBAAiB,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI;QAC5C,0BAA0B;IAC9B,CAAC;IACD,KAAK,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI;QAC1C,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACrC,KAAK,CAAC,QAAQ,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAEpE,MAAM,cAAc,CAAC,0BAA0B,CAAC;YAC5C,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;YACtB,IAAI,EAAE,kCAAgB,CAAC,wBAAwB;YAC/C,IAAI,EAAE;gBACF,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;gBAC1B,IAAI,EAAE,SAAS;gBACf,EAAE,EAAE,OAAO;aACd;SACJ,CAAC,CAAC;QAEH,IACI,IAAA,iCAAmB,EAAC,KAAK,EAAE,SAAS,CAAC;YACrC,KAAK,CAAC,KAAK,KAAK,gBAAgB;YAChC,KAAK,CAAC,KAAK,KAAK,4BAA4B,EAC9C;YACE,MAAM,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC;SACzE;aAAM,IACH,IAAA,iCAAmB,EAAC,KAAK,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YACrD,KAAK,CAAC,KAAK,KAAK,mBAAmB;YACnC,KAAK,CAAC,KAAK,KAAK,4BAA4B,EAC9C;YACE,MAAM,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC;SAC5E;IACL,CAAC;CACJ,CAAC"}

package/dist/config/payment/dummy-payment-method-handler.js

@@ -92,5 +92,13 @@ exports.dummyPaymentHandler = new payment_method_handler_1.PaymentMethodHandler(
             success: true,
         };
     },
+    cancelPayment: (ctx, order, payment) => {
+        return {
+            success: true,
+            metadata: {
+                cancellationDate: new Date().toISOString(),
+            },
+        };
+    },
 });
 //# sourceMappingURL=dummy-payment-method-handler.js.map

package/dist/config/payment/dummy-payment-method-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"dummy-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/dummy-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,mBAAmB,GAAG,IAAI,6CAAoB,CAAC;IACxD,IAAI,EAAE,uBAAuB;IAC7B,WAAW,EAAE;QACT;YACI,YAAY,EAAE,8BAAY,CAAC,EAAE;YAC7B,KAAK,EAAE,qEAAqE;SAC/E;KACJ;IACD,IAAI,EAAE;QACF,eAAe,EAAE;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE;gBACH;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,gCAAgC;iBAC1C;aACJ;YACD,WAAW,EAAE;gBACT;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,8DAA8D;iBACxE;aACJ;YACD,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;SACtB;KACJ;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;QAChE,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAmB;gBAC1B,QAAQ,EAAE;oBACN,YAAY,EAAE,mBAAmB;iBACpC;aACJ,CAAC;SACL;aAAM,IAAI,QAAQ,CAAC,WAAW,EAAE;YAC7B,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,OAAgB;gBACvB,YAAY,EAAE,iBAAiB;gBAC/B,QAAQ,EAAE;oBACN,YAAY,EAAE,iBAAiB;iBAClC;aACJ,CAAC;SACL;aAAM;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACtD,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;gBACnD,QAAQ;aACX,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACvD,IAAI,OAAO,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YACtC,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,4BAA4B;aAC7C,CAAC;SACL;QACD,OAAO;YACH,OAAO,EAAE,IAAI;SAChB,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}
+{"version":3,"file":"dummy-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/dummy-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,mBAAmB,GAAG,IAAI,6CAAoB,CAAC;IACxD,IAAI,EAAE,uBAAuB;IAC7B,WAAW,EAAE;QACT;YACI,YAAY,EAAE,8BAAY,CAAC,EAAE;YAC7B,KAAK,EAAE,qEAAqE;SAC/E;KACJ;IACD,IAAI,EAAE;QACF,eAAe,EAAE;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE;gBACH;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,gCAAgC;iBAC1C;aACJ;YACD,WAAW,EAAE;gBACT;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,8DAA8D;iBACxE;aACJ;YACD,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;SACtB;KACJ;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;QAChE,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAmB;gBAC1B,QAAQ,EAAE;oBACN,YAAY,EAAE,mBAAmB;iBACpC;aACJ,CAAC;SACL;aAAM,IAAI,QAAQ,CAAC,WAAW,EAAE;YAC7B,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,OAAgB;gBACvB,YAAY,EAAE,iBAAiB;gBAC/B,QAAQ,EAAE;oBACN,YAAY,EAAE,iBAAiB;iBAClC;aACJ,CAAC;SACL;aAAM;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACtD,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;gBACnD,QAAQ;aACX,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACvD,IAAI,OAAO,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YACtC,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,4BAA4B;aAC7C,CAAC;SACL;QACD,OAAO;YACH,OAAO,EAAE,IAAI;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QACnC,OAAO;YACH,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE;gBACN,gBAAgB,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;aAC7C;SACJ,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}

package/dist/config/payment/example-payment-method-handler.js

@@ -13,7 +13,7 @@ const gripeSDK = {
                 id: Math.random().toString(36).substr(3),
             });
         },
-        capture: (transactionId) => {
+        capture: async (transactionId) => {
             return true;
         },
     },

package/dist/config/payment/example-payment-method-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"example-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/example-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;GAEG;AACH,MAAM,QAAQ,GAAG;IACb,OAAO,EAAE;QACL,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC;gBACnB,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aAC3C,CAAC,CAAC;QACP,CAAC;QACD,OAAO,EAAE,CAAC,aAAqB,EAAE,EAAE;YAC/B,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ;CACJ,CAAC;AAEF;;;GAGG;AACU,QAAA,qBAAqB,GAAG,IAAI,6CAAoB,CAAC;IAC1D,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC;IACnF,IAAI,EAAE;QACF,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE;QACtD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KAC9C;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAgC,EAAE;QAC9F,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;gBACzC,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM;gBACN,MAAM,EAAE,QAAQ,CAAC,SAAS;aAC7B,CAAC,CAAC;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACvD,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnC,QAAQ;aACX,CAAC;SACL;QAAC,OAAO,GAAQ,EAAE;YACf,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAwB;gBAC/B,QAAQ,EAAE;oBACN,YAAY,EAAE,GAAG,CAAC,OAAO;iBAC5B;aACJ,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACvD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACrE,OAAO;YACH,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE;gBACN,SAAS,EAAE,SAAS;aACvB;SACJ,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}
+{"version":3,"file":"example-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/example-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;GAEG;AACH,MAAM,QAAQ,GAAG;IACb,OAAO,EAAE;QACL,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC;gBACnB,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aAC3C,CAAC,CAAC;QACP,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,aAAqB,EAAE,EAAE;YACrC,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ;CACJ,CAAC;AAEF;;;GAGG;AACU,QAAA,qBAAqB,GAAG,IAAI,6CAAoB,CAAC;IAC1D,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC;IACnF,IAAI,EAAE;QACF,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE;QACtD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KAC9C;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAgC,EAAE;QAC9F,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;gBACzC,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM;gBACN,MAAM,EAAE,QAAQ,CAAC,SAAS;aAC7B,CAAC,CAAC;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACvD,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnC,QAAQ;aACX,CAAC;SACL;QAAC,OAAO,GAAQ,EAAE;YACf,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAmB;gBAC1B,QAAQ,EAAE;oBACN,YAAY,EAAE,GAAG,CAAC,OAAO;iBAC5B;aACJ,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACvD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACrE,OAAO;YACH,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE;gBACN,SAAS,EAAE,SAAS;aACvB;SACJ,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}

package/dist/config/payment/payment-method-eligibility-checker.d.ts

@@ -57,4 +57,4 @@ export declare class PaymentMethodEligibilityChecker<T extends ConfigArgs = Conf
  * @docsCategory payment
  * @docsPage PaymentMethodEligibilityChecker
  */
-export declare type CheckPaymentMethodEligibilityCheckerFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>, method: PaymentMethod) => boolean | string | Promise<boolean | string>;
+export type CheckPaymentMethodEligibilityCheckerFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>, method: PaymentMethod) => boolean | string | Promise<boolean | string>;

package/dist/config/payment/payment-method-handler.d.ts

@@ -6,7 +6,7 @@ import { PaymentMetadata } from '../../common/types/common-types';
 import { Order, Payment, PaymentMethod } from '../../entity';
 import { PaymentState, PaymentTransitionData } from '../../service/helpers/payment-state-machine/payment-state';
 import { RefundState } from '../../service/helpers/refund-state-machine/refund-state';
-export declare type OnPaymentTransitionStartReturnType = ReturnType<Required<StateMachineConfig<any>>['onTransitionStart']>;
+export type OnPaymentTransitionStartReturnType = ReturnType<Required<StateMachineConfig<any>>['onTransitionStart']>;
 /**
  * @description
  * This object is the return value of the {@link CreatePaymentFn}.
@@ -124,6 +124,45 @@ export interface SettlePaymentErrorResult {
     errorMessage?: string;
     metadata?: PaymentMetadata;
 }
+/**
+ * @description
+ * This object is the return value of the {@link CancelPaymentFn} when the Payment
+ * has been successfully cancelled.
+ *
+ * @docsCategory payment
+ * @docsPage Payment Method Types
+ */
+export interface CancelPaymentResult {
+    success: true;
+    metadata?: PaymentMetadata;
+}
+/**
+ * @description
+ * This object is the return value of the {@link CancelPaymentFn} when the Payment
+ * could not be cancelled.
+ *
+ * @docsCategory payment
+ * @docsPage Payment Method Types
+ */
+export interface CancelPaymentErrorResult {
+    success: false;
+    /**
+     * @description
+     * The state to transition this Payment to upon unsuccessful cancellation.
+     * Defaults to `Error`. Note that if using a different state, it must be
+     * legal to transition to that state from the `Authorized` state according
+     * to the PaymentState config (which can be customized using the
+     * {@link CustomPaymentProcess}).
+     */
+    state?: Exclude<PaymentState, 'Cancelled'>;
+    /**
+     * @description
+     * The message that will be returned when attempting to cancel the payment, and will
+     * also be persisted as `Payment.errorMessage`.
+     */
+    errorMessage?: string;
+    metadata?: PaymentMetadata;
+}
 /**
  * @description
  * This function contains the logic for creating a payment. See {@link PaymentMethodHandler} for an example.
@@ -133,7 +172,7 @@ export interface SettlePaymentErrorResult {
  * @docsCategory payment
  * @docsPage Payment Method Types
  */
-export declare type CreatePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, amount: number, args: ConfigArgValues<T>, metadata: PaymentMetadata, method: PaymentMethod) => CreatePaymentResult | CreatePaymentErrorResult | Promise<CreatePaymentResult | CreatePaymentErrorResult>;
+export type CreatePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, amount: number, args: ConfigArgValues<T>, metadata: PaymentMetadata, method: PaymentMethod) => CreatePaymentResult | CreatePaymentErrorResult | Promise<CreatePaymentResult | CreatePaymentErrorResult>;
 /**
  * @description
  * This function contains the logic for settling a payment. See {@link PaymentMethodHandler} for an example.
@@ -141,7 +180,15 @@ export declare type CreatePaymentFn<T extends ConfigArgs> = (ctx: RequestContext
  * @docsCategory payment
  * @docsPage Payment Method Types
  */
-export declare type SettlePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => SettlePaymentResult | SettlePaymentErrorResult | Promise<SettlePaymentResult | SettlePaymentErrorResult>;
+export type SettlePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => SettlePaymentResult | SettlePaymentErrorResult | Promise<SettlePaymentResult | SettlePaymentErrorResult>;
+/**
+ * @description
+ * This function contains the logic for cancelling a payment. See {@link PaymentMethodHandler} for an example.
+ *
+ * @docsCategory payment
+ * @docsPage Payment Method Types
+ */
+export type CancelPaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => CancelPaymentResult | CancelPaymentErrorResult | Promise<CancelPaymentResult | CancelPaymentErrorResult>;
 /**
  * @description
  * This function contains the logic for creating a refund. See {@link PaymentMethodHandler} for an example.
@@ -149,7 +196,7 @@ export declare type SettlePaymentFn<T extends ConfigArgs> = (ctx: RequestContext
  * @docsCategory payment
  * @docsPage Payment Method Types
  */
-export declare type CreateRefundFn<T extends ConfigArgs> = (ctx: RequestContext, input: RefundOrderInput, amount: number, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => CreateRefundResult | Promise<CreateRefundResult>;
+export type CreateRefundFn<T extends ConfigArgs> = (ctx: RequestContext, input: RefundOrderInput, amount: number, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => CreateRefundResult | Promise<CreateRefundResult>;
 /**
  * @description
  * Defines the object which is used to construct the {@link PaymentMethodHandler}.
@@ -172,6 +219,17 @@ export interface PaymentMethodConfigOptions<T extends ConfigArgs> extends Config
      * need only return `{ success: true }`.
      */
     settlePayment: SettlePaymentFn<T>;
+    /**
+     * @description
+     * This function provides the logic for cancelling a payment, which would be invoked when a call is
+     * made to the `cancelPayment` mutation in the Admin API. Cancelling a payment can apply
+     * if, for example, you have created a "payment intent" with the payment provider but not yet
+     * completed the payment. It allows the incomplete payment to be cleaned up on the provider's end
+     * if it gets cancelled via Vendure.
+     *
+     * @since 1.7.0
+     */
+    cancelPayment?: CancelPaymentFn<T>;
     /**
      * @description
      * This function provides the logic for refunding a payment created with this
@@ -190,7 +248,7 @@ export interface PaymentMethodConfigOptions<T extends ConfigArgs> extends Config
 /**
  * @description
  * A PaymentMethodHandler contains the code which is used to generate a Payment when a call to the
- * `addPaymentToOrder` mutation is made. If contains any necessary steps of interfacing with a
+ * `addPaymentToOrder` mutation is made. It contains any necessary steps of interfacing with a
  * third-party payment gateway before the Payment is created and can also define actions to fire
  * when the state of the payment is changed.
  *
@@ -246,6 +304,7 @@ export interface PaymentMethodConfigOptions<T extends ConfigArgs> extends Config
 export declare class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> extends ConfigurableOperationDef<T> {
     private readonly createPaymentFn;
     private readonly settlePaymentFn;
+    private readonly cancelPaymentFn?;
     private readonly createRefundFn?;
     private readonly onTransitionStartFn?;
     constructor(config: PaymentMethodConfigOptions<T>);
@@ -273,7 +332,7 @@ export declare class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> ext
          * If using a {@link CustomPaymentProcess}, may be something else
          * entirely according to your business logic.
          */
-        state: "Created" | "Cancelled" | "Authorized" | "Settled" | "Declined";
+        state: "Created" | "Cancelled" | keyof import("../../service/helpers/payment-state-machine/payment-state").PaymentStates;
         /**
          * @description
          * The unique payment reference code typically assigned by
@@ -287,14 +346,14 @@ export declare class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> ext
          * ErrorResponse of the `addPaymentToOrder` mutation.
          */
         errorMessage?: string | undefined;
-        metadata: {};
+        metadata: PaymentMetadata;
         method: string;
     } | {
         amount: number;
         state: "Error";
         transactionId?: string | undefined;
         errorMessage: string;
-        metadata: {};
+        metadata: PaymentMetadata;
         method: string;
     }>;
     /**
@@ -304,6 +363,13 @@ export declare class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> ext
      * @internal
      */
     settlePayment(ctx: RequestContext, order: Order, payment: Payment, args: ConfigArg[], method: PaymentMethod): Promise<SettlePaymentResult | SettlePaymentErrorResult>;
+    /**
+     * @description
+     * Called internally to cancel a payment
+     *
+     * @internal
+     */
+    cancelPayment(ctx: RequestContext, order: Order, payment: Payment, args: ConfigArg[], method: PaymentMethod): Promise<CancelPaymentResult | CancelPaymentErrorResult | undefined>;
     /**
      * @description
      * Called internally to create a refund

package/dist/config/payment/payment-method-handler.js

@@ -5,7 +5,7 @@ const configurable_operation_1 = require("../../common/configurable-operation");
 /**
  * @description
  * A PaymentMethodHandler contains the code which is used to generate a Payment when a call to the
- * `addPaymentToOrder` mutation is made. If contains any necessary steps of interfacing with a
+ * `addPaymentToOrder` mutation is made. It contains any necessary steps of interfacing with a
  * third-party payment gateway before the Payment is created and can also define actions to fire
  * when the state of the payment is changed.
  *
@@ -63,7 +63,7 @@ class PaymentMethodHandler extends configurable_operation_1.ConfigurableOperatio
         super(config);
         this.createPaymentFn = config.createPayment;
         this.settlePaymentFn = config.settlePayment;
-        this.settlePaymentFn = config.settlePayment;
+        this.cancelPaymentFn = config.cancelPayment;
         this.createRefundFn = config.createRefund;
         this.onTransitionStartFn = config.onStateTransitionStart;
     }
@@ -86,6 +86,16 @@ class PaymentMethodHandler extends configurable_operation_1.ConfigurableOperatio
     async settlePayment(ctx, order, payment, args, method) {
         return this.settlePaymentFn(ctx, order, payment, this.argsArrayToHash(args), method);
     }
+    /**
+     * @description
+     * Called internally to cancel a payment
+     *
+     * @internal
+     */
+    async cancelPayment(ctx, order, payment, args, method) {
+        var _a;
+        return (_a = this.cancelPaymentFn) === null || _a === void 0 ? void 0 : _a.call(this, ctx, order, payment, this.argsArrayToHash(args), method);
+    }
     /**
      * @description
      * Called internally to create a refund

package/dist/config/payment/payment-method-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/payment-method-handler.ts"],"names":[],"mappings":";;;AAGA,gFAK6C;AAgO7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAa,oBAAwD,SAAQ,iDAA2B;IAMpG,YAAY,MAAqC;QAC7C,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,sBAAsB,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACf,GAAmB,EACnB,KAAY,EACZ,MAAc,EACd,IAAiB,EACjB,QAAyB,EACzB,MAAqB;QAErB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,eAAe,CAC5C,GAAG,EACH,KAAK,EACL,MAAM,EACN,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAC1B,QAAQ,EACR,MAAM,CACT,CAAC;QACF,uBACI,MAAM,EAAE,IAAI,CAAC,IAAI,EACjB,QAAQ,EAAE,EAAE,IACT,aAAa,EAClB;IACN,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACf,GAAmB,EACnB,KAAY,EACZ,OAAgB,EAChB,IAAiB,EACjB,MAAqB;QAErB,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACd,GAAmB,EACnB,KAAuB,EACvB,MAAc,EACd,KAAY,EACZ,OAAgB,EAChB,IAAiB,EACjB,MAAqB;QAErB,OAAO,IAAI,CAAC,cAAc;YACtB,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YAC7F,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CAClB,SAAuB,EACvB,OAAqB,EACrB,IAA2B;QAE3B,IAAI,OAAO,IAAI,CAAC,mBAAmB,KAAK,UAAU,EAAE;YAChD,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;SAC7D;aAAM;YACH,OAAO,IAAI,CAAC;SACf;IACL,CAAC;CACJ;AAnGD,oDAmGC"}
+{"version":3,"file":"payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/payment-method-handler.ts"],"names":[],"mappings":";;;AAGA,gFAK6C;AAiS7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAa,oBAAwD,SAAQ,iDAA2B;IAOpG,YAAY,MAAqC;QAC7C,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,sBAAsB,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACf,GAAmB,EACnB,KAAY,EACZ,MAAc,EACd,IAAiB,EACjB,QAAyB,EACzB,MAAqB;QAErB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,eAAe,CAC5C,GAAG,EACH,KAAK,EACL,MAAM,EACN,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAC1B,QAAQ,EACR,MAAM,CACT,CAAC;QACF,uBACI,MAAM,EAAE,IAAI,CAAC,IAAI,EACjB,QAAQ,EAAE,EAAE,IACT,aAAa,EAClB;IACN,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACf,GAAmB,EACnB,KAAY,EACZ,OAAgB,EAChB,IAAiB,EACjB,MAAqB;QAErB,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACf,GAAmB,EACnB,KAAY,EACZ,OAAgB,EAChB,IAAiB,EACjB,MAAqB;;QAErB,OAAO,MAAA,IAAI,CAAC,eAAe,qDAAG,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACd,GAAmB,EACnB,KAAuB,EACvB,MAAc,EACd,KAAY,EACZ,OAAgB,EAChB,IAAiB,EACjB,MAAqB;QAErB,OAAO,IAAI,CAAC,cAAc;YACtB,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YAC7F,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CAClB,SAAuB,EACvB,OAAqB,EACrB,IAA2B;QAE3B,IAAI,OAAO,IAAI,CAAC,mBAAmB,KAAK,UAAU,EAAE;YAChD,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;SAC7D;aAAM;YACH,OAAO,IAAI,CAAC;SACf;IACL,CAAC;CACJ;AApHD,oDAoHC"}

package/dist/config/payment/payment-process.d.ts

@@ -0,0 +1,31 @@
+import { OnTransitionEndFn, OnTransitionErrorFn, OnTransitionStartFn, Transitions } from '../../common/finite-state-machine/types';
+import { InjectableStrategy } from '../../common/types/injectable-strategy';
+import { CustomPaymentStates, PaymentState, PaymentTransitionData } from '../../service/helpers/payment-state-machine/payment-state';
+/**
+ * @description
+ * A PaymentProcess is used to define the way the payment process works as in: what states a Payment can be
+ * in, and how it may transition from one state to another. Using the `onTransitionStart()` hook, a
+ * PaymentProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
+ * hook allows logic to be executed after a state change.
+ *
+ * For detailed description of the interface members, see the {@link StateMachineConfig} docs.
+ *
+ * @docsCategory payment
+ * @since 2.0.0
+ */
+export interface PaymentProcess<State extends keyof CustomPaymentStates | string> extends InjectableStrategy {
+    transitions?: Transitions<State, State | PaymentState> & Partial<Transitions<PaymentState | State>>;
+    onTransitionStart?: OnTransitionStartFn<State | PaymentState, PaymentTransitionData>;
+    onTransitionEnd?: OnTransitionEndFn<State | PaymentState, PaymentTransitionData>;
+    onTransitionError?: OnTransitionErrorFn<State | PaymentState>;
+}
+/**
+ * @description
+ * Used to define extensions to or modifications of the default payment process.
+ *
+ * For detailed description of the interface members, see the {@link StateMachineConfig} docs.
+ *
+ * @deprecated use PaymentProcess
+ */
+export interface CustomPaymentProcess<State extends keyof CustomPaymentStates | string> extends PaymentProcess<State> {
+}

package/dist/config/payment/payment-process.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=payment-process.js.map

package/dist/config/payment/payment-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-process.js","sourceRoot":"","sources":["../../../src/config/payment/payment-process.ts"],"names":[],"mappings":""}

package/dist/config/promotion/actions/buy-x-get-y-free-action.d.ts

@@ -1,7 +1,6 @@
 import { LanguageCode } from '@vendure/common/lib/generated-types';
-import { ID } from '@vendure/common/lib/shared-types';
 import { PromotionItemAction } from '../promotion-action';
-export declare const buyXGetYFreeAction: PromotionItemAction<{}, import("..").PromotionCondition<{
+export declare const buyXGetYFreeAction: PromotionItemAction<{}, import("../promotion-condition").PromotionCondition<{
     amountX: {
         type: "int";
         defaultValue: number;
@@ -33,5 +32,7 @@ export declare const buyXGetYFreeAction: PromotionItemAction<{}, import("..").Pr
         }[];
     };
 }, "buy_x_get_y_free", false | {
-    freeItemIds: ID[];
+    freeItemsPerLine: {
+        [lineId: string]: number;
+    };
 }>[]>;