@deenruv/core 1.0.0

package/dist/entity/surcharge/surcharge.entity.js

@@ -0,0 +1,99 @@
+"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.Surcharge = void 0;
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const typeorm_1 = require("typeorm");
+const calculated_decorator_1 = require("../../common/calculated-decorator");
+const round_money_1 = require("../../common/round-money");
+const tax_utils_1 = require("../../common/tax-utils");
+const base_entity_1 = require("../base/base.entity");
+const money_decorator_1 = require("../money.decorator");
+const order_entity_1 = require("../order/order.entity");
+const order_modification_entity_1 = require("../order-modification/order-modification.entity");
+/**
+ * @description
+ * A Surcharge represents an arbitrary extra item on an {@link Order} which is not
+ * a ProductVariant. It can be used to e.g. represent payment-related surcharges.
+ *
+ * @docsCategory entities
+ */
+let Surcharge = class Surcharge extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+    get price() {
+        return (0, round_money_1.roundMoney)(this.listPriceIncludesTax
+            ? (0, tax_utils_1.netPriceOf)(this.listPrice, this.taxRate)
+            : this.listPrice);
+    }
+    get priceWithTax() {
+        return (0, round_money_1.roundMoney)(this.listPriceIncludesTax
+            ? this.listPrice
+            : (0, tax_utils_1.grossPriceOf)(this.listPrice, this.taxRate));
+    }
+    get taxRate() {
+        return (0, shared_utils_1.summate)(this.taxLines, "taxRate");
+    }
+};
+exports.Surcharge = Surcharge;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], Surcharge.prototype, "description", void 0);
+__decorate([
+    (0, money_decorator_1.Money)(),
+    __metadata("design:type", Number)
+], Surcharge.prototype, "listPrice", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Boolean)
+], Surcharge.prototype, "listPriceIncludesTax", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], Surcharge.prototype, "sku", void 0);
+__decorate([
+    (0, typeorm_1.Column)("simple-json"),
+    __metadata("design:type", Array)
+], Surcharge.prototype, "taxLines", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => order_entity_1.Order, (order) => order.surcharges, {
+        onDelete: "CASCADE",
+    }),
+    __metadata("design:type", order_entity_1.Order)
+], Surcharge.prototype, "order", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => order_modification_entity_1.OrderModification, (orderModification) => orderModification.surcharges),
+    __metadata("design:type", order_modification_entity_1.OrderModification)
+], Surcharge.prototype, "orderModification", void 0);
+__decorate([
+    (0, calculated_decorator_1.Calculated)(),
+    __metadata("design:type", Number),
+    __metadata("design:paramtypes", [])
+], Surcharge.prototype, "price", null);
+__decorate([
+    (0, calculated_decorator_1.Calculated)(),
+    __metadata("design:type", Number),
+    __metadata("design:paramtypes", [])
+], Surcharge.prototype, "priceWithTax", null);
+__decorate([
+    (0, calculated_decorator_1.Calculated)(),
+    __metadata("design:type", Number),
+    __metadata("design:paramtypes", [])
+], Surcharge.prototype, "taxRate", null);
+exports.Surcharge = Surcharge = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], Surcharge);
+//# sourceMappingURL=surcharge.entity.js.map

