@deenruv/core 1.0.0

package/dist/entity/promotion/promotion.entity.js

@@ -0,0 +1,198 @@
+"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.Promotion = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const typeorm_1 = require("typeorm");
+const round_money_1 = require("../../common/round-money");
+const adjustment_source_1 = require("../../common/types/adjustment-source");
+const config_helpers_1 = require("../../config/config-helpers");
+const promotion_action_1 = require("../../config/promotion/promotion-action");
+const channel_entity_1 = require("../channel/channel.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const order_entity_1 = require("../order/order.entity");
+const promotion_translation_entity_1 = require("./promotion-translation.entity");
+/**
+ * @description
+ * A Promotion is used to define a set of conditions under which promotions actions (typically discounts)
+ * will be applied to an Order.
+ *
+ * Each assigned {@link PromotionCondition} is checked against the Order, and if they all return `true`,
+ * then each assign {@link PromotionItemAction} / {@link PromotionOrderAction} is applied to the Order.
+ *
+ * @docsCategory entities
+ */
+let Promotion = class Promotion extends adjustment_source_1.AdjustmentSource {
+    constructor(input) {
+        super(input);
+        this.type = generated_types_1.AdjustmentType.PROMOTION;
+        this.allConditions = {};
+        this.allActions = {};
+        const conditions = (input && input.promotionConditions) ||
+            (0, config_helpers_1.getConfig)().promotionOptions.promotionConditions ||
+            [];
+        const actions = (input && input.promotionActions) ||
+            (0, config_helpers_1.getConfig)().promotionOptions.promotionActions ||
+            [];
+        this.allConditions = conditions.reduce((hash, o) => (Object.assign(Object.assign({}, hash), { [o.code]: o })), {});
+        this.allActions = actions.reduce((hash, o) => (Object.assign(Object.assign({}, hash), { [o.code]: o })), {});
+    }
+    async apply(ctx, args, state) {
+        let amount = 0;
+        state = state || {};
+        for (const action of this.actions) {
+            const promotionAction = this.allActions[action.code];
+            if (promotionAction instanceof promotion_action_1.PromotionItemAction) {
+                if (this.isOrderItemArg(args)) {
+                    const { orderLine } = args;
+                    amount += (0, round_money_1.roundMoney)(await promotionAction.execute(ctx, orderLine, action.args, state, this));
+                }
+            }
+            else if (promotionAction instanceof promotion_action_1.PromotionOrderAction) {
+                if (this.isOrderArg(args)) {
+                    const { order } = args;
+                    amount += (0, round_money_1.roundMoney)(await promotionAction.execute(ctx, order, action.args, state, this));
+                }
+            }
+            else if (promotionAction instanceof promotion_action_1.PromotionShippingAction) {
+                if (this.isShippingArg(args)) {
+                    const { shippingLine, order } = args;
+                    amount += (0, round_money_1.roundMoney)(await promotionAction.execute(ctx, shippingLine, order, action.args, state, this));
+                }
+            }
+        }
+        if (amount !== 0) {
+            return {
+                amount,
+                type: this.type,
+                description: this.name,
+                adjustmentSource: this.getSourceId(),
+                data: {},
+            };
+        }
+    }
+    async test(ctx, order) {
+        if (this.endsAt && this.endsAt < new Date()) {
+            return false;
+        }
+        if (this.startsAt && this.startsAt > new Date()) {
+            return false;
+        }
+        if (this.couponCode && !order.couponCodes.includes(this.couponCode)) {
+            return false;
+        }
+        if (((order === null || order === void 0 ? void 0 : order.excludedPromotionIds) || []).includes(this.id.toString())) {
+            return false;
+        }
+        const promotionState = {};
+        for (const condition of this.conditions) {
+            const promotionCondition = this.allConditions[condition.code];
+            if (!promotionCondition) {
+                return false;
+            }
+            const applicableOrConditionState = await promotionCondition.check(ctx, order, condition.args, this);
+            if (!applicableOrConditionState) {
+                return false;
+            }
+            if (typeof applicableOrConditionState === "object") {
+                promotionState[condition.code] = applicableOrConditionState;
+            }
+        }
+        return promotionState;
+    }
+    async activate(ctx, order) {
+        for (const action of this.actions) {
+            const promotionAction = this.allActions[action.code];
+            await promotionAction.onActivate(ctx, order, action.args, this);
+        }
+    }
+    async deactivate(ctx, order) {
+        for (const action of this.actions) {
+            const promotionAction = this.allActions[action.code];
+            await promotionAction.onDeactivate(ctx, order, action.args, this);
+        }
+    }
+    isShippingAction(value) {
+        return value instanceof promotion_action_1.PromotionShippingAction;
+    }
+    isOrderArg(value) {
+        return !this.isOrderItemArg(value) && !this.isShippingArg(value);
+    }
+    isOrderItemArg(value) {
+        return value.hasOwnProperty("orderLine");
+    }
+    isShippingArg(value) {
+        return value.hasOwnProperty("shippingLine");
+    }
+};
+exports.Promotion = Promotion;
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true }),
+    __metadata("design:type", Object)
+], Promotion.prototype, "deletedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true }),
+    __metadata("design:type", Object)
+], Promotion.prototype, "startsAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true }),
+    __metadata("design:type", Object)
+], Promotion.prototype, "endsAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", String)
+], Promotion.prototype, "couponCode", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", Number)
+], Promotion.prototype, "perCustomerUsageLimit", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", Number)
+], Promotion.prototype, "usageLimit", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => promotion_translation_entity_1.PromotionTranslation, (translation) => translation.base, { eager: true }),
+    __metadata("design:type", Array)
+], Promotion.prototype, "translations", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Boolean)
+], Promotion.prototype, "enabled", void 0);
+__decorate([
+    (0, typeorm_1.ManyToMany)((type) => channel_entity_1.Channel, (channel) => channel.promotions),
+    (0, typeorm_1.JoinTable)(),
+    __metadata("design:type", Array)
+], Promotion.prototype, "channels", void 0);
+__decorate([
+    (0, typeorm_1.ManyToMany)((type) => order_entity_1.Order, (order) => order.promotions),
+    __metadata("design:type", Array)
+], Promotion.prototype, "orders", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomPromotionFields),
+    __metadata("design:type", custom_entity_fields_1.CustomPromotionFields)
+], Promotion.prototype, "customFields", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-json"),
+    __metadata("design:type", Array)
+], Promotion.prototype, "conditions", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-json"),
+    __metadata("design:type", Array)
+], Promotion.prototype, "actions", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], Promotion.prototype, "priorityScore", void 0);
+exports.Promotion = Promotion = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], Promotion);
+//# sourceMappingURL=promotion.entity.js.map

