@deenruv/core 1.0.0

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

@@ -0,0 +1,149 @@
+import { OrderState } from "../../service/helpers/order-state-machine/order-state";
+import { OrderProcess } from "./order-process";
+declare module "../../service/helpers/order-state-machine/order-state" {
+    interface OrderStates {
+        ArrangingPayment: never;
+        PaymentAuthorized: never;
+        PaymentSettled: never;
+        PartiallyShipped: never;
+        Shipped: never;
+        PartiallyDelivered: never;
+        Delivered: never;
+        Modifying: never;
+        ArrangingAdditionalPayment: never;
+    }
+}
+/**
+ * @description
+ * Options which can be passed to the {@link configureDefaultOrderProcess} function
+ * to configure an instance of the default {@link OrderProcess}. By default, all
+ * options are set to `true`.
+ *
+ * @docsCategory Orders
+ * @docsPage OrderProcess
+ * @since 2.0.0
+ */
+export interface DefaultOrderProcessOptions {
+    /**
+     * @description
+     * Prevents an Order from transitioning out of the `Modifying` state if
+     * the Order price has changed and there is no Payment or Refund associated
+     * with the Modification.
+     *
+     * @default true
+     */
+    checkModificationPayments?: boolean;
+    /**
+     * @description
+     * Prevents an Order from transitioning out of the `ArrangingAdditionalPayment` state if
+     * the Order's Payments do not cover the full amount of `totalWithTax`.
+     *
+     * @default true
+     */
+    checkAdditionalPaymentsAmount?: boolean;
+    /**
+     * @description
+     * Prevents the transition from `AddingItems` to any other state (apart from `Cancelled`) if
+     * and of the ProductVariants no longer exists due to deletion.
+     *
+     * @default true
+     */
+    checkAllVariantsExist?: boolean;
+    /**
+     * @description
+     * Prevents transition to the `ArrangingPayment` state if the active Order has no lines.
+     *
+     * @default true
+     */
+    arrangingPaymentRequiresContents?: boolean;
+    /**
+     * @description
+     * Prevents transition to the `ArrangingPayment` state if the active Order has no customer
+     * associated with it.
+     *
+     * @default true
+     */
+    arrangingPaymentRequiresCustomer?: boolean;
+    /**
+     * @description
+     * Prevents transition to the `ArrangingPayment` state if the active Order has no shipping
+     * method set.
+     *
+     * @default true
+     */
+    arrangingPaymentRequiresShipping?: boolean;
+    /**
+     * @description
+     * Prevents transition to the `ArrangingPayment` state if there is insufficient saleable
+     * stock to cover the contents of the Order.
+     *
+     * @default true
+     */
+    arrangingPaymentRequiresStock?: boolean;
+    /**
+     * @description
+     * Prevents transition to the `PaymentAuthorized` or `PaymentSettled` states if the order
+     * `totalWithTax` amount is not covered by Payment(s) in the corresponding states.
+     *
+     * @default true
+     */
+    checkPaymentsCoverTotal?: boolean;
+    /**
+     * @description
+     * Prevents transition to the `Cancelled` state unless all OrderItems are already
+     * cancelled.
+     *
+     * @default true
+     */
+    checkAllItemsBeforeCancel?: boolean;
+    /**
+     * @description
+     * Prevents transition to the `Shipped`, `PartiallyShipped`, `Delivered` & `PartiallyDelivered` states unless
+     * there are corresponding Fulfillments in the correct states to allow this. E.g. `Shipped` only if all items in
+     * the Order are part of a Fulfillment which itself is in the `Shipped` state.
+     *
+     * @default true
+     */
+    checkFulfillmentStates?: boolean;
+}
+/**
+ * @description
+ * Used to configure a customized instance of the default {@link OrderProcess} that ships with Deenruv.
+ * Using this function allows you to turn off certain checks and constraints that are enabled by default.
+ *
+ * ```ts
+ * import { configureDefaultOrderProcess, DeenruvConfig } from '\@deenruv/core';
+ *
+ * const myCustomOrderProcess = configureDefaultOrderProcess({
+ *   // Disable the constraint that requires
+ *   // Orders to have a shipping method assigned
+ *   // before payment.
+ *   arrangingPaymentRequiresShipping: false,
+ * });
+ *
+ * export const config: DeenruvConfig = {
+ *   orderOptions: {
+ *     process: [myCustomOrderProcess],
+ *   },
+ * };
+ * ```
+ * The {@link DefaultOrderProcessOptions} type defines all available options. If you require even
+ * more customization, you can create your own implementation of the {@link OrderProcess} interface.
+ *
+ *
+ * @docsCategory Orders
+ * @docsPage OrderProcess
+ * @since 2.0.0
+ */
+export declare function configureDefaultOrderProcess(options: DefaultOrderProcessOptions): OrderProcess<OrderState>;
+/**
+ * @description
+ * This is the built-in {@link OrderProcess} that ships with Deenruv. A customized version of this process
+ * can be created using the {@link configureDefaultOrderProcess} function, which allows you to pass in an object
+ * to enable/disable certain checks.
+ *
+ * @docsCategory Orders
+ * @docsPage OrderProcess
+ * @since 2.0.0
+ */
+export declare const defaultOrderProcess: OrderProcess<OrderState>;

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

