@antelopejs/dms-saas 0.2.0 → 0.3.0

package/dist/upcoming-invoice/mapping.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toAvailablePreview = toAvailablePreview;
+const invoice_line_items_1 = require("../invoice-line-items");
+const MS_PER_SECOND = 1000;
+const REVERSE_CHARGE_REASON = "reverse_charge";
+const SUBSCRIPTION_LINE_TYPE = "subscription";
+function toIsoDate(seconds) {
+    return new Date(seconds * MS_PER_SECOND).toISOString();
+}
+function sumAmounts(amounts) {
+    return (amounts ?? []).reduce((total, entry) => total + entry.amount, 0);
+}
+function toLineKind(line) {
+    if (line.type === SUBSCRIPTION_LINE_TYPE)
+        return "subscription";
+    return line.metadata?.[invoice_line_items_1.LINE_KEY_METADATA] ? "usage" : "invoice_item";
+}
+function toPreviewLine(line) {
+    return {
+        kind: toLineKind(line),
+        description: line.description,
+        amountMinorUnits: line.amount_excluding_tax ?? line.amount,
+        taxMinorUnits: sumAmounts(line.tax_amounts),
+        quantity: line.quantity,
+        periodStart: toIsoDate(line.period.start),
+        periodEnd: toIsoDate(line.period.end),
+        isProration: line.proration,
+        usageLineKey: line.metadata?.[invoice_line_items_1.LINE_KEY_METADATA] ?? null,
+    };
+}
+function toUppercase(value) {
+    return value ? value.toUpperCase() : null;
+}
+function expandedTaxRate(taxRate) {
+    return typeof taxRate === "string" ? null : taxRate;
+}
+function toPreviewTax(taxAmount) {
+    const rate = expandedTaxRate(taxAmount.tax_rate);
+    return {
+        amountMinorUnits: taxAmount.amount,
+        taxableAmountMinorUnits: taxAmount.taxable_amount,
+        isInclusive: taxAmount.inclusive,
+        ratePercentage: rate
+            ? (rate.effective_percentage ?? rate.percentage)
+            : null,
+        country: toUppercase(rate?.country),
+        taxType: rate?.tax_type ?? null,
+        displayName: rate?.display_name ?? null,
+        jurisdiction: rate?.jurisdiction ?? null,
+        taxabilityReason: taxAmount.taxability_reason,
+        isReverseCharge: taxAmount.taxability_reason === REVERSE_CHARGE_REASON,
+    };
+}
+function resolveTaxCountry(invoice, taxes) {
+    const taxedCountry = taxes.find((tax) => tax.country)?.country;
+    return taxedCountry ?? toUppercase(invoice.customer_address?.country);
+}
+function toAvailablePreview(invoice, pricing) {
+    const taxes = (invoice.total_tax_amounts ?? []).map(toPreviewTax);
+    const taxMinorUnits = sumAmounts(invoice.total_tax_amounts);
+    return {
+        status: "available",
+        currency: invoice.currency.toUpperCase(),
+        lines: invoice.lines.data.map(toPreviewLine),
+        hasMoreLines: invoice.lines.has_more,
+        subtotalMinorUnits: invoice.subtotal_excluding_tax ?? invoice.subtotal,
+        totalExcludingTaxMinorUnits: invoice.total_excluding_tax ?? invoice.total - taxMinorUnits,
+        taxMinorUnits,
+        taxes,
+        taxCountry: resolveTaxCountry(invoice, taxes),
+        isReverseCharge: taxes.some((tax) => tax.isReverseCharge),
+        totalMinorUnits: invoice.total,
+        amountDueMinorUnits: invoice.amount_due,
+        periodStart: toIsoDate(invoice.period_start),
+        periodEnd: toIsoDate(invoice.period_end),
+        billingDate: pricing.billingDate.toISOString(),
+        usageThrough: pricing.usageThrough?.toISOString() ?? null,
+        computedAt: pricing.computedAt.toISOString(),
+    };
+}
+//# sourceMappingURL=mapping.js.map

package/dist/upcoming-invoice/mapping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../src/upcoming-invoice/mapping.ts"],"names":[],"mappings":";;AA8FA,gDA0BC;AAjHD,8DAA0D;AAE1D,MAAM,aAAa,GAAG,IAAI,CAAC;AAC3B,MAAM,qBAAqB,GAAG,gBAAgB,CAAC;AAC/C,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAa9C,SAAS,SAAS,CAAC,OAAe;IAChC,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;AACzD,CAAC;AAED,SAAS,UAAU,CAAC,OAAyC;IAC3D,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,UAAU,CAAC,IAA4B;IAC9C,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAsB;QAAE,OAAO,cAAc,CAAC;IAChE,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,sCAAiB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC;AACvE,CAAC;AAED,SAAS,aAAa,CAAC,IAA4B;IACjD,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;QACtB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,gBAAgB,EAAE,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,MAAM;QAC1D,aAAa,EAAE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;QAC3C,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QACzC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;QACrC,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,sCAAiB,CAAC,IAAI,IAAI;KACzD,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAgC;IACnD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5C,CAAC;AAED,SAAS,eAAe,CACtB,OAAgC;IAEhC,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;AACtD,CAAC;AAED,SAAS,YAAY,CACnB,SAAwC;IAExC,MAAM,IAAI,GAAG,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACjD,OAAO;QACL,gBAAgB,EAAE,SAAS,CAAC,MAAM;QAClC,uBAAuB,EAAE,SAAS,CAAC,cAAc;QACjD,WAAW,EAAE,SAAS,CAAC,SAAS;QAChC,cAAc,EAAE,IAAI;YAClB,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,UAAU,CAAC;YAChD,CAAC,CAAC,IAAI;QACR,OAAO,EAAE,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC;QACnC,OAAO,EAAE,IAAI,EAAE,QAAQ,IAAI,IAAI;QAC/B,WAAW,EAAE,IAAI,EAAE,YAAY,IAAI,IAAI;QACvC,YAAY,EAAE,IAAI,EAAE,YAAY,IAAI,IAAI;QACxC,gBAAgB,EAAE,SAAS,CAAC,iBAAiB;QAC7C,eAAe,EAAE,SAAS,CAAC,iBAAiB,KAAK,qBAAqB;KACvE,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,OAAuB,EACvB,KAA2B;IAE3B,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC/D,OAAO,YAAY,IAAI,WAAW,CAAC,OAAO,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;AACxE,CAAC;AAOD,SAAgB,kBAAkB,CAChC,OAAuB,EACvB,OAA8B;IAE9B,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC5D,OAAO;QACL,MAAM,EAAE,WAAW;QACnB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE;QACxC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;QAC5C,YAAY,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ;QACpC,kBAAkB,EAAE,OAAO,CAAC,sBAAsB,IAAI,OAAO,CAAC,QAAQ;QACtE,2BAA2B,EACzB,OAAO,CAAC,mBAAmB,IAAI,OAAO,CAAC,KAAK,GAAG,aAAa;QAC9D,aAAa;QACb,KAAK;QACL,UAAU,EAAE,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC;QAC7C,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC;QACzD,eAAe,EAAE,OAAO,CAAC,KAAK;QAC9B,mBAAmB,EAAE,OAAO,CAAC,UAAU;QACvC,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC;QAC5C,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC;QACxC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;QAC9C,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,WAAW,EAAE,IAAI,IAAI;QACzD,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE;KAC7C,CAAC;AACJ,CAAC"}

