@stamhoofd/structures 1.12.8 → 2.1.1

package/esm/dist/src/billing/STInvoice.js

@@ -0,0 +1,362 @@
+import { __decorate } from "tslib";
+import { ArrayDecoder, AutoEncoder, BooleanDecoder, DateDecoder, field, IntegerDecoder, StringDecoder } from "@simonbackx/simple-encoding";
+import { Formatter, StringCompare } from "@stamhoofd/utility";
+import { v4 as uuidv4 } from "uuid";
+import { Address } from "../addresses/Address";
+import { File } from "../files/File";
+import { Payment, Settlement } from "../members/Payment";
+import { OrganizationSimple } from "../OrganizationSimple";
+import { STPackage, STPricingType } from "./STPackage";
+export var STInvoiceStatus;
+(function (STInvoiceStatus) {
+    STInvoiceStatus["Created"] = "Created";
+    STInvoiceStatus["Prepared"] = "Prepared";
+    STInvoiceStatus["Completed"] = "Completed";
+    STInvoiceStatus["Canceled"] = "Canceled";
+})(STInvoiceStatus || (STInvoiceStatus = {}));
+export class STInvoiceItem extends AutoEncoder {
+    constructor() {
+        super(...arguments);
+        this.name = "";
+        this.description = "";
+        this.amount = 1;
+        this.unitPrice = 0;
+        this.canUseCredits = true;
+    }
+    get price() {
+        return this.unitPrice * this.amount;
+    }
+    /**
+     * Convertable into STInvoiceItem (or the diffence if amount is increased)
+     * Use this to calculate prices or create an invoice
+     * This will calculate the price to expand the package to the given amount.
+     * If you want to renew a package, you need to create a new package first
+     */
+    static fromPackage(pack, amount = 1, pendingAmount = 0, date) {
+        let unitPrice = Math.round(pack.meta.unitPrice);
+        if (amount < pack.meta.minimumAmount) {
+            // Minimum should get applied first, because we might already have paid for the minimum (paid amount)
+            amount = pack.meta.minimumAmount;
+        }
+        amount -= pendingAmount;
+        amount -= pack.meta.paidAmount;
+        if (amount <= 0) {
+            amount = 0;
+        }
+        /// When pricing type is memebrs, the price is calculated per year.
+        /// If a shorter period is remaining, we give a discount in order
+        /// to no need to handle it more complicated
+        let now = date !== null && date !== void 0 ? date : new Date();
+        if (now < pack.meta.startDate) {
+            // When creating a new package, we sometimes buy it for the future, so use that date instead of now
+            now = pack.meta.startDate;
+        }
+        if (pack.validUntil && pack.meta.pricingType !== STPricingType.Fixed) {
+            const totalDays = Math.round((pack.validUntil.getTime() - pack.meta.startDate.getTime()) / (1000 * 60 * 60 * 24));
+            let remainingDays = Math.round((pack.validUntil.getTime() - now.getTime()) / (1000 * 60 * 60 * 24));
+            /// First 3 months are full price
+            const paidDays = 30 * 3;
+            if (remainingDays > totalDays) {
+                remainingDays = totalDays;
+            }
+            if (totalDays > 366) {
+                // Increase unit price
+                unitPrice = unitPrice * (totalDays / 365);
+            }
+            if (pack.meta.pricingType === STPricingType.PerMember) {
+                unitPrice = Math.round(Math.min(unitPrice, unitPrice * remainingDays / (Math.max(365, totalDays) - paidDays)));
+            }
+            else {
+                unitPrice = Math.round(unitPrice);
+            }
+        }
+        const item = STInvoiceItem.create({
+            name: pack.meta.name,
+            description: pack.validUntil ? ("Van " + Formatter.date(now, true) + " tot " + Formatter.date(pack.validUntil, true)) : ("Vanaf " + Formatter.date(pack.meta.startDate, true)),
+            package: pack,
+            date: now,
+            unitPrice: unitPrice,
+            amount: amount
+        });
+        return item;
+    }
+    canMerge(other) {
+        // Mergeable if both don't have a packege, or both have the same package
+        if (other.package && !this.package) {
+            return false;
+        }
+        if (!other.package && this.package) {
+            return false;
+        }
+        if (other.package && this.package && other.package.id !== this.package.id) {
+            return false;
+        }
+        if (this.name === other.name) {
+            if (this.unitPrice === other.unitPrice && this.description === other.description) {
+                return true;
+            }
+        }
+        return false;
+    }
+    merge(other) {
+        this.amount += other.amount;
+        // Other package will be more up to date
+        this.package = other.package;
+    }
+    /// Only compress an invoice when it is marked as paid and for a pending invoice when it doesn't has an invoice
+    /// Else you'll lose the ID's!
+    static compress(items) {
+        const copy = items.slice();
+        for (let index = 0; index < copy.length; index++) {
+            // Create a copy to prevent changing the original one
+            const item = STInvoiceItem.create(copy[index]);
+            copy[index] = item;
+            // Loop further (in reverse order to be able to delete items)
+            for (let j = copy.length - 1; j > index; j--) {
+                const other = copy[j];
+                if (item.canMerge(other)) {
+                    // Delete other
+                    item.merge(other);
+                    copy.splice(j, 1);
+                }
+            }
+        }
+        return copy;
+    }
+}
+__decorate([
+    field({ decoder: StringDecoder, defaultValue: () => uuidv4() })
+], STInvoiceItem.prototype, "id", void 0);
+__decorate([
+    field({ decoder: StringDecoder })
+], STInvoiceItem.prototype, "name", void 0);
+__decorate([
+    field({ decoder: StringDecoder })
+], STInvoiceItem.prototype, "description", void 0);
+__decorate([
+    field({ decoder: IntegerDecoder })
+], STInvoiceItem.prototype, "amount", void 0);
+__decorate([
+    field({ decoder: IntegerDecoder })
+], STInvoiceItem.prototype, "unitPrice", void 0);
+__decorate([
+    field({ decoder: BooleanDecoder, version: 155 })
+], STInvoiceItem.prototype, "canUseCredits", void 0);
+__decorate([
+    field({ decoder: STPackage, optional: true })
+], STInvoiceItem.prototype, "package", void 0);
+__decorate([
+    field({ decoder: DateDecoder, optional: true })
+], STInvoiceItem.prototype, "date", void 0);
+export class STInvoiceMeta extends AutoEncoder {
+    constructor() {
+        super(...arguments);
+        /**
+         * VATPercentage should be zero in countries outside Belgium in EU
+         */
+        this.VATPercentage = 21;
+        this.items = [];
+        /**
+         * Sometimes we need to calculate an invoice in reverse when we have a fixed price including VAT,
+         * but need to calculatle the price excluding VAT.
+         */
+        this.areItemsIncludingVAT = false;
+        this.companyVATNumber = null;
+        this.companyNumber = null;
+        this.ipAddress = null;
+        this.userAgent = null;
+        this.stripeAccountId = null;
+    }
+    /**
+     * Depending on areItemsIncludingVAT, this can either be including or excluding VAT
+     */
+    get itemPrice() {
+        return this.items.reduce((price, item) => price + item.price, 0);
+    }
+    includingVATToExcludingVAT(price) {
+        // Always only round the VAT, not other prices
+        return price - this.getVATOnIncludingVATAmount(price);
+    }
+    excludingVATToIncludingVAT(price) {
+        // Always only round the VAT, not other prices
+        return price + this.getVATOnExcludingVATAmount(price);
+    }
+    getVATOnIncludingVATAmount(price) {
+        return Math.round(price * this.VATPercentage / (100 + this.VATPercentage));
+    }
+    getVATOnExcludingVATAmount(price) {
+        return Math.round(this.itemPrice * this.VATPercentage / 100);
+    }
+    get priceWithoutVAT() {
+        const itemPrice = this.itemPrice;
+        if (this.areItemsIncludingVAT) {
+            return itemPrice - this.VAT;
+        }
+        return itemPrice;
+    }
+    get VAT() {
+        if (this.areItemsIncludingVAT) {
+            // Subtract VAT and round
+            return this.getVATOnIncludingVATAmount(this.itemPrice);
+        }
+        return this.getVATOnExcludingVATAmount(this.itemPrice);
+    }
+    get priceWithVAT() {
+        const itemPrice = this.itemPrice;
+        if (this.areItemsIncludingVAT) {
+            return itemPrice;
+        }
+        return itemPrice + this.VAT;
+    }
+}
+__decorate([
+    field({ decoder: DateDecoder, optional: true })
+], STInvoiceMeta.prototype, "date", void 0);
+__decorate([
+    field({ decoder: File, optional: true })
+], STInvoiceMeta.prototype, "pdf", void 0);
+__decorate([
+    field({ decoder: IntegerDecoder })
+], STInvoiceMeta.prototype, "VATPercentage", void 0);
+__decorate([
+    field({ decoder: new ArrayDecoder(STInvoiceItem) })
+], STInvoiceMeta.prototype, "items", void 0);
+__decorate([
+    field({ decoder: BooleanDecoder, version: 186 })
+], STInvoiceMeta.prototype, "areItemsIncludingVAT", void 0);
+__decorate([
+    field({ decoder: StringDecoder })
+], STInvoiceMeta.prototype, "companyName", void 0);
+__decorate([
+    field({ decoder: StringDecoder })
+], STInvoiceMeta.prototype, "companyContact", void 0);
+__decorate([
+    field({ decoder: Address })
+], STInvoiceMeta.prototype, "companyAddress", void 0);
+__decorate([
+    field({ decoder: StringDecoder, nullable: true })
+], STInvoiceMeta.prototype, "companyVATNumber", void 0);
+__decorate([
+    field({ decoder: StringDecoder, nullable: true, optional: true })
+], STInvoiceMeta.prototype, "companyNumber", void 0);
+__decorate([
+    field({ decoder: StringDecoder, nullable: true, version: 133 })
+], STInvoiceMeta.prototype, "ipAddress", void 0);
+__decorate([
+    field({ decoder: StringDecoder, nullable: true, version: 133 })
+], STInvoiceMeta.prototype, "userAgent", void 0);
+__decorate([
+    field({ decoder: StringDecoder, nullable: true, version: 210 })
+], STInvoiceMeta.prototype, "stripeAccountId", void 0);
+export class STInvoice extends AutoEncoder {
+    constructor() {
+        super(...arguments);
+        this.payment = null;
+        /**
+         * If the number is null, no invoice is generated yet. Its still a WIP invoice (not an official one!)
+         */
+        this.number = null;
+        this.createdAt = null;
+        this.updatedAt = null;
+        this.paidAt = null;
+    }
+}
+__decorate([
+    field({ decoder: StringDecoder, defaultValue: () => uuidv4() })
+], STInvoice.prototype, "id", void 0);
+__decorate([
+    field({ decoder: Payment, nullable: true })
+], STInvoice.prototype, "payment", void 0);
+__decorate([
+    field({ decoder: STInvoiceMeta })
+], STInvoice.prototype, "meta", void 0);
+__decorate([
+    field({ decoder: IntegerDecoder, nullable: true })
+], STInvoice.prototype, "number", void 0);
+__decorate([
+    field({ decoder: DateDecoder, nullable: true })
+], STInvoice.prototype, "createdAt", void 0);
+__decorate([
+    field({ decoder: DateDecoder, nullable: true })
+], STInvoice.prototype, "updatedAt", void 0);
+__decorate([
+    field({ decoder: DateDecoder, nullable: true })
+], STInvoice.prototype, "paidAt", void 0);
+export class STInvoicePrivate extends STInvoice {
+    constructor() {
+        super(...arguments);
+        this.settlement = null;
+        this.reference = null;
+    }
+    matchQuery(query) {
+        var _a;
+        if (query === ((_a = this.number) === null || _a === void 0 ? void 0 : _a.toString()) || query === this.id) {
+            return true;
+        }
+        if (StringCompare.typoCount(this.meta.companyName, query) < 2 ||
+            StringCompare.typoCount(this.meta.companyAddress.city, query) < 2 ||
+            StringCompare.typoCount(this.meta.companyContact, query) < 2 ||
+            (this.meta.companyVATNumber && StringCompare.typoCount(this.meta.companyVATNumber, query) < 2) ||
+            StringCompare.typoCount(this.meta.companyAddress.street, query) < 2) {
+            return true;
+        }
+        if (!this.organization) {
+            return false;
+        }
+        if (StringCompare.typoCount(this.organization.name, query) < 2 ||
+            StringCompare.typoCount(this.organization.address.city, query) < 2 ||
+            StringCompare.typoCount(this.organization.address.street, query) < 2 ||
+            StringCompare.typoCount(this.meta.companyName, query) < 2 ||
+            StringCompare.typoCount(this.meta.companyName, query) < 2) {
+            return true;
+        }
+        return false;
+    }
+}
+__decorate([
+    field({ decoder: OrganizationSimple, optional: true })
+], STInvoicePrivate.prototype, "organization", void 0);
+__decorate([
+    field({ decoder: Settlement, nullable: true })
+], STInvoicePrivate.prototype, "settlement", void 0);
+__decorate([
+    field({ decoder: StringDecoder, nullable: true, version: 186 })
+], STInvoicePrivate.prototype, "reference", void 0);
+export class STPendingInvoice extends AutoEncoder {
+    constructor() {
+        super(...arguments);
+        this.id = null;
+        this.invoice = null;
+        this.createdAt = null;
+        this.updatedAt = null;
+    }
+}
+__decorate([
+    field({ decoder: StringDecoder, nullable: true, optional: true })
+], STPendingInvoice.prototype, "id", void 0);
+__decorate([
+    field({ decoder: STInvoiceMeta })
+], STPendingInvoice.prototype, "meta", void 0);
+__decorate([
+    field({ decoder: STInvoice, nullable: true })
+], STPendingInvoice.prototype, "invoice", void 0);
+__decorate([
+    field({ decoder: DateDecoder, nullable: true })
+], STPendingInvoice.prototype, "createdAt", void 0);
+__decorate([
+    field({ decoder: DateDecoder, nullable: true })
+], STPendingInvoice.prototype, "updatedAt", void 0);
+export class STPendingInvoicePrivate extends STPendingInvoice {
+}
+__decorate([
+    field({ decoder: OrganizationSimple, optional: true })
+], STPendingInvoicePrivate.prototype, "organization", void 0);
+export class STInvoiceResponse extends AutoEncoder {
+}
+__decorate([
+    field({ decoder: StringDecoder, optional: true })
+], STInvoiceResponse.prototype, "paymentUrl", void 0);
+__decorate([
+    field({ decoder: STInvoice, optional: true })
+], STInvoiceResponse.prototype, "invoice", void 0);
+//# sourceMappingURL=STInvoice.js.map