package/dist/entity/promotion/promotion.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promotion.entity.js","sourceRoot":"","sources":["../../../src/entity/promotion/promotion.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yEAI6C;AAE7C,qCAA2E;AAG3E,0DAAsD;AACtD,4EAAwE;AAOxE,gEAAwD;AAExD,8EAKiD;AAKjD,8DAAoD;AACpD,kEAAgE;AAChE,wDAA8C;AAI9C,iFAAsE;AAqBtE;;;;;;;;;GASG;AAEI,IAAM,SAAS,GAAf,MAAM,SACX,SAAQ,oCAAgB;IAYxB,YACE,KAGC;QAED,KAAK,CAAC,KAAK,CAAC,CAAC;QAff,SAAI,GAAG,gCAAc,CAAC,SAAS,CAAC;QACf,kBAAa,GAA2C,EAAE,CAAC;QAC3D,eAAU,GAKvB,EAAE,CAAC;QASL,MAAM,UAAU,GACd,CAAC,KAAK,IAAI,KAAK,CAAC,mBAAmB,CAAC;YACpC,IAAA,0BAAS,GAAE,CAAC,gBAAgB,CAAC,mBAAmB;YAChD,EAAE,CAAC;QACL,MAAM,OAAO,GACX,CAAC,KAAK,IAAI,KAAK,CAAC,gBAAgB,CAAC;YACjC,IAAA,0BAAS,GAAE,CAAC,gBAAgB,CAAC,gBAAgB;YAC7C,EAAE,CAAC;QACL,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,MAAM,CACpC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,iCAAM,IAAI,KAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAG,EACvC,EAAE,CACH,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAC9B,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,iCAAM,IAAI,KAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAG,EACvC,EAAE,CACH,CAAC;IACJ,CAAC;IAgED,KAAK,CAAC,KAAK,CACT,GAAmB,EACnB,IAG2B,EAC3B,KAAsB;QAEtB,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;QAEpB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACrD,IAAI,eAAe,YAAY,sCAAmB,EAAE,CAAC;gBACnD,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;oBAC3B,MAAM,IAAI,IAAA,wBAAU,EAClB,MAAM,eAAe,CAAC,OAAO,CAC3B,GAAG,EACH,SAAS,EACT,MAAM,CAAC,IAAI,EACX,KAAK,EACL,IAAI,CACL,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,IAAI,eAAe,YAAY,uCAAoB,EAAE,CAAC;gBAC3D,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC1B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;oBACvB,MAAM,IAAI,IAAA,wBAAU,EAClB,MAAM,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CACpE,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,IAAI,eAAe,YAAY,0CAAuB,EAAE,CAAC;gBAC9D,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC7B,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;oBACrC,MAAM,IAAI,IAAA,wBAAU,EAClB,MAAM,eAAe,CAAC,OAAO,CAC3B,GAAG,EACH,YAAY,EACZ,KAAK,EACL,MAAM,CAAC,IAAI,EACX,KAAK,EACL,IAAI,CACL,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;YACjB,OAAO;gBACL,MAAM;gBACN,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,WAAW,EAAE,IAAI,CAAC,IAAI;gBACtB,gBAAgB,EAAE,IAAI,CAAC,WAAW,EAAE;gBACpC,IAAI,EAAE,EAAE;aACT,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAmB,EAAE,KAAY;QAC1C,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;YAC5C,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;YAChD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,oBAAoB,KAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YACrE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,cAAc,GAAmB,EAAE,CAAC;QAC1C,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,0BAA0B,GAAG,MAAM,kBAAkB,CAAC,KAAK,CAC/D,GAAG,EACH,KAAK,EACL,SAAS,CAAC,IAAI,EACd,IAAI,CACL,CAAC;YACF,IAAI,CAAC,0BAA0B,EAAE,CAAC;gBAChC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,OAAO,0BAA0B,KAAK,QAAQ,EAAE,CAAC;gBACnD,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,0BAA0B,CAAC;YAC9D,CAAC;QACH,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAmB,EAAE,KAAY;QAC9C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACrD,MAAM,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAmB,EAAE,KAAY;QAChD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACrD,MAAM,eAAe,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAEO,gBAAgB,CACtB,KAA2E;QAE3E,OAAO,KAAK,YAAY,0CAAuB,CAAC;IAClD,CAAC;IAEO,UAAU,CAChB,KAG2B;QAE3B,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACnE,CAAC;IAEO,cAAc,CACpB,KAG2B;QAE3B,OAAO,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAEO,aAAa,CACnB,KAG2B;QAE3B,OAAO,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC;CACF,CAAA;AAjPY,8BAAS;AAuCpB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CAChB;AAGvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACjB;AAGtB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCACnB;AAGpB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACR;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACG;AAG9B;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACR;AAWnB;IALC,IAAA,mBAAS,EACR,CAAC,IAAI,EAAE,EAAE,CAAC,mDAAoB,EAC9B,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EACjC,EAAE,KAAK,EAAE,IAAI,EAAE,CAChB;8BACa,KAAK;+CAAyB;AAElC;IAAT,IAAA,gBAAM,GAAE;;0CAAkB;AAI3B;IAFC,IAAA,oBAAU,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC;IAC9D,IAAA,mBAAS,GAAE;;2CACQ;AAGpB;IADC,IAAA,oBAAU,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC;;yCACzC;AAGhB;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,4CAAqB,CAAC;8BAC1B,4CAAqB;+CAAC;AAEb;IAAtB,IAAA,gBAAM,EAAC,aAAa,CAAC;;6CAAqC;AAEpC;IAAtB,IAAA,gBAAM,EAAC,aAAa,CAAC;;0CAAkC;AAiB9C;IAAT,IAAA,gBAAM,GAAE;;gDAAuB;oBAlGrB,SAAS;IADrB,IAAA,gBAAM,GAAE;;GACI,SAAS,CAiPrB"}