package/dist/upcoming-invoice/outcomes.d.ts

@@ -0,0 +1,13 @@
+import type { UpcomingInvoicePreview, UpcomingInvoicePreviewAbsenceReason, UpcomingInvoicePreviewUnavailableReason } from "@antelopejs/interface-dms-saas/billing";
+export interface AbsentPreviewOutcome {
+    status: "absent";
+    reason: UpcomingInvoicePreviewAbsenceReason;
+}
+export interface UnavailablePreviewOutcome {
+    status: "unavailable";
+    reason: UpcomingInvoicePreviewUnavailableReason;
+}
+export type PreviewOutcome = AbsentPreviewOutcome | UnavailablePreviewOutcome;
+export declare function absent(reason: UpcomingInvoicePreviewAbsenceReason): AbsentPreviewOutcome;
+export declare function unavailable(reason: UpcomingInvoicePreviewUnavailableReason): UnavailablePreviewOutcome;
+export declare function stampOutcome(outcome: PreviewOutcome, computedAt: Date): UpcomingInvoicePreview;

package/dist/upcoming-invoice/outcomes.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.absent = absent;
+exports.unavailable = unavailable;
+exports.stampOutcome = stampOutcome;
+function absent(reason) {
+    return { status: "absent", reason };
+}
+function unavailable(reason) {
+    return { status: "unavailable", reason };
+}
+function stampOutcome(outcome, computedAt) {
+    return { ...outcome, computedAt: computedAt.toISOString() };
+}
+//# sourceMappingURL=outcomes.js.map

package/dist/upcoming-invoice/outcomes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outcomes.js","sourceRoot":"","sources":["../../src/upcoming-invoice/outcomes.ts"],"names":[],"mappings":";;AAoBA,wBAIC;AAED,kCAIC;AAED,oCAKC;AAjBD,SAAgB,MAAM,CACpB,MAA2C;IAE3C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC;AAED,SAAgB,WAAW,CACzB,MAA+C;IAE/C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;AAC3C,CAAC;AAED,SAAgB,YAAY,CAC1B,OAAuB,EACvB,UAAgB;IAEhB,OAAO,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC;AAC9D,CAAC"}

package/dist/upcoming-invoice/preview.d.ts

@@ -0,0 +1,3 @@
+import type { UpcomingInvoicePreview } from "@antelopejs/interface-dms-saas/billing";
+export declare function getUpcomingInvoicePreview(tenantId: string): Promise<UpcomingInvoicePreview>;
+export declare function invalidateUpcomingInvoicePreview(tenantId: string): Promise<void>;

package/dist/upcoming-invoice/preview.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUpcomingInvoicePreview = getUpcomingInvoicePreview;
+exports.invalidateUpcomingInvoicePreview = invalidateUpcomingInvoicePreview;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const config_1 = require("../config");
+const db_1 = require("../db");
+const preview_cache_model_1 = require("./db/preview-cache.model");
+const eligibility_1 = require("./eligibility");
+const outcomes_1 = require("./outcomes");
+const pricing_1 = require("./pricing");
+const LOG_PREFIX = "[dms-saas:upcoming-invoice]";
+const MISSING_ROW_VERSION = "none";
+const SOURCE_VERSION_SEPARATOR = "|";
+function rowVersion(row) {
+    return row?.updatedAt
+        ? new Date(row.updatedAt).toISOString()
+        : MISSING_ROW_VERSION;
+}
+function toSourceVersion(subscription, billingInfo) {
+    return [rowVersion(subscription), rowVersion(billingInfo)].join(SOURCE_VERSION_SEPARATOR);
+}
+async function readCachedPreview(tenantId, sourceVersion, computedNotBefore) {
+    try {
+        return await (0, interface_database_decorators_1.GetModel)(preview_cache_model_1.UpcomingInvoicePreviewCacheModel).readFresh({
+            tenantId,
+            sourceVersion,
+            computedNotBefore,
+        });
+    }
+    catch (error) {
+        logging_1.Logging.Error(`${LOG_PREFIX} cache read failed for ${tenantId}`, error);
+        return null;
+    }
+}
+async function cachePreview(tenantId, preview, sourceVersion, computedAt) {
+    if (preview.status === "unavailable")
+        return;
+    try {
+        await (0, interface_database_decorators_1.GetModel)(preview_cache_model_1.UpcomingInvoicePreviewCacheModel).store({
+            tenantId,
+            preview,
+            sourceVersion,
+            computedAt,
+        });
+    }
+    catch (error) {
+        logging_1.Logging.Error(`${LOG_PREFIX} cache write failed for ${tenantId}`, error);
+    }
+}
+async function getUpcomingInvoicePreview(tenantId) {
+    const now = new Date();
+    const [subscription, billingInfo] = await Promise.all([
+        (0, interface_database_decorators_1.GetModel)(db_1.TenantSubscriptionModel, tenantId).findOne(),
+        (0, interface_database_decorators_1.GetModel)(db_1.TenantBillingInfoModel, tenantId).findOne(),
+    ]);
+    const plan = subscription?.planId
+        ? await (0, interface_database_decorators_1.GetModel)(db_1.PlanModel).get(subscription.planId)
+        : undefined;
+    const eligibility = (0, eligibility_1.resolvePreviewEligibility)(subscription, plan);
+    if (!eligibility.isPreviewable)
+        return (0, outcomes_1.stampOutcome)(eligibility.outcome, now);
+    const ttlMs = (0, config_1.getUpcomingInvoicePreviewCacheTtlMs)();
+    const sourceVersion = toSourceVersion(subscription, billingInfo);
+    if (ttlMs > 0) {
+        const computedNotBefore = new Date(now.getTime() - ttlMs);
+        const cached = await readCachedPreview(tenantId, sourceVersion, computedNotBefore);
+        if (cached)
+            return cached;
+    }
+    const preview = await (0, pricing_1.priceUpcomingInvoice)(tenantId, eligibility.target, now);
+    if (ttlMs > 0)
+        await cachePreview(tenantId, preview, sourceVersion, now);
+    return preview;
+}
+async function invalidateUpcomingInvoicePreview(tenantId) {
+    await (0, interface_database_decorators_1.GetModel)(preview_cache_model_1.UpcomingInvoicePreviewCacheModel).invalidate(tenantId, new Date());
+}
+//# sourceMappingURL=preview.js.map

