@deenruv/core 1.0.0

package/dist/entity/order/order.entity.js

@@ -0,0 +1,341 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Order = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const typeorm_1 = require("typeorm");
+const calculated_decorator_1 = require("../../common/calculated-decorator");
+const errors_1 = require("../../common/error/errors");
+const base_entity_1 = require("../base/base.entity");
+const channel_entity_1 = require("../channel/channel.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const customer_entity_1 = require("../customer/customer.entity");
+const entity_id_decorator_1 = require("../entity-id.decorator");
+const fulfillment_entity_1 = require("../fulfillment/fulfillment.entity");
+const money_decorator_1 = require("../money.decorator");
+const order_line_entity_1 = require("../order-line/order-line.entity");
+const order_modification_entity_1 = require("../order-modification/order-modification.entity");
+const payment_entity_1 = require("../payment/payment.entity");
+const promotion_entity_1 = require("../promotion/promotion.entity");
+const shipping_line_entity_1 = require("../shipping-line/shipping-line.entity");
+const surcharge_entity_1 = require("../surcharge/surcharge.entity");
+/**
+ * @description
+ * An Order is created whenever a {@link Customer} adds an item to the cart. It contains all the
+ * information required to fulfill an order: which {@link ProductVariant}s in what quantities;
+ * the shipping address and price; any applicable promotions; payments etc.
+ *
+ * An Order exists in a well-defined state according to the {@link OrderState} type. A state machine
+ * is used to govern the transition from one state to another.
+ *
+ * @docsCategory entities
+ */
+let Order = class Order extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+    get discounts() {
+        var _a, _b;
+        this.throwIfLinesNotJoined("discounts");
+        const groupedAdjustments = new Map();
+        for (const line of (_a = this.lines) !== null && _a !== void 0 ? _a : []) {
+            for (const discount of line.discounts) {
+                const adjustment = groupedAdjustments.get(discount.adjustmentSource);
+                if (adjustment) {
+                    adjustment.amount += discount.amount;
+                    adjustment.amountWithTax += discount.amountWithTax;
+                }
+                else {
+                    groupedAdjustments.set(discount.adjustmentSource, Object.assign({}, discount));
+                }
+            }
+        }
+        for (const shippingLine of (_b = this.shippingLines) !== null && _b !== void 0 ? _b : []) {
+            for (const discount of shippingLine.discounts) {
+                const adjustment = groupedAdjustments.get(discount.adjustmentSource);
+                if (adjustment) {
+                    adjustment.amount += discount.amount;
+                    adjustment.amountWithTax += discount.amountWithTax;
+                }
+                else {
+                    groupedAdjustments.set(discount.adjustmentSource, Object.assign({}, discount));
+                }
+            }
+        }
+        return [...groupedAdjustments.values()];
+    }
+    /**
+     * @description
+     * Equal to `subTotal` plus `shipping`
+     */
+    get total() {
+        return this.subTotal + (this.shipping || 0);
+    }
+    /**
+     * @description
+     * The final payable amount. Equal to `subTotalWithTax` plus `shippingWithTax`.
+     */
+    get totalWithTax() {
+        return this.subTotalWithTax + (this.shippingWithTax || 0);
+    }
+    get totalQuantity() {
+        this.throwIfLinesNotJoined("totalQuantity");
+        return (0, shared_utils_1.summate)(this.lines, "quantity");
+    }
+    /**
+     * @description
+     * A summary of the taxes being applied to this Order.
+     */
+    get taxSummary() {
+        var _a, _b, _c;
+        this.throwIfLinesNotJoined("taxSummary");
+        const taxRateMap = new Map();
+        const taxId = (taxLine) => `${taxLine.description}:${taxLine.taxRate}`;
+        const taxableLines = [
+            ...((_a = this.lines) !== null && _a !== void 0 ? _a : []),
+            ...((_b = this.shippingLines) !== null && _b !== void 0 ? _b : []),
+            ...((_c = this.surcharges) !== null && _c !== void 0 ? _c : []),
+        ];
+        for (const line of taxableLines) {
+            const taxRateTotal = (0, shared_utils_1.summate)(line.taxLines, "taxRate");
+            for (const taxLine of line.taxLines) {
+                const id = taxId(taxLine);
+                const row = taxRateMap.get(id);
+                const proportionOfTotalRate = 0 < taxLine.taxRate ? taxLine.taxRate / taxRateTotal : 0;
+                const lineBase = line instanceof order_line_entity_1.OrderLine
+                    ? line.proratedLinePrice
+                    : line instanceof surcharge_entity_1.Surcharge
+                        ? line.price
+                        : line.discountedPrice;
+                const lineWithTax = line instanceof order_line_entity_1.OrderLine
+                    ? line.proratedLinePriceWithTax
+                    : line instanceof surcharge_entity_1.Surcharge
+                        ? line.priceWithTax
+                        : line.discountedPriceWithTax;
+                const amount = Math.round((lineWithTax - lineBase) * proportionOfTotalRate);
+                if (row) {
+                    row.tax += amount;
+                    row.base += lineBase;
+                }
+                else {
+                    taxRateMap.set(id, {
+                        tax: amount,
+                        base: lineBase,
+                        description: taxLine.description,
+                        rate: taxLine.taxRate,
+                    });
+                }
+            }
+        }
+        return Array.from(taxRateMap.entries()).map(([taxRate, row]) => ({
+            taxRate: row.rate,
+            description: row.description,
+            taxBase: row.base,
+            taxTotal: row.tax,
+        }));
+    }
+    throwIfLinesNotJoined(propertyName) {
+        if (this.lines == null) {
+            const errorMessage = [
+                `The property "${propertyName}" on the Order entity requires the Order.lines relation to be joined.`,
+                "This can be done with the EntityHydratorService: `await entityHydratorService.hydrate(ctx, order, { relations: ['lines'] })`",
+            ];
+            throw new errors_1.InternalServerError(errorMessage.join("\n"));
+        }
+    }
+};
+exports.Order = Order;
+__decorate([
+    (0, typeorm_1.Column)("varchar", { default: generated_types_1.OrderType.Regular }),
+    __metadata("design:type", String)
+], Order.prototype, "type", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => Order, (sellerOrder) => sellerOrder.aggregateOrder),
+    __metadata("design:type", Array)
+], Order.prototype, "sellerOrders", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => Order, (aggregateOrder) => aggregateOrder.sellerOrders),
+    __metadata("design:type", Order)
+], Order.prototype, "aggregateOrder", void 0);
+__decorate([
+    (0, entity_id_decorator_1.EntityId)({ nullable: true }),
+    __metadata("design:type", Object)
+], Order.prototype, "aggregateOrderId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    (0, typeorm_1.Index)({ unique: true }),
+    __metadata("design:type", String)
+], Order.prototype, "code", void 0);
+__decorate([
+    (0, typeorm_1.Column)("varchar"),
+    __metadata("design:type", String)
+], Order.prototype, "state", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: true }),
+    __metadata("design:type", Boolean)
+], Order.prototype, "active", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", Date)
+], Order.prototype, "orderPlacedAt", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => customer_entity_1.Customer, (customer) => customer.orders),
+    __metadata("design:type", customer_entity_1.Customer)
+], Order.prototype, "customer", void 0);
+__decorate([
+    (0, entity_id_decorator_1.EntityId)({ nullable: true }),
+    __metadata("design:type", Object)
+], Order.prototype, "customerId", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => order_line_entity_1.OrderLine, (line) => line.order),
+    __metadata("design:type", Array)
+], Order.prototype, "lines", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => surcharge_entity_1.Surcharge, (surcharge) => surcharge.order),
+    __metadata("design:type", Array)
+], Order.prototype, "surcharges", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-array"),
+    __metadata("design:type", Array)
+], Order.prototype, "couponCodes", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-array", { default: "" }),
+    __metadata("design:type", Array)
+], Order.prototype, "excludedPromotionIds", void 0);
+__decorate([
+    (0, typeorm_1.ManyToMany)((type) => promotion_entity_1.Promotion, (promotion) => promotion.orders),
+    (0, typeorm_1.JoinTable)(),
+    __metadata("design:type", Array)
+], Order.prototype, "promotions", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-json"),
+    __metadata("design:type", Object)
+], Order.prototype, "shippingAddress", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-json"),
+    __metadata("design:type", Object)
+], Order.prototype, "billingAddress", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => payment_entity_1.Payment, (payment) => payment.order),
+    __metadata("design:type", Array)
+], Order.prototype, "payments", void 0);
+__decorate([
+    (0, typeorm_1.ManyToMany)((type) => fulfillment_entity_1.Fulfillment, (fulfillment) => fulfillment.orders),
+    (0, typeorm_1.JoinTable)(),
+    __metadata("design:type", Array)
+], Order.prototype, "fulfillments", void 0);
+__decorate([
+    (0, typeorm_1.Column)("varchar"),
+    __metadata("design:type", String)
+], Order.prototype, "currencyCode", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomOrderFields),
+    __metadata("design:type", custom_entity_fields_1.CustomOrderFields)
+], Order.prototype, "customFields", void 0);
+__decorate([
+    (0, entity_id_decorator_1.EntityId)({ nullable: true }),
+    __metadata("design:type", Object)
+], Order.prototype, "taxZoneId", void 0);
+__decorate([
+    (0, typeorm_1.ManyToMany)((type) => channel_entity_1.Channel),
+    (0, typeorm_1.JoinTable)(),
+    __metadata("design:type", Array)
+], Order.prototype, "channels", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => order_modification_entity_1.OrderModification, (modification) => modification.order),
+    __metadata("design:type", Array)
+], Order.prototype, "modifications", void 0);
+__decorate([
+    (0, money_decorator_1.Money)(),
+    __metadata("design:type", Number)
+], Order.prototype, "subTotal", void 0);
+__decorate([
+    (0, money_decorator_1.Money)(),
+    __metadata("design:type", Number)
+], Order.prototype, "subTotalWithTax", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => shipping_line_entity_1.ShippingLine, (shippingLine) => shippingLine.order),
+    __metadata("design:type", Array)
+], Order.prototype, "shippingLines", void 0);
+__decorate([
+    (0, money_decorator_1.Money)({ default: 0 }),
+    __metadata("design:type", Number)
+], Order.prototype, "shipping", void 0);
+__decorate([
+    (0, money_decorator_1.Money)({ default: 0 }),
+    __metadata("design:type", Number)
+], Order.prototype, "shippingWithTax", void 0);
+__decorate([
+    (0, calculated_decorator_1.Calculated)({ relations: ["lines", "shippingLines"] }),
+    __metadata("design:type", Array),
+    __metadata("design:paramtypes", [])
+], Order.prototype, "discounts", null);
+__decorate([
+    (0, calculated_decorator_1.Calculated)({
+        query: (qb) => qb
+            .leftJoin((qb1) => {
+            return qb1
+                .from(Order, "order")
+                .select("order.shipping + order.subTotal", "total")
+                .addSelect("order.id", "oid");
+        }, "t1", "t1.oid = order.id")
+            .addSelect("t1.total", "total"),
+        expression: "total",
+    }),
+    __metadata("design:type", Number),
+    __metadata("design:paramtypes", [])
+], Order.prototype, "total", null);
+__decorate([
+    (0, calculated_decorator_1.Calculated)({
+        query: (qb) => qb
+            .leftJoin((qb1) => {
+            return qb1
+                .from(Order, "order")
+                .select("order.shippingWithTax + order.subTotalWithTax", "twt")
+                .addSelect("order.id", "oid");
+        }, "t1", "t1.oid = order.id")
+            .addSelect("t1.twt", "twt"),
+        expression: "twt",
+    }),
+    __metadata("design:type", Number),
+    __metadata("design:paramtypes", [])
+], Order.prototype, "totalWithTax", null);
+__decorate([
+    (0, calculated_decorator_1.Calculated)({
+        relations: ["lines"],
+        query: (qb) => {
+            qb.leftJoin((qb1) => {
+                return qb1
+                    .from(Order, "order")
+                    .select("SUM(lines.quantity)", "qty")
+                    .addSelect("order.id", "oid")
+                    .leftJoin("order.lines", "lines")
+                    .groupBy("order.id");
+            }, "t1", "t1.oid = order.id").addSelect("t1.qty", "qty");
+        },
+        expression: "qty",
+    }),
+    __metadata("design:type", Number),
+    __metadata("design:paramtypes", [])
+], Order.prototype, "totalQuantity", null);
+__decorate([
+    (0, calculated_decorator_1.Calculated)({ relations: ["lines"] }),
+    __metadata("design:type", Array),
+    __metadata("design:paramtypes", [])
+], Order.prototype, "taxSummary", null);
+exports.Order = Order = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], Order);
+//# sourceMappingURL=order.entity.js.map