package/dist/entity/refund/refund.entity.d.ts

@@ -0,0 +1,38 @@
+import { DeepPartial, ID } from "@deenruv/common/lib/shared-types";
+import { PaymentMetadata } from "../../common/types/common-types";
+import { RefundState } from "../../service/helpers/refund-state-machine/refund-state";
+import { DeenruvEntity } from "../base/base.entity";
+import { RefundLine } from "../order-line-reference/refund-line.entity";
+import { Payment } from "../payment/payment.entity";
+/**
+ * @description A refund the belongs to an order
+ *
+ * @docsCategory entities
+ */
+export declare class Refund extends DeenruvEntity {
+    constructor(input?: DeepPartial<Refund>);
+    /**
+     * @deprecated Since v2.2, the `items` field will not be used by default. Instead, the `total` field
+     * alone will be used to determine the refund amount.
+     */
+    items: number;
+    /**
+     * @deprecated Since v2.2, the `shipping` field will not be used by default. Instead, the `total` field
+     * alone will be used to determine the refund amount.
+     */
+    shipping: number;
+    /**
+     * @deprecated Since v2.2, the `adjustment` field will not be used by default. Instead, the `total` field
+     * alone will be used to determine the refund amount.
+     */
+    adjustment: number;
+    total: number;
+    method: string;
+    reason: string;
+    state: RefundState;
+    transactionId: string;
+    lines: RefundLine[];
+    payment: Payment;
+    paymentId: ID;
+    metadata: PaymentMetadata;
+}