package/dist/upcoming-invoice/preview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preview.js","sourceRoot":"","sources":["../../src/upcoming-invoice/preview.ts"],"names":[],"mappings":";;AAsFA,8DA2BC;AAGD,4EAOC;AA3HD,gEAA6D;AAC7D,6FAAqE;AAErE,sCAAgE;AAChE,8BAMe;AACf,kEAA4E;AAC5E,+CAA0D;AAC1D,yCAA0C;AAC1C,uCAAiD;AAEjD,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,mBAAmB,GAAG,MAAM,CAAC;AACnC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAMrC,SAAS,UAAU,CAAC,GAA6B;IAC/C,OAAO,GAAG,EAAE,SAAS;QACnB,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE;QACvC,CAAC,CAAC,mBAAmB,CAAC;AAC1B,CAAC;AAOD,SAAS,eAAe,CACtB,YAA4C,EAC5C,WAA0C;IAE1C,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAC7D,wBAAwB,CACzB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,QAAgB,EAChB,aAAqB,EACrB,iBAAuB;IAEvB,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,wCAAQ,EAAC,sDAAgC,CAAC,CAAC,SAAS,CAAC;YAChE,QAAQ;YACR,aAAa;YACb,iBAAiB;SAClB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,KAAK,CAAC,GAAG,UAAU,0BAA0B,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CACzB,QAAgB,EAChB,OAA+B,EAC/B,aAAqB,EACrB,UAAgB;IAIhB,IAAI,OAAO,CAAC,MAAM,KAAK,aAAa;QAAE,OAAO;IAC7C,IAAI,CAAC;QACH,MAAM,IAAA,wCAAQ,EAAC,sDAAgC,CAAC,CAAC,KAAK,CAAC;YACrD,QAAQ;YACR,OAAO;YACP,aAAa;YACb,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,KAAK,CAAC,GAAG,UAAU,2BAA2B,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC;AAMM,KAAK,UAAU,yBAAyB,CAC7C,QAAgB;IAEhB,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACpD,IAAA,wCAAQ,EAAC,4BAAuB,EAAE,QAAQ,CAAC,CAAC,OAAO,EAAE;QACrD,IAAA,wCAAQ,EAAC,2BAAsB,EAAE,QAAQ,CAAC,CAAC,OAAO,EAAE;KACrD,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,YAAY,EAAE,MAAM;QAC/B,CAAC,CAAC,MAAM,IAAA,wCAAQ,EAAC,cAAS,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,WAAW,GAAG,IAAA,uCAAyB,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAClE,IAAI,CAAC,WAAW,CAAC,aAAa;QAAE,OAAO,IAAA,uBAAY,EAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC9E,MAAM,KAAK,GAAG,IAAA,4CAAmC,GAAE,CAAC;IACpD,MAAM,aAAa,GAAG,eAAe,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IACjE,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,MAAM,iBAAiB,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,iBAAiB,CACpC,QAAQ,EACR,aAAa,EACb,iBAAiB,CAClB,CAAC;QACF,IAAI,MAAM;YAAE,OAAO,MAAM,CAAC;IAC5B,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,IAAA,8BAAoB,EAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9E,IAAI,KAAK,GAAG,CAAC;QAAE,MAAM,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC;IACzE,OAAO,OAAO,CAAC;AACjB,CAAC;AAGM,KAAK,UAAU,gCAAgC,CACpD,QAAgB;IAEhB,MAAM,IAAA,wCAAQ,EAAC,sDAAgC,CAAC,CAAC,UAAU,CACzD,QAAQ,EACR,IAAI,IAAI,EAAE,CACX,CAAC;AACJ,CAAC"}

package/dist/upcoming-invoice/pricing.d.ts

@@ -0,0 +1,3 @@
+import type { UpcomingInvoicePreview } from "@antelopejs/interface-dms-saas/billing";
+import type { PreviewableSubscription } from "./eligibility";
+export declare function priceUpcomingInvoice(tenantId: string, target: PreviewableSubscription, computedAt: Date): Promise<UpcomingInvoicePreview>;