package/esm/dist/src/billing/STInvoice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"STInvoice.js","sourceRoot":"","sources":["../../../../src/billing/STInvoice.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC3I,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAuB,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5E,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,sCAAmB,CAAA;IACnB,wCAAqB,CAAA;IACrB,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;AACzB,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B;AAED,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QAKI,SAAI,GAAG,EAAE,CAAA;QAGT,gBAAW,GAAG,EAAE,CAAA;QAGhB,WAAM,GAAG,CAAC,CAAA;QAGV,cAAS,GAAG,CAAC,CAAA;QAGb,kBAAa,GAAG,IAAI,CAAA;IAkIxB,CAAC;IAhIG,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAA;IACvC,CAAC;IAcD;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,IAAe,EAAE,MAAM,GAAG,CAAC,EAAE,aAAa,GAAG,CAAC,EAAG,IAAW;QAC3E,IAAI,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAE/C,IAAI,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACnC,qGAAqG;YACrG,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAA;QACpC,CAAC;QAED,MAAM,IAAI,aAAa,CAAA;QACvB,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAA;QAC9B,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;YACd,MAAM,GAAG,CAAC,CAAA;QACd,CAAC;QAED,mEAAmE;QACnE,iEAAiE;QACjE,4CAA4C;QAC5C,IAAI,GAAG,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,IAAI,EAAE,CAAA;QAC5B,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAC5B,mGAAmG;YACnG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAA;QAC7B,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,KAAK,aAAa,CAAC,KAAK,EAAE,CAAC;YACnE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACjH,IAAI,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YAEnG,iCAAiC;YACjC,MAAM,QAAQ,GAAG,EAAE,GAAC,CAAC,CAAA;YAErB,IAAI,aAAa,GAAG,SAAS,EAAE,CAAC;gBAC5B,aAAa,GAAG,SAAS,CAAA;YAC7B,CAAC;YAED,IAAI,SAAS,GAAG,GAAG,EAAE,CAAC;gBAClB,sBAAsB;gBACtB,SAAS,GAAG,SAAS,GAAG,CAAC,SAAS,GAAC,GAAG,CAAC,CAAA;YAC3C,CAAC;YAED,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,KAAK,aAAa,CAAC,SAAS,EAAE,CAAC;gBACpD,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;YAClH,CAAC;iBAAM,CAAC;gBACJ,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;YACrC,CAAC;QACL,CAAC;QAED,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC;YAC9B,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,GAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAC,OAAO,GAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,GAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACtK,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,GAAG;YACT,SAAS,EAAE,SAAS;YACpB,MAAM,EAAE,MAAM;SACjB,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,QAAQ,CAAC,KAAoB;QACzB,wEAAwE;QACxE,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,OAAO,KAAK,CAAA;QAChB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,OAAO,KAAK,CAAA;QAChB,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;YACxE,OAAO,KAAK,CAAA;QAChB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;gBAC/E,OAAO,IAAI,CAAA;YACf,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,KAAK,CAAC,KAAoB;QACtB,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAA;QAE3B,wCAAwC;QACxC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;IAChC,CAAC;IAED,+GAA+G;IAC/G,8BAA8B;IAC9B,MAAM,CAAC,QAAQ,CAAC,KAAsB;QAClC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,CAAA;QAE1B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;YAC/C,qDAAqD;YACrD,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/C,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YAElB,6DAA6D;YAC7D,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvB,eAAe;oBACf,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBACjB,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBACrB,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AAjJG;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC;yCACrD;AAGX;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;2CACzB;AAGT;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;kDAClB;AAGhB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;6CACzB;AAGV;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;gDACtB;AAGb;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;oDAC7B;AAUpB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8CAC3B;AAMnB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;2CACrC;AAoHf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QAaI;;WAEG;QAEH,kBAAa,GAAG,EAAE,CAAA;QAGlB,UAAK,GAAoB,EAAE,CAAA;QAE3B;;;WAGG;QAEH,yBAAoB,GAAG,KAAK,CAAA;QAa5B,qBAAgB,GAAkB,IAAI,CAAA;QAGtC,kBAAa,GAAkB,IAAI,CAAA;QAGnC,cAAS,GAAkB,IAAI,CAAA;QAG/B,cAAS,GAAkB,IAAI,CAAA;QAG/B,oBAAe,GAAkB,IAAI,CAAA;IAmDzC,CAAC;IAjDG;;OAEG;IACH,IAAY,SAAS;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IACpE,CAAC;IAED,0BAA0B,CAAC,KAAa;QACpC,8CAA8C;QAC9C,OAAO,KAAK,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAA;IACzD,CAAC;IAED,0BAA0B,CAAC,KAAa;QACpC,8CAA8C;QAC9C,OAAO,KAAK,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAA;IACzD,CAAC;IAED,0BAA0B,CAAC,KAAa;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAI,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAA;IAC/E,CAAC;IAED,0BAA0B,CAAC,KAAa;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,CAAA;IAChE,CAAC;IAED,IAAI,eAAe;QACf,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAChC,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,OAAO,SAAS,GAAG,IAAI,CAAC,GAAG,CAAA;QAC/B,CAAC;QACD,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,IAAI,GAAG;QACH,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,yBAAyB;YACzB,OAAO,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC1D,CAAC;IAED,IAAI,YAAY;QACZ,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAChC,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAA;QACpB,CAAC;QACD,OAAO,SAAS,GAAG,IAAI,CAAC,GAAG,CAAA;IAC/B,CAAC;CACJ;AAlGG;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;2CACrC;AAMX;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;0CAC/B;AAMV;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAC,CAAC;oDAChB;AAGlB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,YAAY,CAAC,aAAa,CAAC,EAAE,CAAC;4CACzB;AAO3B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;2DACrB;AAI5B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;kDACf;AAGnB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;qDACZ;AAGtB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;qDACL;AAGvB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;uDACZ;AAGtC;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;oDAC/B;AAGnC;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;gDACjC;AAG/B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;gDACjC;AAG/B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;sDAC3B;AAqDzC,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QAQI,YAAO,GAAmB,IAAI,CAAA;QAK9B;;WAEG;QAEH,WAAM,GAAkB,IAAI,CAAA;QAG5B,cAAS,GAAgB,IAAI,CAAA;QAG7B,cAAS,GAAgB,IAAI,CAAA;QAG7B,WAAM,GAAgB,IAAI,CAAA;IAC9B,CAAC;CAAA;AAtBG;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC;qCACtD;AAGV;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;0CACd;AAG9B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;uCACf;AAMnB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;yCACvB;AAG5B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;4CACnB;AAG7B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;4CACnB;AAG7B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;yCACtB;AAG9B,MAAM,OAAO,gBAAiB,SAAQ,SAAS;IAA/C;;QAKI,eAAU,GAAsB,IAAI,CAAA;QAGpC,cAAS,GAAkB,IAAI,CAAA;IAgCnC,CAAC;IA9BG,UAAU,CAAC,KAAa;;QACpB,IAAI,KAAK,MAAK,MAAA,IAAI,CAAC,MAAM,0CAAE,QAAQ,EAAE,CAAA,IAAI,KAAK,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;YACzD,OAAO,IAAI,CAAA;QACf,CAAC;QAED,IACI,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC;YACzD,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;YACjE,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,GAAG,CAAC;YAC5D,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9F,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,EACrE,CAAC;YACC,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACrB,OAAO,KAAK,CAAA;QAChB,CAAC;QAED,IACI,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;YAC1D,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;YAClE,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC;YACpE,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC;YACzD,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,EAC3D,CAAC;YACC,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AAtCG;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;sDACtB;AAGjC;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;oDACX;AAGpC;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;mDACjC;AAkCnC,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QAEI,OAAE,GAAkB,IAAI,CAAA;QAMxB,YAAO,GAAqB,IAAI,CAAA;QAGhC,cAAS,GAAgB,IAAI,CAAA;QAG7B,cAAS,GAAgB,IAAI,CAAA;IACjC,CAAC;CAAA;AAbG;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;4CAC1C;AAGxB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;8CACf;AAGnB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;iDACd;AAGhC;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;mDACnB;AAG7B;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;mDACnB;AAGjC,MAAM,OAAO,uBAAwB,SAAQ,gBAAgB;CAG5D;AADG;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;6DACtB;AAIrC,MAAM,OAAO,iBAAkB,SAAQ,WAAW;CAMjD;AAJG;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;qDAC/B;AAGnB;IADC,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;kDAC3B"}