package/dist/entity/refund/refund.entity.js

@@ -0,0 +1,85 @@
+"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.Refund = void 0;
+const typeorm_1 = require("typeorm");
+const base_entity_1 = require("../base/base.entity");
+const entity_id_decorator_1 = require("../entity-id.decorator");
+const money_decorator_1 = require("../money.decorator");
+const refund_line_entity_1 = require("../order-line-reference/refund-line.entity");
+const payment_entity_1 = require("../payment/payment.entity");
+/**
+ * @description A refund the belongs to an order
+ *
+ * @docsCategory entities
+ */
+let Refund = class Refund extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.Refund = Refund;
+__decorate([
+    (0, money_decorator_1.Money)(),
+    __metadata("design:type", Number)
+], Refund.prototype, "items", void 0);
+__decorate([
+    (0, money_decorator_1.Money)(),
+    __metadata("design:type", Number)
+], Refund.prototype, "shipping", void 0);
+__decorate([
+    (0, money_decorator_1.Money)(),
+    __metadata("design:type", Number)
+], Refund.prototype, "adjustment", void 0);
+__decorate([
+    (0, money_decorator_1.Money)(),
+    __metadata("design:type", Number)
+], Refund.prototype, "total", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], Refund.prototype, "method", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", String)
+], Refund.prototype, "reason", void 0);
+__decorate([
+    (0, typeorm_1.Column)("varchar"),
+    __metadata("design:type", String)
+], Refund.prototype, "state", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", String)
+], Refund.prototype, "transactionId", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => refund_line_entity_1.RefundLine, (line) => line.refund),
+    (0, typeorm_1.JoinTable)(),
+    __metadata("design:type", Array)
+], Refund.prototype, "lines", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => payment_entity_1.Payment, (payment) => payment.refunds),
+    (0, typeorm_1.JoinColumn)(),
+    __metadata("design:type", payment_entity_1.Payment)
+], Refund.prototype, "payment", void 0);
+__decorate([
+    (0, entity_id_decorator_1.EntityId)(),
+    __metadata("design:type", Object)
+], Refund.prototype, "paymentId", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-json"),
+    __metadata("design:type", Object)
+], Refund.prototype, "metadata", void 0);
+exports.Refund = Refund = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], Refund);
+//# sourceMappingURL=refund.entity.js.map