package/dist/upcoming-invoice/pricing.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.priceUpcomingInvoice = priceUpcomingInvoice;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const upcoming_invoice_1 = require("../stripe/upcoming-invoice");
+const mapping_1 = require("./mapping");
+const outcomes_1 = require("./outcomes");
+const usage_1 = require("./usage");
+const LOG_PREFIX = "[dms-saas:upcoming-invoice]";
+const COMPLETE_TAX_STATUS = "complete";
+const STRIPE_ERROR_OUTCOMES = new Map([
+    ["invoice_upcoming_none", (0, outcomes_1.absent)("no_upcoming_invoice")],
+    ["stripe_tax_inactive", (0, outcomes_1.unavailable)("tax_not_configured")],
+    ["customer_tax_location_invalid", (0, outcomes_1.unavailable)("tax_location_invalid")],
+    ["invalid_tax_location", (0, outcomes_1.unavailable)("tax_location_invalid")],
+    ["taxes_calculation_failed", (0, outcomes_1.unavailable)("tax_calculation_failed")],
+]);
+const AUTOMATIC_TAX_STATUS_REASONS = {
+    requires_location_inputs: "tax_location_required",
+    failed: "tax_calculation_failed",
+};
+const PROVIDER_ERROR = (0, outcomes_1.unavailable)("provider_error");
+function stripeErrorCode(error) {
+    if (typeof error !== "object" || error === null)
+        return null;
+    const { code } = error;
+    return typeof code === "string" ? code : null;
+}
+function classifyStripeError(error) {
+    const code = stripeErrorCode(error);
+    return (code && STRIPE_ERROR_OUTCOMES.get(code)) || PROVIDER_ERROR;
+}
+function incompleteTaxReason(invoice) {
+    const { enabled, status } = invoice.automatic_tax;
+    if (!enabled || status === COMPLETE_TAX_STATUS)
+        return null;
+    return ((status && AUTOMATIC_TAX_STATUS_REASONS[status]) || "tax_calculation_failed");
+}
+function reportUnavailable(tenantId, reason, cause) {
+    logging_1.Logging.Error(`${LOG_PREFIX} no upcoming invoice preview for tenant ${tenantId} (${reason})`, cause);
+}
+async function priceWithStripe(tenantId, target, computedAt) {
+    const cycle = await (0, upcoming_invoice_1.retrieveStripeSubscriptionCycle)(target.subscriptionId);
+    const usage = await (0, usage_1.quoteRunningCycleUsage)({
+        tenantId,
+        subscription: target.subscription,
+        stripeSubscriptionId: target.subscriptionId,
+        cycle,
+        now: computedAt,
+    });
+    if (!usage) {
+        reportUnavailable(tenantId, "usage_unavailable");
+        return (0, outcomes_1.stampOutcome)((0, outcomes_1.unavailable)("usage_unavailable"), computedAt);
+    }
+    const invoice = await (0, upcoming_invoice_1.previewStripeUpcomingInvoice)({
+        customerId: target.customerId,
+        subscriptionId: target.subscriptionId,
+        currency: cycle.currency,
+        quotedItems: usage.items,
+    });
+    const taxReason = incompleteTaxReason(invoice);
+    if (taxReason) {
+        reportUnavailable(tenantId, taxReason);
+        return (0, outcomes_1.stampOutcome)((0, outcomes_1.unavailable)(taxReason), computedAt);
+    }
+    return (0, mapping_1.toAvailablePreview)(invoice, {
+        billingDate: cycle.currentPeriodEnd,
+        usageThrough: usage.usageThrough,
+        computedAt,
+    });
+}
+async function priceUpcomingInvoice(tenantId, target, computedAt) {
+    try {
+        return await priceWithStripe(tenantId, target, computedAt);
+    }
+    catch (error) {
+        const outcome = classifyStripeError(error);
+        if (outcome.status === "unavailable") {
+            reportUnavailable(tenantId, outcome.reason, error);
+        }
+        return (0, outcomes_1.stampOutcome)(outcome, computedAt);
+    }
+}
+//# sourceMappingURL=pricing.js.map

package/dist/upcoming-invoice/pricing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing.js","sourceRoot":"","sources":["../../src/upcoming-invoice/pricing.ts"],"names":[],"mappings":";;AAyHA,oDAcC;AAvID,gEAA6D;AAM7D,iEAGoC;AAEpC,uCAA+C;AAC/C,yCAKoB;AACpB,mCAAiD;AAEjD,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,mBAAmB,GAAG,UAAU,CAAC;AAGvC,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAyB;IAC5D,CAAC,uBAAuB,EAAE,IAAA,iBAAM,EAAC,qBAAqB,CAAC,CAAC;IACxD,CAAC,qBAAqB,EAAE,IAAA,sBAAW,EAAC,oBAAoB,CAAC,CAAC;IAC1D,CAAC,+BAA+B,EAAE,IAAA,sBAAW,EAAC,sBAAsB,CAAC,CAAC;IACtE,CAAC,sBAAsB,EAAE,IAAA,sBAAW,EAAC,sBAAsB,CAAC,CAAC;IAC7D,CAAC,0BAA0B,EAAE,IAAA,sBAAW,EAAC,wBAAwB,CAAC,CAAC;CACpE,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAG9B;IACF,wBAAwB,EAAE,uBAAuB;IACjD,MAAM,EAAE,wBAAwB;CACjC,CAAC;AAEF,MAAM,cAAc,GAAG,IAAA,sBAAW,EAAC,gBAAgB,CAAC,CAAC;AAMrD,SAAS,eAAe,CAAC,KAAc;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC7D,MAAM,EAAE,IAAI,EAAE,GAAG,KAAmB,CAAC;IACrC,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAc;IACzC,MAAM,IAAI,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,CAAC,IAAI,IAAI,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,cAAc,CAAC;AACrE,CAAC;AAMD,SAAS,mBAAmB,CAC1B,OAAuB;IAEvB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAClD,IAAI,CAAC,OAAO,IAAI,MAAM,KAAK,mBAAmB;QAAE,OAAO,IAAI,CAAC;IAC5D,OAAO,CACL,CAAC,MAAM,IAAI,4BAA4B,CAAC,MAAM,CAAC,CAAC,IAAI,wBAAwB,CAC7E,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,QAAgB,EAChB,MAA+C,EAC/C,KAAe;IAEf,iBAAO,CAAC,KAAK,CACX,GAAG,UAAU,2CAA2C,QAAQ,KAAK,MAAM,GAAG,EAC9E,KAAK,CACN,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,eAAe,CAC5B,QAAgB,EAChB,MAA+B,EAC/B,UAAgB;IAEhB,MAAM,KAAK,GAAG,MAAM,IAAA,kDAA+B,EAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,MAAM,IAAA,8BAAsB,EAAC;QACzC,QAAQ;QACR,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,oBAAoB,EAAE,MAAM,CAAC,cAAc;QAC3C,KAAK;QACL,GAAG,EAAE,UAAU;KAChB,CAAC,CAAC;IACH,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,iBAAiB,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACjD,OAAO,IAAA,uBAAY,EAAC,IAAA,sBAAW,EAAC,mBAAmB,CAAC,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,IAAA,+CAA4B,EAAC;QACjD,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,WAAW,EAAE,KAAK,CAAC,KAAK;KACzB,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC/C,IAAI,SAAS,EAAE,CAAC;QACd,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACvC,OAAO,IAAA,uBAAY,EAAC,IAAA,sBAAW,EAAC,SAAS,CAAC,EAAE,UAAU,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,IAAA,4BAAkB,EAAC,OAAO,EAAE;QACjC,WAAW,EAAE,KAAK,CAAC,gBAAgB;QACnC,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,UAAU;KACX,CAAC,CAAC;AACL,CAAC;AAMM,KAAK,UAAU,oBAAoB,CACxC,QAAgB,EAChB,MAA+B,EAC/B,UAAgB;IAEhB,IAAI,CAAC;QACH,OAAO,MAAM,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,OAAO,CAAC,MAAM,KAAK,aAAa,EAAE,CAAC;YACrC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAA,uBAAY,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC"}