package/esm/dist/src/billing/STPackage.d.ts

@@ -0,0 +1,89 @@
+import { AutoEncoder } from "@simonbackx/simple-encoding";
+import { Address } from "../addresses/Address";
+export declare enum STPackageType {
+    "LegacyMembers" = "LegacyMembers",
+    "Members" = "Members",
+    "Webshops" = "Webshops",
+    "SingleWebshop" = "SingleWebshop",
+    "TrialMembers" = "TrialMembers",
+    "TrialWebshops" = "TrialWebshops"
+}
+export declare class STPackageTypeHelper {
+    static getName(type: STPackageType): string;
+}
+export declare enum STPricingType {
+    "Fixed" = "Fixed",
+    /**
+     * Package is renewable per year
+     * Package can get extended initially to a specific date
+     */
+    "PerYear" = "PerYear",
+    /**
+     * Price is per member, per year
+     */
+    "PerMember" = "PerMember"
+}
+export declare class STPackageMeta extends AutoEncoder {
+    get name(): string;
+    /**
+     * ID of the package that was renewed (if it was renewed)
+     */
+    didRenewId?: string;
+    type: STPackageType;
+    pricingType: STPricingType;
+    unitPrice: number;
+    paidAmount: number;
+    paidPrice: number;
+    /**
+     * Minimum amount that will needs to get invoiced. Only used for first invoice
+     */
+    minimumAmount: number;
+    /**
+     * Only used if applicable
+     */
+    autorenew: boolean;
+    /**
+     * Only used if applicable
+     */
+    allowRenew: boolean;
+    firstFailedPayment: Date | null;
+    paymentFailedCount: number;
+    /**
+     * Date when the package starts. Is is valid until validUntil
+     */
+    startDate: Date;
+    canDeactivate: boolean;
+}
+/**
+ * A package contains a price agreement for a given period that might be renewable
+ */
+export declare class STPackage extends AutoEncoder {
+    id: string;
+    meta: STPackageMeta;
+    createdAt: Date;
+    updatedAt: Date;
+    /**
+     * validAt is null if the initial needed payment is missing. The package can be ignore
+     * It contains the date when the package was validated and added correctly.
+     */
+    validAt: Date | null;
+    validUntil: Date | null;
+    removeAt: Date | null;
+    shouldHintRenew(): boolean;
+    get status(): STPackageStatus;
+}
+export declare class STPackageStatus extends AutoEncoder {
+    startDate: Date;
+    validUntil: Date | null;
+    removeAt: Date | null;
+    firstFailedPayment: Date | null;
+    get isActive(): boolean;
+    /**
+     * Purchased the package, the package is not yet removed, but it is expired or not paid after 4 weeks following a failed payment
+     */
+    get wasActive(): boolean;
+    get deactivateDate(): Date | null;
+    merge(status: STPackageStatus): void;
+}
+export declare function calculateVATPercentage(address: Address, VATNumber: string | null): number;
+//# sourceMappingURL=STPackage.d.ts.map