package/dist/entity/refund/refund.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refund.entity.js","sourceRoot":"","sources":["../../../src/entity/refund/refund.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAQiB;AAIjB,qDAAoD;AACpD,gEAAkD;AAClD,wDAA2C;AAC3C,mFAAwE;AACxE,8DAAoD;AAEpD;;;;GAIG;AAEI,IAAM,MAAM,GAAZ,MAAM,MAAO,SAAQ,2BAAa;IACvC,YAAY,KAA2B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CA2CF,CAAA;AA9CY,wBAAM;AASR;IAAR,IAAA,uBAAK,GAAE;;qCAAe;AAMd;IAAR,IAAA,uBAAK,GAAE;;wCAAkB;AAMjB;IAAR,IAAA,uBAAK,GAAE;;0CAAoB;AAEnB;IAAR,IAAA,uBAAK,GAAE;;qCAAe;AAEb;IAAT,IAAA,gBAAM,GAAE;;sCAAgB;AAEG;IAA3B,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sCAAgB;AAExB;IAAlB,IAAA,gBAAM,EAAC,SAAS,CAAC;;qCAAoB;AAEV;IAA3B,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CAAuB;AAIlD;IAFC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,+BAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;IACtD,IAAA,mBAAS,GAAE;;qCACQ;AAKpB;IAHC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;IAC1D,IAAA,oBAAU,GAAE;8BACJ,wBAAO;uCAAC;AAGjB;IADC,IAAA,8BAAQ,GAAE;;yCACG;AAES;IAAtB,IAAA,gBAAM,EAAC,aAAa,CAAC;;wCAA2B;iBA7CtC,MAAM;IADlB,IAAA,gBAAM,GAAE;;GACI,MAAM,CA8ClB"}

package/dist/entity/region/country.entity.d.ts

@@ -0,0 +1,14 @@
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { Region, RegionType } from "./region.entity";
+/**
+ * @description
+ * A country to which is available when creating / updating an {@link Address}. Countries are
+ * grouped together into {@link Zone}s which are in turn used to determine applicable shipping
+ * and taxes for an {@link Order}.
+ *
+ * @docsCategory entities
+ */
+export declare class Country extends Region {
+    constructor(input?: DeepPartial<Country>);
+    readonly type: RegionType;
+}

package/dist/entity/region/country.entity.js

@@ -0,0 +1,34 @@
+"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.Country = void 0;
+const typeorm_1 = require("typeorm");
+const region_entity_1 = require("./region.entity");
+/**
+ * @description
+ * A country to which is available when creating / updating an {@link Address}. Countries are
+ * grouped together into {@link Zone}s which are in turn used to determine applicable shipping
+ * and taxes for an {@link Order}.
+ *
+ * @docsCategory entities
+ */
+let Country = class Country extends region_entity_1.Region {
+    constructor(input) {
+        super(input);
+        this.type = "country";
+    }
+};
+exports.Country = Country;
+exports.Country = Country = __decorate([
+    (0, typeorm_1.ChildEntity)(),
+    __metadata("design:paramtypes", [Object])
+], Country);
+//# sourceMappingURL=country.entity.js.map

package/dist/entity/region/country.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"country.entity.js","sourceRoot":"","sources":["../../../src/entity/region/country.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAAsC;AAEtC,mDAAqD;AAErD;;;;;;;GAOG;AAEI,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,sBAAM;IACjC,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAGN,SAAI,GAAe,SAAS,CAAC;IAFtC,CAAC;CAGF,CAAA;AANY,0BAAO;kBAAP,OAAO;IADnB,IAAA,qBAAW,GAAE;;GACD,OAAO,CAMnB"}

package/dist/entity/region/province.entity.d.ts

@@ -0,0 +1,13 @@
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { Region, RegionType } from "./region.entity";
+/**
+ * @description
+ * A Province represents an administrative subdivision of a {@link Country}. For example, in the
+ * United States, the country would be "United States" and the province would be "California".
+ *
+ * @docsCategory entities
+ */
+export declare class Province extends Region {
+    constructor(input?: DeepPartial<Province>);
+    readonly type: RegionType;
+}

package/dist/entity/region/province.entity.js

@@ -0,0 +1,33 @@
+"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.Province = void 0;
+const typeorm_1 = require("typeorm");
+const region_entity_1 = require("./region.entity");
+/**
+ * @description
+ * A Province represents an administrative subdivision of a {@link Country}. For example, in the
+ * United States, the country would be "United States" and the province would be "California".
+ *
+ * @docsCategory entities
+ */
+let Province = class Province extends region_entity_1.Region {
+    constructor(input) {
+        super(input);
+        this.type = "province";
+    }
+};
+exports.Province = Province;
+exports.Province = Province = __decorate([
+    (0, typeorm_1.ChildEntity)(),
+    __metadata("design:paramtypes", [Object])
+], Province);
+//# sourceMappingURL=province.entity.js.map