package/dist/upcoming-invoice/usage.d.ts

@@ -0,0 +1,14 @@
+import type { TenantSubscription } from "../db";
+import type { QuotedInvoiceItem, StripeSubscriptionCycle } from "../stripe/upcoming-invoice";
+export interface QuotedUsage {
+    items: QuotedInvoiceItem[];
+    usageThrough: Date | null;
+}
+export interface UsageQuoteRequest {
+    tenantId: string;
+    subscription: TenantSubscription;
+    stripeSubscriptionId: string;
+    cycle: StripeSubscriptionCycle;
+    now: Date;
+}
+export declare function quoteRunningCycleUsage(request: UsageQuoteRequest): Promise<QuotedUsage | null>;

package/dist/upcoming-invoice/usage.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.quoteRunningCycleUsage = quoteRunningCycleUsage;
+const invoice_line_items_1 = require("@antelopejs/interface-dms-saas/invoice-line-items");
+const invoice_line_items_2 = require("../implementations/dms-saas/invoice-line-items");
+const invoice_line_items_3 = require("../invoice-line-items");
+const billing_window_1 = require("../invoice-line-items/billing-window");
+const PREVIEW_INVOICE_ID_PREFIX = "upcoming_";
+const NO_USAGE = { items: [], usageThrough: null };
+function buildPreviewContext(request) {
+    if (request.now <= request.cycle.currentPeriodStart)
+        return null;
+    return (0, billing_window_1.clipInvoiceUsageWindow)({
+        tenantId: request.tenantId,
+        invoiceId: `${PREVIEW_INVOICE_ID_PREFIX}${request.stripeSubscriptionId}`,
+        currency: request.cycle.currency,
+        periodStart: request.cycle.currentPeriodStart,
+        periodEnd: request.now,
+        isPreview: true,
+    }, request.subscription, request.stripeSubscriptionId);
+}
+async function quoteProviderLines(provider, context) {
+    const resolution = await (0, invoice_line_items_3.resolveProviderLineItems)(provider, context);
+    if (resolution.failures > 0)
+        return null;
+    const selection = (0, invoice_line_items_1.selectInvoiceLineItemsToCreate)(provider.id, resolution.lineItems, new Set());
+    (0, invoice_line_items_3.reportSkippedLineItems)(provider.id, context.invoiceId, selection.skipped);
+    if (selection.skipped.some((line) => line.reason === "invalid"))
+        return null;
+    return selection.accepted.map((prepared) => ({
+        amountMinorUnits: prepared.item.amountCents,
+        description: prepared.item.description,
+        periodStart: context.periodStart,
+        periodEnd: context.periodEnd,
+        metadata: (0, invoice_line_items_3.buildLineItemMetadata)(provider.id, prepared),
+    }));
+}
+async function quoteRunningCycleUsage(request) {
+    const providers = (0, invoice_line_items_2.getInvoiceLineItemsProviders)();
+    if (providers.length === 0)
+        return NO_USAGE;
+    const context = buildPreviewContext(request);
+    if (!context)
+        return NO_USAGE;
+    const quotes = await Promise.all(providers.map((provider) => quoteProviderLines(provider, context)));
+    if (quotes.some((quote) => quote === null))
+        return null;
+    return {
+        items: quotes.flatMap((quote) => quote ?? []),
+        usageThrough: context.periodEnd,
+    };
+}
+//# sourceMappingURL=usage.js.map