package/dist/entity/surcharge/surcharge.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"surcharge.entity.js","sourceRoot":"","sources":["../../../src/entity/surcharge/surcharge.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,mEAA2D;AAC3D,qCAA2D;AAE3D,4EAA+D;AAC/D,0DAAsD;AACtD,sDAAkE;AAClE,qDAAoD;AACpD,wDAA2C;AAC3C,wDAA8C;AAC9C,+FAAoF;AAEpF;;;;;;GAMG;AAEI,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,2BAAa;IAC1C,YAAY,KAA8B;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IA8BD,IACI,KAAK;QACP,OAAO,IAAA,wBAAU,EACf,IAAI,CAAC,oBAAoB;YACvB,CAAC,CAAC,IAAA,sBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC;YAC1C,CAAC,CAAC,IAAI,CAAC,SAAS,CACnB,CAAC;IACJ,CAAC;IAED,IACI,YAAY;QACd,OAAO,IAAA,wBAAU,EACf,IAAI,CAAC,oBAAoB;YACvB,CAAC,CAAC,IAAI,CAAC,SAAS;YAChB,CAAC,CAAC,IAAA,wBAAY,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAC/C,CAAC;IACJ,CAAC;IAED,IACI,OAAO;QACT,OAAO,IAAA,sBAAO,EAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;CACF,CAAA;AAvDY,8BAAS;AAMpB;IADC,IAAA,gBAAM,GAAE;;8CACW;AAGpB;IADC,IAAA,uBAAK,GAAE;;4CACU;AAGlB;IADC,IAAA,gBAAM,GAAE;;uDACqB;AAG9B;IADC,IAAA,gBAAM,GAAE;;sCACG;AAGZ;IADC,IAAA,gBAAM,EAAC,aAAa,CAAC;;2CACF;AAMpB;IAJC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE;QACvD,QAAQ,EAAE,SAAS;KACpB,CAAC;8BACK,oBAAK;wCAAC;AAOb;IALC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EACR,CAAC,IAAI,EAAE,EAAE,CAAC,6CAAiB,EAC3B,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,CACpD;8BACkB,6CAAiB;oDAAC;AAErC;IAAC,IAAA,iCAAU,GAAE;;;sCAOZ;AAED;IAAC,IAAA,iCAAU,GAAE;;;6CAOZ;AAED;IAAC,IAAA,iCAAU,GAAE;;;wCAGZ;oBAtDU,SAAS;IADrB,IAAA,gBAAM,GAAE;;GACI,SAAS,CAuDrB"}

package/dist/entity/tag/tag.entity.d.ts

@@ -0,0 +1,13 @@
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { DeenruvEntity } from "../base/base.entity";
+/**
+ * @description
+ * A tag is an arbitrary label which can be applied to certain entities.
+ * It is used to help organize and filter those entities.
+ *
+ * @docsCategory entities
+ */
+export declare class Tag extends DeenruvEntity {
+    constructor(input?: DeepPartial<Tag>);
+    value: string;
+}

package/dist/entity/tag/tag.entity.js

@@ -0,0 +1,36 @@
+"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.Tag = void 0;
+const typeorm_1 = require("typeorm");
+const base_entity_1 = require("../base/base.entity");
+/**
+ * @description
+ * A tag is an arbitrary label which can be applied to certain entities.
+ * It is used to help organize and filter those entities.
+ *
+ * @docsCategory entities
+ */
+let Tag = class Tag extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.Tag = Tag;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], Tag.prototype, "value", void 0);
+exports.Tag = Tag = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], Tag);
+//# sourceMappingURL=tag.entity.js.map

package/dist/entity/tag/tag.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag.entity.js","sourceRoot":"","sources":["../../../src/entity/tag/tag.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAAyC;AAEzC,qDAAoD;AAEpD;;;;;;GAMG;AAEI,IAAM,GAAG,GAAT,MAAM,GAAI,SAAQ,2BAAa;IACpC,YAAY,KAAwB;QAClC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CAIF,CAAA;AAPY,kBAAG;AAMd;IADC,IAAA,gBAAM,GAAE;;kCACK;cANH,GAAG;IADf,IAAA,gBAAM,GAAE;;GACI,GAAG,CAOf"}

package/dist/entity/tax-category/tax-category.entity.d.ts

@@ -0,0 +1,20 @@
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { TaxRate } from "..";
+import { HasCustomFields } from "../../config/custom-field/custom-field-types";
+import { DeenruvEntity } from "../base/base.entity";
+import { CustomTaxCategoryFields } from "../custom-entity-fields";
+import { ProductVariant } from "../product-variant/product-variant.entity";
+/**
+ * @description
+ * A TaxCategory defines what type of taxes to apply to a {@link ProductVariant}.
+ *
+ * @docsCategory entities
+ */
+export declare class TaxCategory extends DeenruvEntity implements HasCustomFields {
+    constructor(input?: DeepPartial<TaxCategory>);
+    name: string;
+    isDefault: boolean;
+    customFields: CustomTaxCategoryFields;
+    productVariants: ProductVariant[];
+    taxRates: TaxRate[];
+}