package/esm/dist/src/billing/STPackage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"STPackage.d.ts","sourceRoot":"","sources":["../../../../src/billing/STPackage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAkF,MAAM,6BAA6B,CAAA;AAIzI,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAI/C,oBAAY,aAAa;IAErB,eAAe,kBAAkB;IAGjC,SAAS,YAAY;IAGrB,UAAU,aAAa;IAGvB,eAAe,kBAAkB;IAEjC,cAAc,iBAAiB;IAC/B,eAAe,kBAAkB;CACpC;AAED,qBAAa,mBAAmB;IAC5B,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM;CAgB9C;AAED,oBAAY,aAAa;IACrB,OAAO,UAAU;IAEjB;;;OAGG;IACH,SAAS,YAAY;IAErB;;OAEG;IACH,WAAW,cAAc;CAC5B;AAED,qBAAa,aAAc,SAAQ,WAAW;IAC1C,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IAEH,UAAU,CAAC,EAAE,MAAM,CAAA;IAGnB,IAAI,EAAE,aAAa,CAAA;IAGnB,WAAW,gBAAsB;IAGjC,SAAS,SAAI;IAIb,UAAU,SAAI;IAId,SAAS,SAAI;IAEb;;OAEG;IAEH,aAAa,SAAI;IAEjB;;OAEG;IAEH,SAAS,UAAO;IAEhB;;OAEG;IAEH,UAAU,UAAQ;IAMlB,kBAAkB,EAAE,IAAI,GAAG,IAAI,CAAO;IAGtC,kBAAkB,SAAI;IAEtB;;OAEG;IAEH,SAAS,EAAE,IAAI,CAAA;IAGf,aAAa,UAAQ;CACxB;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IAEtC,EAAE,EAAE,MAAM,CAAA;IAGV,IAAI,EAAE,aAAa,CAAA;IAGnB,SAAS,OAAa;IAGtB,SAAS,OAAa;IAEtB;;;OAGG;IAEH,OAAO,EAAE,IAAI,GAAG,IAAI,CAAO;IAG3B,UAAU,EAAE,IAAI,GAAG,IAAI,CAAO;IAI9B,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAO;IAE5B,eAAe;IAoBf,IAAI,MAAM,oBAOT;CACJ;AAED,qBAAa,eAAgB,SAAQ,WAAW;IAE5C,SAAS,EAAE,IAAI,CAAA;IAGf,UAAU,EAAE,IAAI,GAAG,IAAI,CAAO;IAI9B,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAO;IAG5B,kBAAkB,EAAE,IAAI,GAAG,IAAI,CAAO;IAEtC,IAAI,QAAQ,YAwBX;IAED;;OAEG;IACH,IAAI,SAAS,YA8BZ;IAED,IAAI,cAAc,IAAI,IAAI,GAAG,IAAI,CAqBhC;IAED,KAAK,CAAC,MAAM,EAAE,eAAe;CA8BhC;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,UA0BhF"}