package/dist/upcoming-invoice/usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/upcoming-invoice/usage.ts"],"names":[],"mappings":";;AAmFA,wDAeC;AA9FD,0FAAmG;AAEnG,uFAA8F;AAC9F,8DAI+B;AAC/B,yEAA8E;AAM9E,MAAM,yBAAyB,GAAG,WAAW,CAAC;AAiB9C,MAAM,QAAQ,GAAgB,EAAE,KAAK,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;AAEhE,SAAS,mBAAmB,CAC1B,OAA0B;IAE1B,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,kBAAkB;QAAE,OAAO,IAAI,CAAC;IACjE,OAAO,IAAA,uCAAsB,EAC3B;QACE,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,GAAG,yBAAyB,GAAG,OAAO,CAAC,oBAAoB,EAAE;QACxE,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ;QAChC,WAAW,EAAE,OAAO,CAAC,KAAK,CAAC,kBAAkB;QAC7C,SAAS,EAAE,OAAO,CAAC,GAAG;QACtB,SAAS,EAAE,IAAI;KAChB,EACD,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,oBAAoB,CAC7B,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,QAAkC,EAClC,OAAgC;IAEhC,MAAM,UAAU,GAAG,MAAM,IAAA,6CAAwB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrE,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,MAAM,SAAS,GAAG,IAAA,mDAA8B,EAC9C,QAAQ,CAAC,EAAE,EACX,UAAU,CAAC,SAAS,EACpB,IAAI,GAAG,EAAE,CACV,CAAC;IACF,IAAA,2CAAsB,EAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC1E,IAAI,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7E,OAAO,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC3C,gBAAgB,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW;QAC3C,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW;QACtC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,QAAQ,EAAE,IAAA,0CAAqB,EAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;KACvD,CAAC,CAAC,CAAC;AACN,CAAC;AAQM,KAAK,UAAU,sBAAsB,CAC1C,OAA0B;IAE1B,MAAM,SAAS,GAAG,IAAA,iDAA4B,GAAE,CAAC;IACjD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC5C,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC7C,IAAI,CAAC,OAAO;QAAE,OAAO,QAAQ,CAAC;IAC9B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CACnE,CAAC;IACF,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACxD,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7C,YAAY,EAAE,OAAO,CAAC,SAAS;KAChC,CAAC;AACJ,CAAC"}

package/dist/workspaces/billing-identity.d.ts

@@ -0,0 +1,19 @@
+import type { TenantCustomerType } from "../db";
+import type { CustomerBillingAddress } from "../stripe";
+export interface BillingIdentityInput {
+    customerType?: string | null;
+    companyName?: string | null;
+    vatNumber?: string | null;
+    billingEmail?: string | null;
+    address?: CustomerBillingAddress;
+}
+export interface BillingIdentity {
+    customerType: TenantCustomerType;
+    companyName: string | null;
+    vatNumber: string | null;
+    billingEmail: string;
+    address: CustomerBillingAddress;
+}
+export type BillingIdentityField = "customerType" | "companyName" | "country" | "line1" | "postalCode" | "city" | "billingEmail";
+export declare function findMissingBillingIdentityFields(identity: BillingIdentityInput): BillingIdentityField[];
+export declare function parseBillingIdentity(identity: BillingIdentityInput): BillingIdentity;

package/dist/workspaces/billing-identity.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findMissingBillingIdentityFields = findMissingBillingIdentityFields;
+exports.parseBillingIdentity = parseBillingIdentity;
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const HTTP_BAD_REQUEST = 400;
+const BUSINESS_CUSTOMER_TYPE = "business";
+const CUSTOMER_TYPES = new Set(["individual", "business"]);
+const COUNTRY_CODE_PATTERN = /^[A-Z]{2}$/;
+const EMAIL_PATTERN = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+function trimmed(value) {
+    const result = value?.trim();
+    return result ? result : null;
+}
+function isBusiness(identity) {
+    return identity.customerType === BUSINESS_CUSTOMER_TYPE;
+}
+const FIELD_CHECKS = {
+    customerType: (identity) => CUSTOMER_TYPES.has(identity.customerType ?? ""),
+    companyName: (identity) => !isBusiness(identity) || !!trimmed(identity.companyName),
+    country: (identity) => COUNTRY_CODE_PATTERN.test(trimmed(identity.address?.country) ?? ""),
+    line1: (identity) => !!trimmed(identity.address?.line1),
+    postalCode: (identity) => !!trimmed(identity.address?.postalCode),
+    city: (identity) => !!trimmed(identity.address?.city),
+    billingEmail: (identity) => EMAIL_PATTERN.test(trimmed(identity.billingEmail) ?? ""),
+};
+function findMissingBillingIdentityFields(identity) {
+    return Object.keys(FIELD_CHECKS).filter((field) => !FIELD_CHECKS[field](identity));
+}
+function normalizeAddress(address) {
+    return {
+        line1: trimmed(address?.line1),
+        line2: trimmed(address?.line2),
+        postalCode: trimmed(address?.postalCode),
+        city: trimmed(address?.city),
+        state: trimmed(address?.state),
+        country: trimmed(address?.country),
+    };
+}
+function parseBillingIdentity(identity) {
+    (0, interface_api_util_1.assert)(findMissingBillingIdentityFields(identity).length === 0, HTTP_BAD_REQUEST, "saas.errors.billing.identity_incomplete");
+    const business = isBusiness(identity);
+    return {
+        customerType: identity.customerType,
+        companyName: business ? trimmed(identity.companyName) : null,
+        vatNumber: business ? trimmed(identity.vatNumber) : null,
+        billingEmail: trimmed(identity.billingEmail) ?? "",
+        address: normalizeAddress(identity.address),
+    };
+}
+//# sourceMappingURL=billing-identity.js.map