package/dist/entity/tax-category/tax-category.entity.js

@@ -0,0 +1,54 @@
+"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.TaxCategory = void 0;
+const typeorm_1 = require("typeorm");
+const __1 = require("..");
+const base_entity_1 = require("../base/base.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const product_variant_entity_1 = require("../product-variant/product-variant.entity");
+/**
+ * @description
+ * A TaxCategory defines what type of taxes to apply to a {@link ProductVariant}.
+ *
+ * @docsCategory entities
+ */
+let TaxCategory = class TaxCategory extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.TaxCategory = TaxCategory;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], TaxCategory.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: false }),
+    __metadata("design:type", Boolean)
+], TaxCategory.prototype, "isDefault", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomTaxCategoryFields),
+    __metadata("design:type", custom_entity_fields_1.CustomTaxCategoryFields)
+], TaxCategory.prototype, "customFields", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => product_variant_entity_1.ProductVariant, (productVariant) => productVariant.taxCategory),
+    __metadata("design:type", Array)
+], TaxCategory.prototype, "productVariants", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => __1.TaxRate, (taxRate) => taxRate.category),
+    __metadata("design:type", Array)
+], TaxCategory.prototype, "taxRates", void 0);
+exports.TaxCategory = TaxCategory = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], TaxCategory);
+//# sourceMappingURL=tax-category.entity.js.map

package/dist/entity/tax-category/tax-category.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-category.entity.js","sourceRoot":"","sources":["../../../src/entity/tax-category/tax-category.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAAoD;AAEpD,0BAA6B;AAE7B,qDAAoD;AACpD,kEAAkE;AAClE,sFAA2E;AAE3E;;;;;GAKG;AAEI,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,2BAAa;IAC5C,YAAY,KAAgC;QAC1C,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CAiBF,CAAA;AApBY,kCAAW;AAKZ;IAAT,IAAA,gBAAM,GAAE;;yCAAc;AAEK;IAA3B,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;8CAAoB;AAG/C;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,8CAAuB,CAAC;8BAC5B,8CAAuB;iDAAC;AAMtC;IAJC,IAAA,mBAAS,EACR,CAAC,IAAI,EAAE,EAAE,CAAC,uCAAc,EACxB,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,CAC/C;;oDACiC;AAGlC;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;;6CACxC;sBAnBT,WAAW;IADvB,IAAA,gBAAM,GAAE;;GACI,WAAW,CAoBvB"}

package/dist/entity/tax-rate/tax-rate.entity.d.ts

@@ -0,0 +1,46 @@
+import { TaxLine } from "@deenruv/common/lib/generated-types";
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { HasCustomFields } from "../../config/custom-field/custom-field-types";
+import { DeenruvEntity } from "../base/base.entity";
+import { CustomTaxRateFields } from "../custom-entity-fields";
+import { CustomerGroup } from "../customer-group/customer-group.entity";
+import { TaxCategory } from "../tax-category/tax-category.entity";
+import { Zone } from "../zone/zone.entity";
+/**
+ * @description
+ * A TaxRate defines the rate of tax to apply to a {@link ProductVariant} based on three factors:
+ *
+ * 1. the ProductVariant's {@link TaxCategory}
+ * 2. the applicable {@link Zone} ("applicable" being defined by the configured {@link TaxZoneStrategy})
+ * 3. the {@link CustomerGroup} of the current Customer
+ *
+ * @docsCategory entities
+ */
+export declare class TaxRate extends DeenruvEntity implements HasCustomFields {
+    constructor(input?: DeepPartial<TaxRate>);
+    name: string;
+    enabled: boolean;
+    value: number;
+    category: TaxCategory;
+    zone: Zone;
+    customerGroup?: CustomerGroup;
+    customFields: CustomTaxRateFields;
+    /**
+     * Returns the tax component of a given gross price.
+     */
+    taxComponentOf(grossPrice: number): number;
+    /**
+     * Given a gross (tax-inclusive) price, returns the net price.
+     */
+    netPriceOf(grossPrice: number): number;
+    /**
+     * Returns the tax applicable to the given net price.
+     */
+    taxPayableOn(netPrice: number): number;
+    /**
+     * Given a net price, return the gross price (net + tax)
+     */
+    grossPriceOf(netPrice: number): number;
+    apply(price: number): TaxLine;
+    test(zone: Zone, taxCategory: TaxCategory): boolean;
+}