@@ -0,0 +1,341 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultOrderProcess = exports.configureDefaultOrderProcess = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const unique_1 = require("@deenruv/common/lib/unique");
+const transactional_connection_1 = require("../../connection/transactional-connection");
+const order_entity_1 = require("../../entity/order/order.entity");
+const order_line_entity_1 = require("../../entity/order-line/order-line.entity");
+const order_modification_entity_1 = require("../../entity/order-modification/order-modification.entity");
+const payment_entity_1 = require("../../entity/payment/payment.entity");
+const product_variant_entity_1 = require("../../entity/product-variant/product-variant.entity");
+const order_placed_event_1 = require("../../event-bus/events/order-placed-event");
+const order_utils_1 = require("../../service/helpers/utils/order-utils");
+/**
+ * @description
+ * Used to configure a customized instance of the default {@link OrderProcess} that ships with Deenruv.
+ * Using this function allows you to turn off certain checks and constraints that are enabled by default.
+ *
+ * ```ts
+ * import { configureDefaultOrderProcess, DeenruvConfig } from '\@deenruv/core';
+ *
+ * const myCustomOrderProcess = configureDefaultOrderProcess({
+ *   // Disable the constraint that requires
+ *   // Orders to have a shipping method assigned
+ *   // before payment.
+ *   arrangingPaymentRequiresShipping: false,
+ * });
+ *
+ * export const config: DeenruvConfig = {
+ *   orderOptions: {
+ *     process: [myCustomOrderProcess],
+ *   },
+ * };
+ * ```
+ * The {@link DefaultOrderProcessOptions} type defines all available options. If you require even
+ * more customization, you can create your own implementation of the {@link OrderProcess} interface.
+ *
+ *
+ * @docsCategory Orders
+ * @docsPage OrderProcess
+ * @since 2.0.0
+ */
+function configureDefaultOrderProcess(options) {
+    let connection;
+    let productVariantService;
+    let configService;
+    let eventBus;
+    let stockMovementService;
+    let stockLevelService;
+    let historyService;
+    let orderSplitter;
+    const orderProcess = {
+        transitions: {
+            Created: {
+                to: ["AddingItems", "Draft"],
+            },
+            Draft: {
+                to: ["Cancelled", "ArrangingPayment"],
+            },
+            AddingItems: {
+                to: ["ArrangingPayment", "Cancelled"],
+            },
+            ArrangingPayment: {
+                to: ["PaymentAuthorized", "PaymentSettled", "AddingItems", "Cancelled"],
+            },
+            PaymentAuthorized: {
+                to: [
+                    "PaymentSettled",
+                    "Cancelled",
+                    "Modifying",
+                    "ArrangingAdditionalPayment",
+                ],
+            },
+            PaymentSettled: {
+                to: [
+                    "PartiallyDelivered",
+                    "Delivered",
+                    "PartiallyShipped",
+                    "Shipped",
+                    "Cancelled",
+                    "Modifying",
+                    "ArrangingAdditionalPayment",
+                ],
+            },
+            PartiallyShipped: {
+                to: ["Shipped", "PartiallyDelivered", "Cancelled", "Modifying"],
+            },
+            Shipped: {
+                to: ["PartiallyDelivered", "Delivered", "Cancelled", "Modifying"],
+            },
+            PartiallyDelivered: {
+                to: ["Delivered", "Cancelled", "Modifying"],
+            },
+            Delivered: {
+                to: ["Cancelled"],
+            },
+            Modifying: {
+                to: [
+                    "PaymentAuthorized",
+                    "PaymentSettled",
+                    "PartiallyShipped",
+                    "Shipped",
+                    "PartiallyDelivered",
+                    "ArrangingAdditionalPayment",
+                ],
+            },
+            ArrangingAdditionalPayment: {
+                to: [
+                    "PaymentAuthorized",
+                    "PaymentSettled",
+                    "PartiallyShipped",
+                    "Shipped",
+                    "PartiallyDelivered",
+                    "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 EventBus = await import("../../event-bus/index.js").then((m) => m.EventBus);
+            const StockMovementService = await import("../../service/index.js").then((m) => m.StockMovementService);
+            const StockLevelService = await import("../../service/index.js").then((m) => m.StockLevelService);
+            const HistoryService = await import("../../service/index.js").then((m) => m.HistoryService);
+            const OrderSplitter = await import("../../service/index.js").then((m) => m.OrderSplitter);
+            const ProductVariantService = await import("../../service/index.js").then((m) => m.ProductVariantService);
+            connection = injector.get(transactional_connection_1.TransactionalConnection);
+            productVariantService = injector.get(ProductVariantService);
+            configService = injector.get(ConfigService);
+            eventBus = injector.get(EventBus);
+            stockMovementService = injector.get(StockMovementService);
+            stockLevelService = injector.get(StockLevelService);
+            historyService = injector.get(HistoryService);
+            orderSplitter = injector.get(OrderSplitter);
+        },
+        async onTransitionStart(fromState, toState, { ctx, order }) {
+            if (options.checkModificationPayments !== false &&
+                fromState === "Modifying") {
+                const modifications = await connection
+                    .getRepository(ctx, order_modification_entity_1.OrderModification)
+                    .find({
+                    where: { order: { id: order.id } },
+                    relations: ["refund", "payment"],
+                });
+                if (toState === "ArrangingAdditionalPayment") {
+                    if (0 < modifications.length &&
+                        modifications.every((modification) => modification.isSettled)) {
+                        return "message.cannot-transition-no-additional-payments-needed";
+                    }
+                }
+                else {
+                    if (modifications.some((modification) => !modification.isSettled)) {
+                        return "message.cannot-transition-without-modification-payment";
+                    }
+                }
+            }
+            if (options.checkAdditionalPaymentsAmount !== false &&
+                fromState === "ArrangingAdditionalPayment") {
+                if (toState === "Cancelled") {
+                    return;
+                }
+                const existingPayments = await connection
+                    .getRepository(ctx, payment_entity_1.Payment)
+                    .find({
+                    relations: ["refunds"],
+                    where: {
+                        order: { id: order.id },
+                    },
+                });
+                order.payments = existingPayments;
+                const deficit = order.totalWithTax - (0, order_utils_1.totalCoveredByPayments)(order);
+                if (0 < deficit) {
+                    return "message.cannot-transition-from-arranging-additional-payment";
+                }
+            }
+            if (options.checkAllVariantsExist !== false &&
+                fromState === "AddingItems" &&
+                toState !== "Cancelled" &&
+                order.lines.length > 0) {
+                const variantIds = (0, unique_1.unique)(order.lines.map((l) => l.productVariant.id));
+                const qb = connection
+                    .getRepository(ctx, product_variant_entity_1.ProductVariant)
+                    .createQueryBuilder("variant")
+                    .leftJoin("variant.product", "product")
+                    .where("variant.deletedAt IS NULL")
+                    .andWhere("product.deletedAt IS NULL")
+                    .andWhere("variant.id IN (:...variantIds)", { variantIds });
+                const availableVariants = await qb.getMany();
+                if (availableVariants.length !== variantIds.length) {
+                    return "message.cannot-transition-order-contains-products-which-are-unavailable";
+                }
+            }
+            if (toState === "ArrangingPayment") {
+                if (options.arrangingPaymentRequiresContents !== false &&
+                    order.lines.length === 0) {
+                    return "message.cannot-transition-to-payment-when-order-is-empty";
+                }
+                if (options.arrangingPaymentRequiresCustomer !== false &&
+                    !order.customer) {
+                    return "message.cannot-transition-to-payment-without-customer";
+                }
+                if (options.arrangingPaymentRequiresShipping !== false &&
+                    (!order.shippingLines || order.shippingLines.length === 0)) {
+                    return "message.cannot-transition-to-payment-without-shipping-method";
+                }
+                if (options.arrangingPaymentRequiresStock !== false) {
+                    const variantsWithInsufficientSaleableStock = [];
+                    for (const line of order.lines) {
+                        const availableStock = await productVariantService.getSaleableStockLevel(ctx, line.productVariant);
+                        if (line.quantity > availableStock) {
+                            variantsWithInsufficientSaleableStock.push(line.productVariant);
+                        }
+                    }
+                    if (variantsWithInsufficientSaleableStock.length) {
+                        return ctx.translate("message.cannot-transition-to-payment-due-to-insufficient-stock", {
+                            productVariantNames: variantsWithInsufficientSaleableStock
+                                .map((v) => v.name)
+                                .join(", "),
+                        });
+                    }
+                }
+            }
+            if (options.checkPaymentsCoverTotal !== false) {
+                if (toState === "PaymentAuthorized") {
+                    const hasAnAuthorizedPayment = !!order.payments.find((p) => p.state === "Authorized");
+                    if (!(0, order_utils_1.orderTotalIsCovered)(order, ["Authorized", "Settled"]) ||
+                        !hasAnAuthorizedPayment) {
+                        return "message.cannot-transition-without-authorized-payments";
+                    }
+                }
+                if (toState === "PaymentSettled" &&
+                    !(0, order_utils_1.orderTotalIsCovered)(order, "Settled")) {
+                    return "message.cannot-transition-without-settled-payments";
+                }
+            }
+            if (options.checkAllItemsBeforeCancel !== false) {
+                if (toState === "Cancelled" &&
+                    fromState !== "AddingItems" &&
+                    fromState !== "ArrangingPayment") {
+                    if (!(0, order_utils_1.orderLinesAreAllCancelled)(order)) {
+                        return "message.cannot-transition-unless-all-cancelled";
+                    }
+                }
+            }
+            if (options.checkFulfillmentStates !== false) {
+                if (toState === "PartiallyShipped") {
+                    const orderWithFulfillments = await findOrderWithFulfillments(ctx, order.id);
+                    if (!(0, order_utils_1.orderItemsArePartiallyShipped)(orderWithFulfillments)) {
+                        return "message.cannot-transition-unless-some-order-items-shipped";
+                    }
+                }
+                if (toState === "Shipped") {
+                    const orderWithFulfillments = await findOrderWithFulfillments(ctx, order.id);
+                    if (!(0, order_utils_1.orderItemsAreShipped)(orderWithFulfillments)) {
+                        return "message.cannot-transition-unless-all-order-items-shipped";
+                    }
+                }
+                if (toState === "PartiallyDelivered") {
+                    const orderWithFulfillments = await findOrderWithFulfillments(ctx, order.id);
+                    if (!(0, order_utils_1.orderItemsArePartiallyDelivered)(orderWithFulfillments)) {
+                        return "message.cannot-transition-unless-some-order-items-delivered";
+                    }
+                }
+                if (toState === "Delivered") {
+                    const orderWithFulfillments = await findOrderWithFulfillments(ctx, order.id);
+                    if (!(0, order_utils_1.orderItemsAreDelivered)(orderWithFulfillments)) {
+                        return "message.cannot-transition-unless-all-order-items-delivered";
+                    }
+                }
+            }
+        },
+        async onTransitionEnd(fromState, toState, data) {
+            const { ctx, order } = data;
+            const { stockAllocationStrategy, orderPlacedStrategy } = configService.orderOptions;
+            if (order.active) {
+                const shouldSetAsPlaced = orderPlacedStrategy.shouldSetAsPlaced(ctx, fromState, toState, order);
+                if (shouldSetAsPlaced) {
+                    order.active = false;
+                    order.orderPlacedAt = new Date();
+                    await Promise.all(order.lines.map((line) => {
+                        line.orderPlacedQuantity = line.quantity;
+                        return connection
+                            .getRepository(ctx, order_line_entity_1.OrderLine)
+                            .update(line.id, { orderPlacedQuantity: line.quantity });
+                    }));
+                    await eventBus.publish(new order_placed_event_1.OrderPlacedEvent(fromState, toState, ctx, order));
+                    await orderSplitter.createSellerOrders(ctx, order);
+                }
+            }
+            const shouldAllocateStock = await stockAllocationStrategy.shouldAllocateStock(ctx, fromState, toState, order);
+            if (shouldAllocateStock) {
+                await stockMovementService.createAllocationsForOrder(ctx, order);
+            }
+            if (toState === "Cancelled") {
+                order.active = false;
+            }
+            if (fromState === "Draft" && toState === "ArrangingPayment") {
+                // Once we exit the Draft state, we can consider the order active,
+                // which will allow us to run the OrderPlacedStrategy at the correct point.
+                order.active = true;
+            }
+            await historyService.createHistoryEntryForOrder({
+                orderId: order.id,
+                type: generated_types_1.HistoryEntryType.ORDER_STATE_TRANSITION,
+                ctx,
+                data: {
+                    from: fromState,
+                    to: toState,
+                },
+            });
+        },
+    };
+    async function findOrderWithFulfillments(ctx, id) {
+        return await connection.getEntityOrThrow(ctx, order_entity_1.Order, id, {
+            relations: [
+                "lines",
+                "fulfillments",
+                "fulfillments.lines",
+                "fulfillments.lines.fulfillment",
+            ],
+        });
+    }
+    return orderProcess;
+}
+exports.configureDefaultOrderProcess = configureDefaultOrderProcess;
+/**
+ * @description
+ * This is the built-in {@link OrderProcess} that ships with Deenruv. A customized version of this process
+ * can be created using the {@link configureDefaultOrderProcess} function, which allows you to pass in an object
+ * to enable/disable certain checks.
+ *
+ * @docsCategory Orders
+ * @docsPage OrderProcess
+ * @since 2.0.0
+ */
+exports.defaultOrderProcess = configureDefaultOrderProcess({});
+//# sourceMappingURL=default-order-process.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"default-order-process.js","sourceRoot":"","sources":["../../../src/config/order/default-order-process.ts"],"names":[],"mappings":";;;AAAA,yEAAuE;AAEvE,uDAAoD;AAGpD,wFAAoF;AACpF,kEAAwD;AACxD,iFAAsE;AACtE,yGAA8F;AAC9F,wEAA8D;AAC9D,gGAAqF;AACrF,kFAA6E;AAE7E,yEAQiD;AAgHjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,4BAA4B,CAC1C,OAAmC;IAEnC,IAAI,UAAmC,CAAC;IACxC,IAAI,qBAA0E,CAAC;IAC/E,IAAI,aAAwD,CAAC;IAC7D,IAAI,QAAkD,CAAC;IACvD,IAAI,oBAAwE,CAAC;IAC7E,IAAI,iBAAkE,CAAC;IACvE,IAAI,cAA4D,CAAC;IACjE,IAAI,aAA0D,CAAC;IAE/D,MAAM,YAAY,GAA6B;QAC7C,WAAW,EAAE;YACX,OAAO,EAAE;gBACP,EAAE,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC;aAC7B;YACD,KAAK,EAAE;gBACL,EAAE,EAAE,CAAC,WAAW,EAAE,kBAAkB,CAAC;aACtC;YACD,WAAW,EAAE;gBACX,EAAE,EAAE,CAAC,kBAAkB,EAAE,WAAW,CAAC;aACtC;YACD,gBAAgB,EAAE;gBAChB,EAAE,EAAE,CAAC,mBAAmB,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,CAAC;aACxE;YACD,iBAAiB,EAAE;gBACjB,EAAE,EAAE;oBACF,gBAAgB;oBAChB,WAAW;oBACX,WAAW;oBACX,4BAA4B;iBAC7B;aACF;YACD,cAAc,EAAE;gBACd,EAAE,EAAE;oBACF,oBAAoB;oBACpB,WAAW;oBACX,kBAAkB;oBAClB,SAAS;oBACT,WAAW;oBACX,WAAW;oBACX,4BAA4B;iBAC7B;aACF;YACD,gBAAgB,EAAE;gBAChB,EAAE,EAAE,CAAC,SAAS,EAAE,oBAAoB,EAAE,WAAW,EAAE,WAAW,CAAC;aAChE;YACD,OAAO,EAAE;gBACP,EAAE,EAAE,CAAC,oBAAoB,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC;aAClE;YACD,kBAAkB,EAAE;gBAClB,EAAE,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC;aAC5C;YACD,SAAS,EAAE;gBACT,EAAE,EAAE,CAAC,WAAW,CAAC;aAClB;YACD,SAAS,EAAE;gBACT,EAAE,EAAE;oBACF,mBAAmB;oBACnB,gBAAgB;oBAChB,kBAAkB;oBAClB,SAAS;oBACT,oBAAoB;oBACpB,4BAA4B;iBAC7B;aACF;YACD,0BAA0B,EAAE;gBAC1B,EAAE,EAAE;oBACF,mBAAmB;oBACnB,gBAAgB;oBAChB,kBAAkB;oBAClB,SAAS;oBACT,oBAAoB;oBACpB,WAAW;iBACZ;aACF;YACD,SAAS,EAAE;gBACT,EAAE,EAAE,EAAE;aACP;SACF;QACD,KAAK,CAAC,IAAI,CAAC,QAAQ;YACjB,oEAAoE;YACpE,sDAAsD;YACtD,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAC7D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CACvB,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAC5D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAClB,CAAC;YACF,MAAM,oBAAoB,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC,IAAI,CACtE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAC9B,CAAC;YACF,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC,IAAI,CACnE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAC3B,CAAC;YACF,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC,IAAI,CAChE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CACxB,CAAC;YACF,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC,IAAI,CAC/D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CACvB,CAAC;YACF,MAAM,qBAAqB,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC,IAAI,CACvE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAC/B,CAAC;YACF,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,kDAAuB,CAAC,CAAC;YACnD,qBAAqB,GAAG,QAAQ,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAC5D,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAC5C,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAClC,oBAAoB,GAAG,QAAQ,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;YAC1D,iBAAiB,GAAG,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACpD,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC9C,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC9C,CAAC;QAED,KAAK,CAAC,iBAAiB,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;YACxD,IACE,OAAO,CAAC,yBAAyB,KAAK,KAAK;gBAC3C,SAAS,KAAK,WAAW,EACzB,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,UAAU;qBACnC,aAAa,CAAC,GAAG,EAAE,6CAAiB,CAAC;qBACrC,IAAI,CAAC;oBACJ,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE;oBAClC,SAAS,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;iBACjC,CAAC,CAAC;gBACL,IAAI,OAAO,KAAK,4BAA4B,EAAE,CAAC;oBAC7C,IACE,CAAC,GAAG,aAAa,CAAC,MAAM;wBACxB,aAAa,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,EAC7D,CAAC;wBACD,OAAO,yDAAyD,CAAC;oBACnE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;wBAClE,OAAO,wDAAwD,CAAC;oBAClE,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IACE,OAAO,CAAC,6BAA6B,KAAK,KAAK;gBAC/C,SAAS,KAAK,4BAA4B,EAC1C,CAAC;gBACD,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;oBAC5B,OAAO;gBACT,CAAC;gBACD,MAAM,gBAAgB,GAAG,MAAM,UAAU;qBACtC,aAAa,CAAC,GAAG,EAAE,wBAAO,CAAC;qBAC3B,IAAI,CAAC;oBACJ,SAAS,EAAE,CAAC,SAAS,CAAC;oBACtB,KAAK,EAAE;wBACL,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE;qBACxB;iBACF,CAAC,CAAC;gBACL,KAAK,CAAC,QAAQ,GAAG,gBAAgB,CAAC;gBAClC,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,GAAG,IAAA,oCAAsB,EAAC,KAAK,CAAC,CAAC;gBACnE,IAAI,CAAC,GAAG,OAAO,EAAE,CAAC;oBAChB,OAAO,6DAA6D,CAAC;gBACvE,CAAC;YACH,CAAC;YACD,IACE,OAAO,CAAC,qBAAqB,KAAK,KAAK;gBACvC,SAAS,KAAK,aAAa;gBAC3B,OAAO,KAAK,WAAW;gBACvB,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EACtB,CAAC;gBACD,MAAM,UAAU,GAAG,IAAA,eAAM,EAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvE,MAAM,EAAE,GAAG,UAAU;qBAClB,aAAa,CAAC,GAAG,EAAE,uCAAc,CAAC;qBAClC,kBAAkB,CAAC,SAAS,CAAC;qBAC7B,QAAQ,CAAC,iBAAiB,EAAE,SAAS,CAAC;qBACtC,KAAK,CAAC,2BAA2B,CAAC;qBAClC,QAAQ,CAAC,2BAA2B,CAAC;qBACrC,QAAQ,CAAC,gCAAgC,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9D,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;gBAC7C,IAAI,iBAAiB,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;oBACnD,OAAO,yEAAyE,CAAC;gBACnF,CAAC;YACH,CAAC;YACD,IAAI,OAAO,KAAK,kBAAkB,EAAE,CAAC;gBACnC,IACE,OAAO,CAAC,gCAAgC,KAAK,KAAK;oBAClD,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EACxB,CAAC;oBACD,OAAO,0DAA0D,CAAC;gBACpE,CAAC;gBACD,IACE,OAAO,CAAC,gCAAgC,KAAK,KAAK;oBAClD,CAAC,KAAK,CAAC,QAAQ,EACf,CAAC;oBACD,OAAO,uDAAuD,CAAC;gBACjE,CAAC;gBACD,IACE,OAAO,CAAC,gCAAgC,KAAK,KAAK;oBAClD,CAAC,CAAC,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,EAC1D,CAAC;oBACD,OAAO,8DAA8D,CAAC;gBACxE,CAAC;gBACD,IAAI,OAAO,CAAC,6BAA6B,KAAK,KAAK,EAAE,CAAC;oBACpD,MAAM,qCAAqC,GAAqB,EAAE,CAAC;oBACnE,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;wBAC/B,MAAM,cAAc,GAClB,MAAM,qBAAqB,CAAC,qBAAqB,CAC/C,GAAG,EACH,IAAI,CAAC,cAAc,CACpB,CAAC;wBACJ,IAAI,IAAI,CAAC,QAAQ,GAAG,cAAc,EAAE,CAAC;4BACnC,qCAAqC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;wBAClE,CAAC;oBACH,CAAC;oBACD,IAAI,qCAAqC,CAAC,MAAM,EAAE,CAAC;wBACjD,OAAO,GAAG,CAAC,SAAS,CAClB,gEAAgE,EAChE;4BACE,mBAAmB,EAAE,qCAAqC;iCACvD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;iCAClB,IAAI,CAAC,IAAI,CAAC;yBACd,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IAAI,OAAO,CAAC,uBAAuB,KAAK,KAAK,EAAE,CAAC;gBAC9C,IAAI,OAAO,KAAK,mBAAmB,EAAE,CAAC;oBACpC,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAClD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,YAAY,CAChC,CAAC;oBACF,IACE,CAAC,IAAA,iCAAmB,EAAC,KAAK,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;wBACtD,CAAC,sBAAsB,EACvB,CAAC;wBACD,OAAO,uDAAuD,CAAC;oBACjE,CAAC;gBACH,CAAC;gBACD,IACE,OAAO,KAAK,gBAAgB;oBAC5B,CAAC,IAAA,iCAAmB,EAAC,KAAK,EAAE,SAAS,CAAC,EACtC,CAAC;oBACD,OAAO,oDAAoD,CAAC;gBAC9D,CAAC;YACH,CAAC;YACD,IAAI,OAAO,CAAC,yBAAyB,KAAK,KAAK,EAAE,CAAC;gBAChD,IACE,OAAO,KAAK,WAAW;oBACvB,SAAS,KAAK,aAAa;oBAC3B,SAAS,KAAK,kBAAkB,EAChC,CAAC;oBACD,IAAI,CAAC,IAAA,uCAAyB,EAAC,KAAK,CAAC,EAAE,CAAC;wBACtC,OAAO,gDAAgD,CAAC;oBAC1D,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IAAI,OAAO,CAAC,sBAAsB,KAAK,KAAK,EAAE,CAAC;gBAC7C,IAAI,OAAO,KAAK,kBAAkB,EAAE,CAAC;oBACnC,MAAM,qBAAqB,GAAG,MAAM,yBAAyB,CAC3D,GAAG,EACH,KAAK,CAAC,EAAE,CACT,CAAC;oBACF,IAAI,CAAC,IAAA,2CAA6B,EAAC,qBAAqB,CAAC,EAAE,CAAC;wBAC1D,OAAO,2DAA2D,CAAC;oBACrE,CAAC;gBACH,CAAC;gBACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,MAAM,qBAAqB,GAAG,MAAM,yBAAyB,CAC3D,GAAG,EACH,KAAK,CAAC,EAAE,CACT,CAAC;oBACF,IAAI,CAAC,IAAA,kCAAoB,EAAC,qBAAqB,CAAC,EAAE,CAAC;wBACjD,OAAO,0DAA0D,CAAC;oBACpE,CAAC;gBACH,CAAC;gBACD,IAAI,OAAO,KAAK,oBAAoB,EAAE,CAAC;oBACrC,MAAM,qBAAqB,GAAG,MAAM,yBAAyB,CAC3D,GAAG,EACH,KAAK,CAAC,EAAE,CACT,CAAC;oBACF,IAAI,CAAC,IAAA,6CAA+B,EAAC,qBAAqB,CAAC,EAAE,CAAC;wBAC5D,OAAO,6DAA6D,CAAC;oBACvE,CAAC;gBACH,CAAC;gBACD,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;oBAC5B,MAAM,qBAAqB,GAAG,MAAM,yBAAyB,CAC3D,GAAG,EACH,KAAK,CAAC,EAAE,CACT,CAAC;oBACF,IAAI,CAAC,IAAA,oCAAsB,EAAC,qBAAqB,CAAC,EAAE,CAAC;wBACnD,OAAO,4DAA4D,CAAC;oBACtE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI;YAC5C,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;YAC5B,MAAM,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,GACpD,aAAa,CAAC,YAAY,CAAC;YAC7B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBACjB,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,iBAAiB,CAC7D,GAAG,EACH,SAAS,EACT,OAAO,EACP,KAAK,CACN,CAAC;gBACF,IAAI,iBAAiB,EAAE,CAAC;oBACtB,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;oBACrB,KAAK,CAAC,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC;oBACjC,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;wBACvB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC;wBACzC,OAAO,UAAU;6BACd,aAAa,CAAC,GAAG,EAAE,6BAAS,CAAC;6BAC7B,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,mBAAmB,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC7D,CAAC,CAAC,CACH,CAAC;oBACF,MAAM,QAAQ,CAAC,OAAO,CACpB,IAAI,qCAAgB,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CACrD,CAAC;oBACF,MAAM,aAAa,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrD,CAAC;YACH,CAAC;YACD,MAAM,mBAAmB,GACvB,MAAM,uBAAuB,CAAC,mBAAmB,CAC/C,GAAG,EACH,SAAS,EACT,OAAO,EACP,KAAK,CACN,CAAC;YACJ,IAAI,mBAAmB,EAAE,CAAC;gBACxB,MAAM,oBAAoB,CAAC,yBAAyB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;gBAC5B,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;YACvB,CAAC;YACD,IAAI,SAAS,KAAK,OAAO,IAAI,OAAO,KAAK,kBAAkB,EAAE,CAAC;gBAC5D,kEAAkE;gBAClE,2EAA2E;gBAC3E,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;YACtB,CAAC;YACD,MAAM,cAAc,CAAC,0BAA0B,CAAC;gBAC9C,OAAO,EAAE,KAAK,CAAC,EAAE;gBACjB,IAAI,EAAE,kCAAgB,CAAC,sBAAsB;gBAC7C,GAAG;gBACH,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,EAAE,EAAE,OAAO;iBACZ;aACF,CAAC,CAAC;QACL,CAAC;KACF,CAAC;IAEF,KAAK,UAAU,yBAAyB,CACtC,GAAmB,EACnB,EAAM;QAEN,OAAO,MAAM,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,oBAAK,EAAE,EAAE,EAAE;YACvD,SAAS,EAAE;gBACT,OAAO;gBACP,cAAc;gBACd,oBAAoB;gBACpB,gCAAgC;aACjC;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA5WD,oEA4WC;AAED;;;;;;;;;GASG;AACU,QAAA,mBAAmB,GAAG,4BAA4B,CAAC,EAAE,CAAC,CAAC"}

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

@@ -0,0 +1,11 @@
+import { OrderSellerStrategy } from "./order-seller-strategy";
+/**
+ * @description
+ * The DefaultOrderSellerStrategy treats the Order as single-vendor.
+ *
+ * @since 2.0.0
+ * @docsCategory orders
+ * @docsPage OrderSellerStrategy
+ */
+export declare class DefaultOrderSellerStrategy implements OrderSellerStrategy {
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultOrderSellerStrategy = void 0;
+/**
+ * @description
+ * The DefaultOrderSellerStrategy treats the Order as single-vendor.
+ *
+ * @since 2.0.0
+ * @docsCategory orders
+ * @docsPage OrderSellerStrategy
+ */
+class DefaultOrderSellerStrategy {
+}
+exports.DefaultOrderSellerStrategy = DefaultOrderSellerStrategy;
+//# sourceMappingURL=default-order-seller-strategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"default-order-seller-strategy.js","sourceRoot":"","sources":["../../../src/config/order/default-order-seller-strategy.ts"],"names":[],"mappings":";;;AAEA;;;;;;;GAOG;AACH,MAAa,0BAA0B;CAEtC;AAFD,gEAEC"}

package/dist/config/order/default-stock-allocation-strategy.d.ts

@@ -0,0 +1,14 @@
+import { RequestContext } from "../../api/common/request-context";
+import { Order } from "../../entity/order/order.entity";
+import { OrderState } from "../../service/helpers/order-state-machine/order-state";
+import { StockAllocationStrategy } from "./stock-allocation-strategy";
+/**
+ * @description
+ * Allocates stock when the Order transitions from `ArrangingPayment` to either
+ * `PaymentAuthorized` or `PaymentSettled`.
+ *
+ * @docsCategory orders
+ */
+export declare class DefaultStockAllocationStrategy implements StockAllocationStrategy {
+    shouldAllocateStock(ctx: RequestContext, fromState: OrderState, toState: OrderState, order: Order): boolean | Promise<boolean>;
+}

package/dist/config/order/default-stock-allocation-strategy.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultStockAllocationStrategy = void 0;
+/**
+ * @description
+ * Allocates stock when the Order transitions from `ArrangingPayment` to either
+ * `PaymentAuthorized` or `PaymentSettled`.
+ *
+ * @docsCategory orders
+ */
+class DefaultStockAllocationStrategy {
+    shouldAllocateStock(ctx, fromState, toState, order) {
+        return (fromState === "ArrangingPayment" &&
+            (toState === "PaymentAuthorized" || toState === "PaymentSettled"));
+    }
+}
+exports.DefaultStockAllocationStrategy = DefaultStockAllocationStrategy;
+//# sourceMappingURL=default-stock-allocation-strategy.js.map

package/dist/config/order/default-stock-allocation-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-stock-allocation-strategy.js","sourceRoot":"","sources":["../../../src/config/order/default-stock-allocation-strategy.ts"],"names":[],"mappings":";;;AAMA;;;;;;GAMG;AACH,MAAa,8BAA8B;IACzC,mBAAmB,CACjB,GAAmB,EACnB,SAAqB,EACrB,OAAmB,EACnB,KAAY;QAEZ,OAAO,CACL,SAAS,KAAK,kBAAkB;YAChC,CAAC,OAAO,KAAK,mBAAmB,IAAI,OAAO,KAAK,gBAAgB,CAAC,CAClE,CAAC;IACJ,CAAC;CACF;AAZD,wEAYC"}

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

@@ -0,0 +1,38 @@
+import { CreateCustomerInput, SetCustomerForOrderResult } from "@deenruv/common/lib/generated-shop-types";
+import { RequestContext } from "../../api/common/request-context";
+import { ErrorResultUnion } from "../../common/error/error-result";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { Customer } from "../../entity/customer/customer.entity";
+import { Order } from "../../entity/order/order.entity";
+/**
+ * @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
+ *
+ * :::info
+ *
+ * This is configured via the `orderOptions.guestCheckoutStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @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/merge-orders-strategy.d.ts

@@ -0,0 +1,15 @@
+import { RequestContext } from "../../api/common/request-context";
+import { Order } from "../../entity/order/order.entity";
+import { MergedOrderLine, OrderMergeStrategy } from "./order-merge-strategy";
+/**
+ * @description
+ * Merges both Orders. If the guest order contains items which are already in the
+ * existing Order, the guest Order quantity will replace that of the existing Order.
+ *
+ * @docsCategory orders
+ * @docsPage Merge Strategies
+ */
+export declare class MergeOrdersStrategy implements OrderMergeStrategy {
+    merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): MergedOrderLine[];
+    private findCorrespondingLine;
+}