package/dist/workspaces/billing-identity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-identity.js","sourceRoot":"","sources":["../../src/workspaces/billing-identity.ts"],"names":[],"mappings":";;AAqEA,4EAMC;AAsBD,oDAgBC;AAjHD,uEAAwD;AAIxD,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,sBAAsB,GAAuB,UAAU,CAAC;AAC9D,MAAM,cAAc,GAAG,IAAI,GAAG,CAAS,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;AACnE,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAC1C,MAAM,aAAa,GAAG,4BAA4B,CAAC;AA+BnD,SAAS,OAAO,CAAC,KAAgC;IAC/C,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC;IAC7B,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAChC,CAAC;AAED,SAAS,UAAU,CAAC,QAA8B;IAChD,OAAO,QAAQ,CAAC,YAAY,KAAK,sBAAsB,CAAC;AAC1D,CAAC;AAED,MAAM,YAAY,GAA6C;IAC7D,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC;IAC3E,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE,CACxB,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAC1D,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CACpB,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IACrE,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IACvD,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IACjE,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACrD,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE,CACzB,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;CAC3D,CAAC;AAUF,SAAgB,gCAAgC,CAC9C,QAA8B;IAE9B,OAAQ,MAAM,CAAC,IAAI,CAAC,YAAY,CAA4B,CAAC,MAAM,CACjE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAC1C,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,OAA2C;IAE3C,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;QAC9B,UAAU,EAAE,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC;QACxC,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;QAC5B,KAAK,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;QAC9B,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC;KACnC,CAAC;AACJ,CAAC;AASD,SAAgB,oBAAoB,CAClC,QAA8B;IAE9B,IAAA,2BAAM,EACJ,gCAAgC,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EACvD,gBAAgB,EAChB,yCAAyC,CAC1C,CAAC;IACF,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO;QACL,YAAY,EAAE,QAAQ,CAAC,YAAkC;QACzD,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI;QAC5D,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;QACxD,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE;QAClD,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;KAC5C,CAAC;AACJ,CAAC"}

package/dist/workspaces/default-plan.d.ts

@@ -0,0 +1,5 @@
+import { type Plan } from "../db";
+export declare function selectDefaultPlan(plans: Plan[], configuredSlug?: string): Plan | null;
+export declare function resolveDefaultPlan(): Promise<Plan | null>;
+export declare function ensureDefaultSubscription(tenantId: string, plan?: Plan | null): Promise<boolean>;
+export declare function backfillDefaultSubscriptions(): Promise<number>;

package/dist/workspaces/default-plan.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.selectDefaultPlan = selectDefaultPlan;
+exports.resolveDefaultPlan = resolveDefaultPlan;
+exports.ensureDefaultSubscription = ensureDefaultSubscription;
+exports.backfillDefaultSubscriptions = backfillDefaultSubscriptions;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const db_1 = require("@antelopejs/interface-dms/db");
+const tenant_lifecycle_1 = require("@antelopejs/interface-dms/tenant-lifecycle");
+const billing_state_1 = require("../billing-state");
+const config_1 = require("../config");
+const db_2 = require("../db");
+const free_workspace_guard_1 = require("./free-workspace-guard");
+const LOG_PREFIX = "[dms-saas:default-plan]";
+const ACTIVE_STATUS = "active";
+const DEFAULT_PLAN_AUDIENCES = new Set(["any", "individual"]);
+function isDefaultPlanCandidate(plan) {
+    return (plan.isActive &&
+        !plan.isDeleted &&
+        (0, free_workspace_guard_1.isFreePlan)(plan) &&
+        DEFAULT_PLAN_AUDIENCES.has(plan.audience));
+}
+function selectDefaultPlan(plans, configuredSlug) {
+    const candidates = plans
+        .filter(isDefaultPlanCandidate)
+        .sort((left, right) => left.order - right.order);
+    if (!configuredSlug)
+        return candidates[0] ?? null;
+    const configured = candidates.find((plan) => plan.slug === configuredSlug);
+    if (!configured) {
+        logging_1.Logging.Warn(`${LOG_PREFIX} defaultPlanSlug "${configuredSlug}" names no active free plan; falling back to the lowest-ordered one`);
+    }
+    return configured ?? candidates[0] ?? null;
+}
+let hasWarnedMissingPlan = false;
+async function resolveDefaultPlan() {
+    const plans = await (0, interface_database_decorators_1.GetModel)(db_2.PlanModel).findActiveNotDeleted();
+    const plan = selectDefaultPlan(plans, (0, config_1.getDefaultPlanSlug)());
+    if (plan)
+        hasWarnedMissingPlan = false;
+    return plan;
+}
+function logMissingDefaultPlan() {
+    if (hasWarnedMissingPlan)
+        return;
+    hasWarnedMissingPlan = true;
+    logging_1.Logging.Warn(`${LOG_PREFIX} the catalogue has no active free plan: workspaces without a subscription stay plan-less until one is published`);
+}
+async function insertDefaultSubscription(tenantId, plan) {
+    const model = (0, interface_database_decorators_1.GetModel)(db_2.TenantSubscriptionModel, tenantId);
+    if (await model.findOne())
+        return false;
+    const now = new Date();
+    await model.insert([
+        {
+            _id: tenantId,
+            planId: plan._id,
+            status: ACTIVE_STATUS,
+            isComplimentary: false,
+            paidUsagePeriods: [],
+            stripeCustomerId: null,
+            stripeSubscriptionId: null,
+            stripeCheckoutSessionId: null,
+            createdBy: null,
+            createdAt: now,
+            updatedAt: now,
+        },
+    ]);
+    return true;
+}
+async function ensureDefaultSubscription(tenantId, plan) {
+    const defaultPlan = plan === undefined ? await resolveDefaultPlan() : plan;
+    if (!defaultPlan) {
+        logMissingDefaultPlan();
+        return false;
+    }
+    const isAttached = await (0, tenant_lifecycle_1.runTenantLifecycleOperation)(tenantId, () => insertDefaultSubscription(tenantId, defaultPlan));
+    if (isAttached)
+        await (0, billing_state_1.recomputeTenantBillingState)(tenantId);
+    return isAttached;
+}
+async function attachToTenant(tenantId, plan) {
+    try {
+        return await ensureDefaultSubscription(tenantId, plan);
+    }
+    catch (error) {
+        logging_1.Logging.Error(`${LOG_PREFIX} could not cover workspace ${tenantId}`, error);
+        return false;
+    }
+}
+async function backfillDefaultSubscriptions() {
+    const plan = await resolveDefaultPlan();
+    if (!plan) {
+        logMissingDefaultPlan();
+        return 0;
+    }
+    const tenants = await (0, interface_database_decorators_1.GetModel)(db_1.TenantModel).table.pluck("_id").run();
+    let attachedCount = 0;
+    for (const tenant of tenants) {
+        if (tenant._id && (await attachToTenant(tenant._id, plan))) {
+            attachedCount++;
+        }
+    }
+    if (attachedCount > 0) {
+        logging_1.Logging.Info(`${LOG_PREFIX} attached plan "${plan.slug}" to ${attachedCount} workspace(s)`);
+    }
+    return attachedCount;
+}
+//# sourceMappingURL=default-plan.js.map