package/dist/entity/tax-rate/tax-rate.entity.js

@@ -0,0 +1,112 @@
+"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.TaxRate = void 0;
+const typeorm_1 = require("typeorm");
+const tax_utils_1 = require("../../common/tax-utils");
+const utils_1 = require("../../common/utils");
+const base_entity_1 = require("../base/base.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const customer_group_entity_1 = require("../customer-group/customer-group.entity");
+const tax_category_entity_1 = require("../tax-category/tax-category.entity");
+const value_transformers_1 = require("../value-transformers");
+const zone_entity_1 = require("../zone/zone.entity");
+/**
+ * @description
+ * A TaxRate defines the rate of tax to apply to a {@link ProductVariant} based on three factors:
+ *
+ * 1. the ProductVariant's {@link TaxCategory}
+ * 2. the applicable {@link Zone} ("applicable" being defined by the configured {@link TaxZoneStrategy})
+ * 3. the {@link CustomerGroup} of the current Customer
+ *
+ * @docsCategory entities
+ */
+let TaxRate = class TaxRate extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+    /**
+     * Returns the tax component of a given gross price.
+     */
+    taxComponentOf(grossPrice) {
+        return (0, tax_utils_1.taxComponentOf)(grossPrice, this.value);
+    }
+    /**
+     * Given a gross (tax-inclusive) price, returns the net price.
+     */
+    netPriceOf(grossPrice) {
+        return (0, tax_utils_1.netPriceOf)(grossPrice, this.value);
+    }
+    /**
+     * Returns the tax applicable to the given net price.
+     */
+    taxPayableOn(netPrice) {
+        return (0, tax_utils_1.taxPayableOn)(netPrice, this.value);
+    }
+    /**
+     * Given a net price, return the gross price (net + tax)
+     */
+    grossPriceOf(netPrice) {
+        return (0, tax_utils_1.grossPriceOf)(netPrice, this.value);
+    }
+    apply(price) {
+        return {
+            description: this.name,
+            taxRate: this.value,
+        };
+    }
+    test(zone, taxCategory) {
+        return ((0, utils_1.idsAreEqual)(taxCategory.id, this.category.id) &&
+            (0, utils_1.idsAreEqual)(zone.id, this.zone.id));
+    }
+};
+exports.TaxRate = TaxRate;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], TaxRate.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Boolean)
+], TaxRate.prototype, "enabled", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: "decimal",
+        precision: 5,
+        scale: 2,
+        transformer: new value_transformers_1.DecimalTransformer(),
+    }),
+    __metadata("design:type", Number)
+], TaxRate.prototype, "value", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => tax_category_entity_1.TaxCategory, (taxCategory) => taxCategory.taxRates),
+    __metadata("design:type", tax_category_entity_1.TaxCategory)
+], TaxRate.prototype, "category", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => zone_entity_1.Zone, (zone) => zone.taxRates),
+    __metadata("design:type", zone_entity_1.Zone)
+], TaxRate.prototype, "zone", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.ManyToOne)((type) => customer_group_entity_1.CustomerGroup, (customerGroup) => customerGroup.taxRates, { nullable: true }),
+    __metadata("design:type", customer_group_entity_1.CustomerGroup)
+], TaxRate.prototype, "customerGroup", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomTaxRateFields),
+    __metadata("design:type", custom_entity_fields_1.CustomTaxRateFields)
+], TaxRate.prototype, "customFields", void 0);
+exports.TaxRate = TaxRate = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], TaxRate);
+//# sourceMappingURL=tax-rate.entity.js.map