package/dist/entity/order/order.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.entity.js","sourceRoot":"","sources":["../../../src/entity/order/order.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yEAO6C;AAE7C,mEAA2D;AAC3D,qCAQiB;AAEjB,4EAA+D;AAC/D,sDAAgE;AAIhE,qDAAoD;AACpD,8DAAoD;AACpD,kEAA4D;AAC5D,iEAAuD;AACvD,gEAAkD;AAClD,0EAAgE;AAChE,wDAA2C;AAC3C,uEAA4D;AAC5D,+FAAoF;AACpF,8DAAoD;AACpD,oEAA0D;AAC1D,gFAAqE;AACrE,oEAA0D;AAE1D;;;;;;;;;;GAUG;AAEI,IAAM,KAAK,GAAX,MAAM,KACX,SAAQ,2BAAa;IAGrB,YAAY,KAA0B;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAsJD,IACI,SAAS;;QACX,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACxC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAoB,CAAC;QACvD,KAAK,MAAM,IAAI,IAAI,MAAA,IAAI,CAAC,KAAK,mCAAI,EAAE,EAAE,CAAC;YACpC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACtC,MAAM,UAAU,GAAG,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;gBACrE,IAAI,UAAU,EAAE,CAAC;oBACf,UAAU,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;oBACrC,UAAU,CAAC,aAAa,IAAI,QAAQ,CAAC,aAAa,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACN,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,oBAAO,QAAQ,EAAG,CAAC;gBACrE,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,MAAM,YAAY,IAAI,MAAA,IAAI,CAAC,aAAa,mCAAI,EAAE,EAAE,CAAC;YACpD,KAAK,MAAM,QAAQ,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC;gBAC9C,MAAM,UAAU,GAAG,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;gBACrE,IAAI,UAAU,EAAE,CAAC;oBACf,UAAU,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;oBACrC,UAAU,CAAC,aAAa,IAAI,QAAQ,CAAC,aAAa,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACN,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,oBAAO,QAAQ,EAAG,CAAC;gBACrE,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,CAAC,GAAG,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,IAgBI,KAAK;QACP,OAAO,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,IAgBI,YAAY;QACd,OAAO,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,IAkBI,aAAa;QACf,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;QAC5C,OAAO,IAAA,sBAAO,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IACI,UAAU;;QACZ,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,GAAG,EAGvB,CAAC;QACJ,MAAM,KAAK,GAAG,CAAC,OAAgB,EAAU,EAAE,CACzC,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QAC9C,MAAM,YAAY,GAAG;YACnB,GAAG,CAAC,MAAA,IAAI,CAAC,KAAK,mCAAI,EAAE,CAAC;YACrB,GAAG,CAAC,MAAA,IAAI,CAAC,aAAa,mCAAI,EAAE,CAAC;YAC7B,GAAG,CAAC,MAAA,IAAI,CAAC,UAAU,mCAAI,EAAE,CAAC;SAC3B,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;YAChC,MAAM,YAAY,GAAG,IAAA,sBAAO,EAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACvD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACpC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC1B,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC/B,MAAM,qBAAqB,GACzB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE3D,MAAM,QAAQ,GACZ,IAAI,YAAY,6BAAS;oBACvB,CAAC,CAAC,IAAI,CAAC,iBAAiB;oBACxB,CAAC,CAAC,IAAI,YAAY,4BAAS;wBACzB,CAAC,CAAC,IAAI,CAAC,KAAK;wBACZ,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;gBAC7B,MAAM,WAAW,GACf,IAAI,YAAY,6BAAS;oBACvB,CAAC,CAAC,IAAI,CAAC,wBAAwB;oBAC/B,CAAC,CAAC,IAAI,YAAY,4BAAS;wBACzB,CAAC,CAAC,IAAI,CAAC,YAAY;wBACnB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC;gBACpC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CACvB,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,qBAAqB,CACjD,CAAC;gBACF,IAAI,GAAG,EAAE,CAAC;oBACR,GAAG,CAAC,GAAG,IAAI,MAAM,CAAC;oBAClB,GAAG,CAAC,IAAI,IAAI,QAAQ,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE;wBACjB,GAAG,EAAE,MAAM;wBACX,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,IAAI,EAAE,OAAO,CAAC,OAAO;qBACtB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC/D,OAAO,EAAE,GAAG,CAAC,IAAI;YACjB,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,OAAO,EAAE,GAAG,CAAC,IAAI;YACjB,QAAQ,EAAE,GAAG,CAAC,GAAG;SAClB,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,qBAAqB,CAAC,YAAyB;QACrD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,YAAY,GAAG;gBACnB,iBAAiB,YAAY,uEAAuE;gBACpG,8HAA8H;aAC/H,CAAC;YAEF,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CACF,CAAA;AAxUY,sBAAK;AAShB;IADC,IAAA,gBAAM,EAAC,SAAS,EAAE,EAAE,OAAO,EAAE,2BAAS,CAAC,OAAO,EAAE,CAAC;;mCAClC;AAGhB;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC;;2CAClD;AAItB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,YAAY,CAAC;8BAC3D,KAAK;6CAAC;AAGvB;IADC,IAAA,8BAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACP;AAUtB;IAFC,IAAA,gBAAM,GAAE;IACR,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;mCACX;AAEM;IAAlB,IAAA,gBAAM,EAAC,SAAS,CAAC;;oCAAmB;AAUrC;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;qCACV;AAShB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACX,IAAI;4CAAC;AAIrB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,0BAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;8BAClD,0BAAQ;uCAAC;AAGpB;IADC,IAAA,8BAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCACb;AAGhB;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,6BAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;;oCAClC;AAUnB;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,4BAAS,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC;;yCACvC;AAOxB;IADC,IAAA,gBAAM,EAAC,cAAc,CAAC;;0CACD;AAOtB;IADC,IAAA,gBAAM,EAAC,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;mDACT;AAS/B;IAFC,IAAA,oBAAU,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,4BAAS,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC;IAChE,IAAA,mBAAS,GAAE;;yCACY;AAED;IAAtB,IAAA,gBAAM,EAAC,aAAa,CAAC;;8CAA+B;AAE9B;IAAtB,IAAA,gBAAM,EAAC,aAAa,CAAC;;6CAA8B;AAGpD;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;;uCACrC;AAIpB;IAFC,IAAA,oBAAU,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gCAAW,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC;IACtE,IAAA,mBAAS,GAAE;;2CACgB;AAG5B;IADC,IAAA,gBAAM,EAAC,SAAS,CAAC;;2CACS;AAG3B;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wCAAiB,CAAC;8BACtB,wCAAiB;2CAAC;AAGhC;IADC,IAAA,8BAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wCACd;AAIf;IAFC,IAAA,oBAAU,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAO,CAAC;IAC7B,IAAA,mBAAS,GAAE;;uCACQ;AAGpB;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,6CAAiB,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC;;4CAC1C;AAUnC;IADC,IAAA,uBAAK,GAAE;;uCACS;AAOjB;IADC,IAAA,uBAAK,GAAE;;8CACgB;AAOxB;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mCAAY,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC;;4CAC1C;AAO9B;IADC,IAAA,uBAAK,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;uCACL;AAGjB;IADC,IAAA,uBAAK,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;8CACE;AAExB;IAAC,IAAA,iCAAU,EAAC,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,EAAE,CAAC;;;sCA2BrD;AAMD;IAAC,IAAA,iCAAU,EAAC;QACV,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CACZ,EAAE;aACC,QAAQ,CACP,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,GAAG;iBACP,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;iBACpB,MAAM,CAAC,iCAAiC,EAAE,OAAO,CAAC;iBAClD,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC,EACD,IAAI,EACJ,mBAAmB,CACpB;aACA,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;QACnC,UAAU,EAAE,OAAO;KACpB,CAAC;;;kCAGD;AAMD;IAAC,IAAA,iCAAU,EAAC;QACV,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CACZ,EAAE;aACC,QAAQ,CACP,CAAC,GAAG,EAAE,EAAE;YACN,OAAO,GAAG;iBACP,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;iBACpB,MAAM,CAAC,+CAA+C,EAAE,KAAK,CAAC;iBAC9D,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC,EACD,IAAI,EACJ,mBAAmB,CACpB;aACA,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC/B,UAAU,EAAE,KAAK;KAClB,CAAC;;;yCAGD;AAED;IAAC,IAAA,iCAAU,EAAC;QACV,SAAS,EAAE,CAAC,OAAO,CAAC;QACpB,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE;YACZ,EAAE,CAAC,QAAQ,CACT,CAAC,GAAG,EAAE,EAAE;gBACN,OAAO,GAAG;qBACP,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;qBACpB,MAAM,CAAC,qBAAqB,EAAE,KAAK,CAAC;qBACpC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC;qBAC5B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;qBAChC,OAAO,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC,EACD,IAAI,EACJ,mBAAmB,CACpB,CAAC,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,UAAU,EAAE,KAAK;KAClB,CAAC;;;0CAID;AAMD;IAAC,IAAA,iCAAU,EAAC,EAAE,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;;;uCAwDpC;gBA5TU,KAAK;IADjB,IAAA,gBAAM,GAAE;;GACI,KAAK,CAwUjB"}