package/dist/workspaces/default-plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-plan.js","sourceRoot":"","sources":["../../src/workspaces/default-plan.ts"],"names":[],"mappings":";;AAsCA,8CAeC;AAOD,gDAKC;AA6CD,8DAcC;AAmBD,oEAmBC;AAlKD,gEAA6D;AAC7D,6FAAqE;AACrE,qDAA2D;AAC3D,iFAAyF;AACzF,oDAA+D;AAC/D,sCAA+C;AAC/C,8BAKe;AACf,iEAAoD;AAEpD,MAAM,UAAU,GAAG,yBAAyB,CAAC;AAC7C,MAAM,aAAa,GAAG,QAAiB,CAAC;AAGxC,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAe,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;AAE5E,SAAS,sBAAsB,CAAC,IAAU;IACxC,OAAO,CACL,IAAI,CAAC,QAAQ;QACb,CAAC,IAAI,CAAC,SAAS;QACf,IAAA,iCAAU,EAAC,IAAI,CAAC;QAChB,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAC1C,CAAC;AACJ,CAAC;AAWD,SAAgB,iBAAiB,CAC/B,KAAa,EACb,cAAuB;IAEvB,MAAM,UAAU,GAAG,KAAK;SACrB,MAAM,CAAC,sBAAsB,CAAC;SAC9B,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACnD,IAAI,CAAC,cAAc;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAClD,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;IAC3E,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,iBAAO,CAAC,IAAI,CACV,GAAG,UAAU,qBAAqB,cAAc,qEAAqE,CACtH,CAAC;IACJ,CAAC;IACD,OAAO,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC7C,CAAC;AAID,IAAI,oBAAoB,GAAG,KAAK,CAAC;AAG1B,KAAK,UAAU,kBAAkB;IACtC,MAAM,KAAK,GAAG,MAAM,IAAA,wCAAQ,EAAC,cAAS,CAAC,CAAC,oBAAoB,EAAE,CAAC;IAC/D,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,EAAE,IAAA,2BAAkB,GAAE,CAAC,CAAC;IAC5D,IAAI,IAAI;QAAE,oBAAoB,GAAG,KAAK,CAAC;IACvC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,qBAAqB;IAC5B,IAAI,oBAAoB;QAAE,OAAO;IACjC,oBAAoB,GAAG,IAAI,CAAC;IAC5B,iBAAO,CAAC,IAAI,CACV,GAAG,UAAU,iHAAiH,CAC/H,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,yBAAyB,CACtC,QAAgB,EAChB,IAAU;IAEV,MAAM,KAAK,GAAG,IAAA,wCAAQ,EAAC,4BAAuB,EAAE,QAAQ,CAAC,CAAC;IAC1D,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE;QAAE,OAAO,KAAK,CAAC;IACxC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,MAAM,KAAK,CAAC,MAAM,CAAC;QACjB;YACE,GAAG,EAAE,QAAQ;YACb,MAAM,EAAE,IAAI,CAAC,GAAG;YAChB,MAAM,EAAE,aAAa;YACrB,eAAe,EAAE,KAAK;YACtB,gBAAgB,EAAE,EAAE;YACpB,gBAAgB,EAAE,IAAI;YACtB,oBAAoB,EAAE,IAAI;YAC1B,uBAAuB,EAAE,IAAI;YAC7B,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,GAAG;SACf;KACF,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC;AAYM,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,IAAkB;IAElB,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,qBAAqB,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,IAAA,8CAA2B,EAAC,QAAQ,EAAE,GAAG,EAAE,CAClE,yBAAyB,CAAC,QAAQ,EAAE,WAAW,CAAC,CACjD,CAAC;IACF,IAAI,UAAU;QAAE,MAAM,IAAA,2CAA2B,EAAC,QAAQ,CAAC,CAAC;IAC5D,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,QAAgB,EAAE,IAAU;IACxD,IAAI,CAAC;QACH,OAAO,MAAM,yBAAyB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAEf,iBAAO,CAAC,KAAK,CAAC,GAAG,UAAU,8BAA8B,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;QAC5E,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AASM,KAAK,UAAU,4BAA4B;IAChD,MAAM,IAAI,GAAG,MAAM,kBAAkB,EAAE,CAAC;IACxC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,qBAAqB,EAAE,CAAC;QACxB,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,IAAA,wCAAQ,EAAC,gBAAW,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;IACrE,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YAC3D,aAAa,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IACD,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;QACtB,iBAAO,CAAC,IAAI,CACV,GAAG,UAAU,mBAAmB,IAAI,CAAC,IAAI,QAAQ,aAAa,eAAe,CAC9E,CAAC;IACJ,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/dist/workspaces/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./billing-profile";
+export * from "./default-plan";
 export * from "./deletion";
 export * from "./free-workspace-guard";
+export * from "./invitations";
 export * from "./provisioning";
 export * from "./registration-extras";
 export * from "./suspension";

package/dist/workspaces/index.js

@@ -15,8 +15,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./billing-profile"), exports);
+__exportStar(require("./default-plan"), exports);
 __exportStar(require("./deletion"), exports);
 __exportStar(require("./free-workspace-guard"), exports);
+__exportStar(require("./invitations"), exports);
 __exportStar(require("./provisioning"), exports);
 __exportStar(require("./registration-extras"), exports);
 __exportStar(require("./suspension"), exports);

package/dist/workspaces/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/workspaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,6CAA2B;AAC3B,yDAAuC;AACvC,iDAA+B;AAC/B,wDAAsC;AACtC,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/workspaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,iDAA+B;AAC/B,6CAA2B;AAC3B,yDAAuC;AACvC,gDAA8B;AAC9B,iDAA+B;AAC/B,wDAAsC;AACtC,+CAA6B"}