package/dist/entity/tax-rate/tax-rate.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-rate.entity.js","sourceRoot":"","sources":["../../../src/entity/tax-rate/tax-rate.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,qCAA2D;AAE3D,sDAKgC;AAChC,8CAAiD;AAEjD,qDAAoD;AACpD,kEAA8D;AAC9D,mFAAwE;AACxE,6EAAkE;AAClE,8DAA2D;AAC3D,qDAA2C;AAE3C;;;;;;;;;GASG;AAEI,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,2BAAa;IACxC,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAiCD;;OAEG;IACH,cAAc,CAAC,UAAkB;QAC/B,OAAO,IAAA,0BAAc,EAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,UAAkB;QAC3B,OAAO,IAAA,sBAAU,EAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,QAAgB;QAC3B,OAAO,IAAA,wBAAY,EAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,QAAgB;QAC3B,OAAO,IAAA,wBAAY,EAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,KAAa;QACjB,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,IAAI;YACtB,OAAO,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAU,EAAE,WAAwB;QACvC,OAAO,CACL,IAAA,mBAAW,EAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7C,IAAA,mBAAW,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CACnC,CAAC;IACJ,CAAC;CACF,CAAA;AA7EY,0BAAO;AAKR;IAAT,IAAA,gBAAM,GAAE;;qCAAc;AAEb;IAAT,IAAA,gBAAM,GAAE;;wCAAkB;AAQ3B;IANC,IAAA,gBAAM,EAAC;QACN,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI,uCAAkB,EAAE;KACtC,CAAC;;sCACY;AAId;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCAAW,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC;8BAC9D,iCAAW;yCAAC;AAItB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC;8BAC7C,kBAAI;qCAAC;AAQX;IANC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EACR,CAAC,IAAI,EAAE,EAAE,CAAC,qCAAa,EACvB,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EACzC,EAAE,QAAQ,EAAE,IAAI,EAAE,CACnB;8BACe,qCAAa;8CAAC;AAG9B;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,0CAAmB,CAAC;8BACxB,0CAAmB;6CAAC;kBAlCvB,OAAO;IADnB,IAAA,gBAAM,GAAE;;GACI,OAAO,CA6EnB"}

package/dist/entity/user/user.entity.d.ts

@@ -0,0 +1,29 @@
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { SoftDeletable } from "../../common/types/common-types";
+import { HasCustomFields } from "../../config/custom-field/custom-field-types";
+import { AuthenticationMethod } from "../authentication-method/authentication-method.entity";
+import { NativeAuthenticationMethod } from "../authentication-method/native-authentication-method.entity";
+import { DeenruvEntity } from "../base/base.entity";
+import { CustomUserFields } from "../custom-entity-fields";
+import { Role } from "../role/role.entity";
+import { AuthenticatedSession } from "../session/authenticated-session.entity";
+/**
+ * @description
+ * A User represents any authenticated user of the Deenruv API. This includes both
+ * {@link Administrator}s as well as registered {@link Customer}s.
+ *
+ * @docsCategory entities
+ */
+export declare class User extends DeenruvEntity implements HasCustomFields, SoftDeletable {
+    constructor(input?: DeepPartial<User>);
+    deletedAt: Date | null;
+    identifier: string;
+    authenticationMethods: AuthenticationMethod[];
+    verified: boolean;
+    roles: Role[];
+    lastLogin: Date | null;
+    customFields: CustomUserFields;
+    sessions: AuthenticatedSession[];
+    getNativeAuthenticationMethod(): NativeAuthenticationMethod;
+    getNativeAuthenticationMethod(strict?: boolean): NativeAuthenticationMethod | undefined;
+}

package/dist/entity/user/user.entity.js