package/dist/entity/region/province.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"province.entity.js","sourceRoot":"","sources":["../../../src/entity/region/province.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAAsC;AAEtC,mDAAqD;AAErD;;;;;;GAMG;AAEI,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,sBAAM;IAClC,YAAY,KAA6B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QAGN,SAAI,GAAe,UAAU,CAAC;IAFvC,CAAC;CAGF,CAAA;AANY,4BAAQ;mBAAR,QAAQ;IADpB,IAAA,qBAAW,GAAE;;GACD,QAAQ,CAMpB"}

package/dist/entity/region/region-translation.entity.d.ts

@@ -0,0 +1,14 @@
+import { LanguageCode } from "@deenruv/common/lib/generated-types";
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { Translation } from "../../common/types/locale-types";
+import { HasCustomFields } from "../../config/custom-field/custom-field-types";
+import { DeenruvEntity } from "../base/base.entity";
+import { CustomRegionFieldsTranslation } from "../custom-entity-fields";
+import { Region } from "./region.entity";
+export declare class RegionTranslation extends DeenruvEntity implements Translation<Region>, HasCustomFields {
+    constructor(input?: DeepPartial<Translation<RegionTranslation>>);
+    languageCode: LanguageCode;
+    name: string;
+    base: Region;
+    customFields: CustomRegionFieldsTranslation;
+}

package/dist/entity/region/region-translation.entity.js

@@ -0,0 +1,47 @@
+"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.RegionTranslation = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const typeorm_1 = require("typeorm");
+const base_entity_1 = require("../base/base.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const region_entity_1 = require("./region.entity");
+let RegionTranslation = class RegionTranslation extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.RegionTranslation = RegionTranslation;
+__decorate([
+    (0, typeorm_1.Column)("varchar"),
+    __metadata("design:type", String)
+], RegionTranslation.prototype, "languageCode", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], RegionTranslation.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => region_entity_1.Region, (base) => base.translations, {
+        onDelete: "CASCADE",
+    }),
+    __metadata("design:type", region_entity_1.Region)
+], RegionTranslation.prototype, "base", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomRegionFieldsTranslation),
+    __metadata("design:type", custom_entity_fields_1.CustomRegionFieldsTranslation)
+], RegionTranslation.prototype, "customFields", void 0);
+exports.RegionTranslation = RegionTranslation = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], RegionTranslation);
+//# sourceMappingURL=region-translation.entity.js.map

package/dist/entity/region/region-translation.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"region-translation.entity.js","sourceRoot":"","sources":["../../../src/entity/region/region-translation.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yEAAmE;AAEnE,qCAA2D;AAI3D,qDAAoD;AACpD,kEAAwE;AAExE,mDAAyC;AAGlC,IAAM,iBAAiB,GAAvB,MAAM,iBACX,SAAQ,2BAAa;IAGrB,YAAY,KAAmD;QAC7D,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CAcF,CAAA;AApBY,8CAAiB;AAQT;IAAlB,IAAA,gBAAM,EAAC,SAAS,CAAC;;uDAA4B;AAEpC;IAAT,IAAA,gBAAM,GAAE;;+CAAc;AAMvB;IAJC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,sBAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE;QACxD,QAAQ,EAAE,SAAS;KACpB,CAAC;8BACI,sBAAM;+CAAC;AAGb;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oDAA6B,CAAC;8BAClC,oDAA6B;uDAAC;4BAnBjC,iBAAiB;IAD7B,IAAA,gBAAM,GAAE;;GACI,iBAAiB,CAoB7B"}

package/dist/entity/region/region.entity.d.ts

@@ -0,0 +1,30 @@
+import { ID } from "@deenruv/common/lib/shared-types";
+import { LocaleString, Translatable, Translation } from "../../common/types/locale-types";
+import { HasCustomFields } from "../../config/custom-field/custom-field-types";
+import { DeenruvEntity } from "../base/base.entity";
+import { CustomRegionFields } from "../custom-entity-fields";
+export type RegionType = "country" | "province" | string;
+/**
+ * @description
+ * A Region represents a geographical administrative unit, such as a Country, Province, State, Prefecture etc.
+ * This is an abstract class which is extended by the {@link Country} and {@link Province} entities.
+ * Regions can be grouped into {@link Zone}s which are in turn used to determine applicable shipping and taxes for an {@link Order}.
+ *
+ * @docsCategory entities
+ */
+export declare abstract class Region extends DeenruvEntity implements Translatable, HasCustomFields {
+    /**
+     * @description
+     * A code representing the region. The code format will depend on the type of region. For
+     * example, a Country code will be a 2-letter ISO code, whereas a Province code could use
+     * a format relevant to the type of province, e.g. a US state code like "CA".
+     */
+    code: string;
+    readonly type: RegionType;
+    name: LocaleString;
+    parent?: Region;
+    parentId?: ID;
+    enabled: boolean;
+    translations: Array<Translation<Region>>;
+    customFields: CustomRegionFields;
+}