package/dist/entity/order-line/order-line.entity.d.ts

@@ -0,0 +1,201 @@
+import { Adjustment, AdjustmentType, Discount, TaxLine } from "@deenruv/common/lib/generated-types";
+import { DeepPartial, ID } from "@deenruv/common/lib/shared-types";
+import { HasCustomFields } from "../../config/custom-field/custom-field-types";
+import { Asset } from "../asset/asset.entity";
+import { DeenruvEntity } from "../base/base.entity";
+import { Channel } from "../channel/channel.entity";
+import { CustomOrderLineFields } from "../custom-entity-fields";
+import { Order } from "../order/order.entity";
+import { OrderLineReference } from "../order-line-reference/order-line-reference.entity";
+import { ProductVariant } from "../product-variant/product-variant.entity";
+import { ShippingLine } from "../shipping-line/shipping-line.entity";
+import { Allocation } from "../stock-movement/allocation.entity";
+import { Cancellation } from "../stock-movement/cancellation.entity";
+import { Sale } from "../stock-movement/sale.entity";
+import { TaxCategory } from "../tax-category/tax-category.entity";
+/**
+ * @description
+ * A single line on an {@link Order} which contains information about the {@link ProductVariant} and
+ * quantity ordered, as well as the price and tax information.
+ *
+ * @docsCategory entities
+ */
+export declare class OrderLine extends DeenruvEntity implements HasCustomFields {
+    constructor(input?: DeepPartial<OrderLine>);
+    /**
+     * @description
+     * The {@link Channel} of the {@link Seller} for a multivendor setup.
+     */
+    sellerChannel?: Channel;
+    sellerChannelId?: ID;
+    /**
+     * @description
+     * The {@link ShippingLine} to which this line has been assigned.
+     * This is determined by the configured {@link ShippingLineAssignmentStrategy}.
+     */
+    shippingLine?: ShippingLine;
+    shippingLineId?: ID;
+    /**
+     * @description
+     * The {@link ProductVariant} which is being ordered.
+     */
+    productVariant: ProductVariant;
+    productVariantId: ID;
+    taxCategory: TaxCategory;
+    featuredAsset: Asset;
+    order: Order;
+    linesReferences: OrderLineReference[];
+    sales: Sale[];
+    quantity: number;
+    /**
+     * @description
+     * The quantity of this OrderLine at the time the order was placed (as per the {@link OrderPlacedStrategy}).
+     */
+    orderPlacedQuantity: number;
+    /**
+     * @description
+     * The price as calculated when the OrderLine was first added to the Order. Usually will be identical to the
+     * `listPrice`, except when the ProductVariant price has changed in the meantime and a re-calculation of
+     * the Order has been performed.
+     */
+    initialListPrice: number;
+    /**
+     * @description
+     * This is the price as listed by the ProductVariant (and possibly modified by the {@link OrderItemPriceCalculationStrategy}),
+     * which, depending on the current Channel, may or may not include tax.
+     */
+    listPrice: number;
+    /**
+     * @description
+     * Whether the listPrice includes tax, which depends on the settings of the current Channel.
+     */
+    listPriceIncludesTax: boolean;
+    adjustments: Adjustment[];
+    taxLines: TaxLine[];
+    cancellations: Cancellation[];
+    allocations: Allocation[];
+    customFields: CustomOrderLineFields;
+    /**
+     * @description
+     * The price of a single unit, excluding tax and discounts.
+     */
+    get unitPrice(): number;
+    /**
+     * @description
+     * The price of a single unit, including tax but excluding discounts.
+     */
+    get unitPriceWithTax(): number;
+    /**
+     * @description
+     * Non-zero if the `unitPrice` has changed since it was initially added to Order.
+     */
+    get unitPriceChangeSinceAdded(): number;
+    /**
+     * @description
+     * Non-zero if the `unitPriceWithTax` has changed since it was initially added to Order.
+     */
+    get unitPriceWithTaxChangeSinceAdded(): number;
+    /**
+     * @description
+     * The price of a single unit including discounts, excluding tax.
+     *
+     * If Order-level discounts have been applied, this will not be the
+     * actual taxable unit price (see `proratedUnitPrice`), but is generally the
+     * correct price to display to customers to avoid confusion
+     * about the internal handling of distributed Order-level discounts.
+     */
+    get discountedUnitPrice(): number;
+    /**
+     * @description
+     * The price of a single unit including discounts and tax
+     */
+    get discountedUnitPriceWithTax(): number;
+    /**
+     * @description
+     * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
+     * Order-level discounts. This value is the true economic value of a single unit in this OrderLine, and is used in tax
+     * and refund calculations.
+     */
+    get proratedUnitPrice(): number;
+    /**
+     * @description
+     * The `proratedUnitPrice` including tax.
+     */
+    get proratedUnitPriceWithTax(): number;
+    get unitTax(): number;
+    get proratedUnitTax(): number;
+    get taxRate(): number;
+    /**
+     * @description
+     * The total price of the line excluding tax and discounts.
+     */
+    get linePrice(): number;
+    /**
+     * @description
+     * The total price of the line including tax but excluding discounts.
+     */
+    get linePriceWithTax(): number;
+    /**
+     * @description
+     * The price of the line including discounts, excluding tax.
+     */
+    get discountedLinePrice(): number;
+    /**
+     * @description
+     * The price of the line including discounts and tax.
+     */
+    get discountedLinePriceWithTax(): number;
+    get discounts(): Discount[];
+    /**
+     * @description
+     * The total tax on this line.
+     */
+    get lineTax(): number;
+    /**
+     * @description
+     * The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
+     * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
+     * and refund calculations.
+     */
+    get proratedLinePrice(): number;
+    /**
+     * @description
+     * The `proratedLinePrice` including tax.
+     */
+    get proratedLinePriceWithTax(): number;
+    get proratedLineTax(): number;
+    addAdjustment(adjustment: Adjustment): void;
+    /**
+     * Clears Adjustments from all OrderItems of the given type. If no type
+     * is specified, then all adjustments are removed.
+     */
+    clearAdjustments(type?: AdjustmentType): void;
+    private _unitPrice;
+    private _unitPriceWithTax;
+    private _discountedUnitPrice;
+    private _discountedUnitPriceWithTax;
+    /**
+     * @description
+     * Calculates the prorated unit price, excluding tax. This function performs no
+     * rounding, so before being exposed publicly via the GraphQL API, the returned value
+     * needs to be rounded to ensure it is an integer.
+     */
+    private _proratedUnitPrice;
+    /**
+     * @description
+     * Calculates the prorated unit price, including tax. This function performs no
+     * rounding, so before being exposed publicly via the GraphQL API, the returned value
+     * needs to be rounded to ensure it is an integer.
+     */
+    private _proratedUnitPriceWithTax;
+    /**
+     * @description
+     * The total of all price adjustments. Will typically be a negative number due to discounts.
+     */
+    private getUnitAdjustmentsTotal;
+    /**
+     * @description
+     * The total of all price adjustments. Will typically be a negative number due to discounts.
+     */
+    private getLineAdjustmentsTotal;
+}