@@ -0,0 +1,81 @@
+"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.User = void 0;
+const typeorm_1 = require("typeorm");
+const errors_1 = require("../../common/error/errors");
+const authentication_method_entity_1 = require("../authentication-method/authentication-method.entity");
+const native_authentication_method_entity_1 = require("../authentication-method/native-authentication-method.entity");
+const base_entity_1 = require("../base/base.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const role_entity_1 = require("../role/role.entity");
+const authenticated_session_entity_1 = require("../session/authenticated-session.entity");
+/**
+ * @description
+ * A User represents any authenticated user of the Deenruv API. This includes both
+ * {@link Administrator}s as well as registered {@link Customer}s.
+ *
+ * @docsCategory entities
+ */
+let User = class User extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+    getNativeAuthenticationMethod(strict) {
+        if (!this.authenticationMethods) {
+            throw new errors_1.InternalServerError("error.user-authentication-methods-not-loaded");
+        }
+        const match = this.authenticationMethods.find((m) => m instanceof native_authentication_method_entity_1.NativeAuthenticationMethod);
+        if (!match && (strict === undefined || strict)) {
+            throw new errors_1.InternalServerError("error.native-authentication-methods-not-found");
+        }
+        return match;
+    }
+};
+exports.User = User;
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true }),
+    __metadata("design:type", Object)
+], User.prototype, "deletedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], User.prototype, "identifier", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => authentication_method_entity_1.AuthenticationMethod, (method) => method.user),
+    __metadata("design:type", Array)
+], User.prototype, "authenticationMethods", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: false }),
+    __metadata("design:type", Boolean)
+], User.prototype, "verified", void 0);
+__decorate([
+    (0, typeorm_1.ManyToMany)((type) => role_entity_1.Role),
+    (0, typeorm_1.JoinTable)(),
+    __metadata("design:type", Array)
+], User.prototype, "roles", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true }),
+    __metadata("design:type", Object)
+], User.prototype, "lastLogin", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomUserFields),
+    __metadata("design:type", custom_entity_fields_1.CustomUserFields)
+], User.prototype, "customFields", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => authenticated_session_entity_1.AuthenticatedSession, (session) => session.user),
+    __metadata("design:type", Array)
+], User.prototype, "sessions", void 0);
+exports.User = User = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], User);
+//# sourceMappingURL=user.entity.js.map

package/dist/entity/user/user.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.entity.js","sourceRoot":"","sources":["../../../src/entity/user/user.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAA2E;AAE3E,sDAAgE;AAGhE,wGAA6F;AAC7F,sHAA0G;AAC1G,qDAAoD;AACpD,kEAA2D;AAC3D,qDAA2C;AAC3C,0FAA+E;AAE/E;;;;;;GAMG;AAEI,IAAM,IAAI,GAAV,MAAM,IACX,SAAQ,2BAAa;IAGrB,YAAY,KAAyB;QACnC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAgCD,6BAA6B,CAC3B,MAAgB;QAEhB,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,MAAM,IAAI,4BAAmB,CAC3B,8CAA8C,CAC/C,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAC3C,CAAC,CAAC,EAAmC,EAAE,CACrC,CAAC,YAAY,gEAA0B,CAC1C,CAAC;QACF,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,4BAAmB,CAC3B,+CAA+C,CAChD,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAA;AAzDY,oBAAI;AASf;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCAChB;AAGvB;IADC,IAAA,gBAAM,GAAE;;wCACU;AAGnB;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mDAAoB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;;mDACrB;AAG9C;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;sCACT;AAIlB;IAFC,IAAA,oBAAU,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAI,CAAC;IAC1B,IAAA,mBAAS,GAAE;;mCACE;AAGd;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCAChB;AAGvB;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uCAAgB,CAAC;8BACrB,uCAAgB;0CAAC;AAG/B;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mDAAoB,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;;sCACpC;eA/BtB,IAAI;IADhB,IAAA,gBAAM,GAAE;;GACI,IAAI,CAyDhB"}

package/dist/entity/validate-custom-fields-config.d.ts

@@ -0,0 +1,10 @@
+import { Type } from "@deenruv/common/lib/shared-types";
+import { CustomFields } from "../config/custom-field/custom-field-types";
+/**
+ * Validates the custom fields config, e.g. by ensuring that there are no naming conflicts with the built-in fields
+ * of each entity.
+ */
+export declare function validateCustomFieldsConfig(customFieldConfig: CustomFields, entities: Array<Type<any>>): {
+    valid: boolean;
+    errors: string[];
+};