package/dist/entity/region/region.entity.js

@@ -0,0 +1,64 @@
+"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.Region = void 0;
+const typeorm_1 = require("typeorm");
+const base_entity_1 = require("../base/base.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const entity_id_decorator_1 = require("../entity-id.decorator");
+const region_translation_entity_1 = require("./region-translation.entity");
+/**
+ * @description
+ * A Region represents a geographical administrative unit, such as a Country, Province, State, Prefecture etc.
+ * This is an abstract class which is extended by the {@link Country} and {@link Province} entities.
+ * Regions can be grouped into {@link Zone}s which are in turn used to determine applicable shipping and taxes for an {@link Order}.
+ *
+ * @docsCategory entities
+ */
+let Region = class Region extends base_entity_1.DeenruvEntity {
+};
+exports.Region = Region;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], Region.prototype, "code", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false, type: "varchar" }),
+    __metadata("design:type", String)
+], Region.prototype, "type", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => Region, { nullable: true, onDelete: "SET NULL" }),
+    __metadata("design:type", Region)
+], Region.prototype, "parent", void 0);
+__decorate([
+    (0, entity_id_decorator_1.EntityId)({ nullable: true }),
+    __metadata("design:type", Object)
+], Region.prototype, "parentId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Boolean)
+], Region.prototype, "enabled", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => region_translation_entity_1.RegionTranslation, (translation) => translation.base, {
+        eager: true,
+    }),
+    __metadata("design:type", Array)
+], Region.prototype, "translations", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomRegionFields),
+    __metadata("design:type", custom_entity_fields_1.CustomRegionFields)
+], Region.prototype, "customFields", void 0);
+exports.Region = Region = __decorate([
+    (0, typeorm_1.Entity)(),
+    (0, typeorm_1.TableInheritance)({ column: { type: "varchar", name: "discriminator" } })
+], Region);
+//# sourceMappingURL=region.entity.js.map

package/dist/entity/region/region.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"region.entity.js","sourceRoot":"","sources":["../../../src/entity/region/region.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAQiB;AAQjB,qDAAoD;AACpD,kEAA6D;AAC7D,gEAAkD;AAElD,2EAAgE;AAIhE;;;;;;;GAOG;AAGI,IAAe,MAAM,GAArB,MAAe,MACpB,SAAQ,2BAAa;CAgCtB,CAAA;AAjCqB,wBAAM;AAUhB;IAAT,IAAA,gBAAM,GAAE;;oCAAc;AAGd;IADR,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;;oCACnB;AAM1B;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;8BAC7D,MAAM;sCAAC;AAGhB;IADC,IAAA,8BAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wCACf;AAEJ;IAAT,IAAA,gBAAM,GAAE;;uCAAkB;AAK3B;IAHC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,6CAAiB,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE;QACzE,KAAK,EAAE,IAAI;KACZ,CAAC;8BACY,KAAK;4CAAsB;AAGzC;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,yCAAkB,CAAC;8BACvB,yCAAkB;4CAAC;iBAhCb,MAAM;IAF3B,IAAA,gBAAM,GAAE;IACR,IAAA,0BAAgB,EAAC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,CAAC;GACnD,MAAM,CAiC3B"}

package/dist/entity/register-custom-entity-fields.d.ts

@@ -0,0 +1,6 @@
+import { DeenruvConfig } from "../config/deenruv-config";
+/**
+ * Dynamically registers any custom fields with TypeORM. This function should be run at the bootstrap
+ * stage of the app lifecycle, before the AppModule is initialized.
+ */
+export declare function registerCustomEntityFields(config: DeenruvConfig): void;