@antelopejs/dms-saas 0.1.8 → 0.2.1

package/dist/upcoming-invoice/db/preview-cache.table.d.ts

@@ -0,0 +1,10 @@
+import { Table } from "@antelopejs/interface-database-decorators";
+import type { UpcomingInvoicePreview } from "@antelopejs/interface-dms-saas/billing";
+export declare const upcomingInvoicePreviewsTableName = "saas_upcoming_invoice_previews";
+export declare class UpcomingInvoicePreviewEntry extends Table {
+    _id: string;
+    preview: UpcomingInvoicePreview | null;
+    sourceVersion: string | null;
+    computedAt: Date | null;
+    invalidatedAt: Date | null;
+}

package/dist/upcoming-invoice/db/preview-cache.table.js

@@ -0,0 +1,42 @@
+"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.UpcomingInvoicePreviewEntry = exports.upcomingInvoicePreviewsTableName = void 0;
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const constants_1 = require("@antelopejs/interface-dms/constants");
+exports.upcomingInvoicePreviewsTableName = "saas_upcoming_invoice_previews";
+let UpcomingInvoicePreviewEntry = class UpcomingInvoicePreviewEntry extends interface_database_decorators_1.Table {
+};
+exports.UpcomingInvoicePreviewEntry = UpcomingInvoicePreviewEntry;
+__decorate([
+    (0, interface_database_decorators_1.Field)("string"),
+    __metadata("design:type", String)
+], UpcomingInvoicePreviewEntry.prototype, "_id", void 0);
+__decorate([
+    (0, interface_database_decorators_1.Field)("any"),
+    __metadata("design:type", Object)
+], UpcomingInvoicePreviewEntry.prototype, "preview", void 0);
+__decorate([
+    (0, interface_database_decorators_1.Field)("string"),
+    __metadata("design:type", Object)
+], UpcomingInvoicePreviewEntry.prototype, "sourceVersion", void 0);
+__decorate([
+    (0, interface_database_decorators_1.Field)("date"),
+    __metadata("design:type", Object)
+], UpcomingInvoicePreviewEntry.prototype, "computedAt", void 0);
+__decorate([
+    (0, interface_database_decorators_1.Field)("date"),
+    __metadata("design:type", Object)
+], UpcomingInvoicePreviewEntry.prototype, "invalidatedAt", void 0);
+exports.UpcomingInvoicePreviewEntry = UpcomingInvoicePreviewEntry = __decorate([
+    (0, interface_database_decorators_1.RegisterTable)(exports.upcomingInvoicePreviewsTableName, constants_1.CORE_SCHEMA_NAME)
+], UpcomingInvoicePreviewEntry);
+//# sourceMappingURL=preview-cache.table.js.map

package/dist/upcoming-invoice/db/preview-cache.table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preview-cache.table.js","sourceRoot":"","sources":["../../../src/upcoming-invoice/db/preview-cache.table.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6FAImD;AACnD,mEAAuE;AAG1D,QAAA,gCAAgC,GAC3C,gCAAgC,CAAC;AAQ5B,IAAM,2BAA2B,GAAjC,MAAM,2BAA4B,SAAQ,qCAAK;CAiBrD,CAAA;AAjBY,kEAA2B;AAE9B;IADP,IAAA,qCAAK,EAAC,QAAQ,CAAC;;wDACI;AAGZ;IADP,IAAA,qCAAK,EAAC,KAAK,CAAC;;4DACkC;AAIvC;IADP,IAAA,qCAAK,EAAC,QAAQ,CAAC;;kEACqB;AAI7B;IADP,IAAA,qCAAK,EAAC,MAAM,CAAC;;+DACkB;AAGxB;IADP,IAAA,qCAAK,EAAC,MAAM,CAAC;;kEACqB;sCAhBxB,2BAA2B;IADvC,IAAA,6CAAa,EAAC,wCAAgC,EAAE,4BAAgB,CAAC;GACrD,2BAA2B,CAiBvC"}

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

@@ -0,0 +1,17 @@
+import type { Plan, TenantSubscription } from "../db";
+import { type PreviewOutcome } from "./outcomes";
+export interface PreviewableSubscription {
+    subscription: TenantSubscription;
+    customerId: string;
+    subscriptionId: string;
+}
+export interface PreviewableEligibility {
+    isPreviewable: true;
+    target: PreviewableSubscription;
+}
+export interface SettledEligibility {
+    isPreviewable: false;
+    outcome: PreviewOutcome;
+}
+export type PreviewEligibility = PreviewableEligibility | SettledEligibility;
+export declare function resolvePreviewEligibility(subscription: TenantSubscription | undefined, plan: Plan | undefined): PreviewEligibility;

package/dist/upcoming-invoice/eligibility.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePreviewEligibility = resolvePreviewEligibility;
+const client_1 = require("../stripe/client");
+const complimentary_1 = require("../workspaces/complimentary");
+const free_workspace_guard_1 = require("../workspaces/free-workspace-guard");
+const outcomes_1 = require("./outcomes");
+const ELIGIBILITY_RULES = [
+    {
+        outcome: (0, outcomes_1.absent)("complimentary"),
+        applies: (subscription) => (0, complimentary_1.isComplimentarySubscription)(subscription),
+    },
+    {
+        outcome: (0, outcomes_1.absent)("subscription_not_configured"),
+        applies: (_subscription, plan) => !plan,
+    },
+    {
+        outcome: (0, outcomes_1.absent)("free_plan"),
+        applies: (_subscription, plan) => !!plan && (0, free_workspace_guard_1.isFreePlan)(plan),
+    },
+    {
+        outcome: (0, outcomes_1.absent)("customer_not_configured"),
+        applies: (subscription) => !subscription.stripeCustomerId,
+    },
+];
+function toPreviewable(subscription) {
+    const { stripeCustomerId, stripeSubscriptionId } = subscription;
+    if (!stripeCustomerId || !stripeSubscriptionId)
+        return null;
+    return {
+        subscription,
+        customerId: stripeCustomerId,
+        subscriptionId: stripeSubscriptionId,
+    };
+}
+function settled(outcome) {
+    return { isPreviewable: false, outcome };
+}
+function resolvePreviewEligibility(subscription, plan) {
+    if (!subscription)
+        return settled((0, outcomes_1.absent)("subscription_not_configured"));
+    const rule = ELIGIBILITY_RULES.find((candidate) => candidate.applies(subscription, plan));
+    if (rule)
+        return settled(rule.outcome);
+    const target = toPreviewable(subscription);
+    if (!target)
+        return settled((0, outcomes_1.absent)("subscription_not_configured"));
+    if (!(0, client_1.isStripeConfigured)())
+        return settled((0, outcomes_1.unavailable)("stripe_not_configured"));
+    return { isPreviewable: true, target };
+}
+//# sourceMappingURL=eligibility.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eligibility.js","sourceRoot":"","sources":["../../src/upcoming-invoice/eligibility.ts"],"names":[],"mappings":";;AA6EA,8DAcC;AA1FD,6CAAsD;AACtD,+DAA0E;AAC1E,6EAAgE;AAChE,yCAAsE;AAkCtE,MAAM,iBAAiB,GAAsB;IAC3C;QACE,OAAO,EAAE,IAAA,iBAAM,EAAC,eAAe,CAAC;QAChC,OAAO,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,IAAA,2CAA2B,EAAC,YAAY,CAAC;KACrE;IACD;QACE,OAAO,EAAE,IAAA,iBAAM,EAAC,6BAA6B,CAAC;QAC9C,OAAO,EAAE,CAAC,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI;KACxC;IACD;QACE,OAAO,EAAE,IAAA,iBAAM,EAAC,WAAW,CAAC;QAC5B,OAAO,EAAE,CAAC,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAA,iCAAU,EAAC,IAAI,CAAC;KAC7D;IACD;QACE,OAAO,EAAE,IAAA,iBAAM,EAAC,yBAAyB,CAAC;QAC1C,OAAO,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,gBAAgB;KAC1D;CACF,CAAC;AAEF,SAAS,aAAa,CACpB,YAAgC;IAEhC,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,GAAG,YAAY,CAAC;IAChE,IAAI,CAAC,gBAAgB,IAAI,CAAC,oBAAoB;QAAE,OAAO,IAAI,CAAC;IAC5D,OAAO;QACL,YAAY;QACZ,UAAU,EAAE,gBAAgB;QAC5B,cAAc,EAAE,oBAAoB;KACrC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAAuB;IACtC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC3C,CAAC;AAMD,SAAgB,yBAAyB,CACvC,YAA4C,EAC5C,IAAsB;IAEtB,IAAI,CAAC,YAAY;QAAE,OAAO,OAAO,CAAC,IAAA,iBAAM,EAAC,6BAA6B,CAAC,CAAC,CAAC;IACzE,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAChD,SAAS,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CACtC,CAAC;IACF,IAAI,IAAI;QAAE,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAC3C,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC,IAAA,iBAAM,EAAC,6BAA6B,CAAC,CAAC,CAAC;IACnE,IAAI,CAAC,IAAA,2BAAkB,GAAE;QACvB,OAAO,OAAO,CAAC,IAAA,sBAAW,EAAC,uBAAuB,CAAC,CAAC,CAAC;IACvD,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACzC,CAAC"}

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

@@ -0,0 +1,2 @@
+import type Stripe from "stripe";
+export declare function invalidatePreviewForStripeEvent(event: Stripe.Event): Promise<void>;

package/dist/upcoming-invoice/invalidation.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invalidatePreviewForStripeEvent = invalidatePreviewForStripeEvent;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const webhook_shared_1 = require("../stripe/webhook-shared");
+const preview_1 = require("./preview");
+const LOG_PREFIX = "[dms-saas:upcoming-invoice]";
+const CUSTOMER_OBJECT = "customer";
+const INVALIDATING_EVENT_TYPES = new Set([
+    "invoice.created",
+    "invoice.finalized",
+    "invoice.paid",
+    "invoice.voided",
+    "customer.updated",
+    "customer.subscription.updated",
+    "customer.subscription.deleted",
+]);
+function eventCustomerId(event) {
+    const object = event.data.object;
+    if (object.object === CUSTOMER_OBJECT)
+        return object.id ?? null;
+    return (0, webhook_shared_1.asCustomerId)(object.customer);
+}
+async function invalidatePreviewForStripeEvent(event) {
+    if (!INVALIDATING_EVENT_TYPES.has(event.type))
+        return;
+    const customerId = eventCustomerId(event);
+    if (!customerId)
+        return;
+    try {
+        const tenant = await (0, webhook_shared_1.findTenantByCustomerId)(customerId);
+        if (tenant)
+            await (0, preview_1.invalidateUpcomingInvoicePreview)(tenant._id);
+    }
+    catch (error) {
+        logging_1.Logging.Error(`${LOG_PREFIX} could not invalidate the preview after ${event.type} ${event.id}`, error);
+    }
+}
+//# sourceMappingURL=invalidation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"invalidation.js","sourceRoot":"","sources":["../../src/upcoming-invoice/invalidation.ts"],"names":[],"mappings":";;AAyCA,0EAeC;AAxDD,gEAA6D;AAE7D,6DAAgF;AAChF,uCAA6D;AAE7D,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,eAAe,GAAG,UAAU,CAAC;AAQnC,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAS;IAC/C,iBAAiB;IACjB,mBAAmB;IACnB,cAAc;IACd,gBAAgB;IAChB,kBAAkB;IAClB,+BAA+B;IAC/B,+BAA+B;CAChC,CAAC,CAAC;AAQH,SAAS,eAAe,CAAC,KAAmB;IAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAA6B,CAAC;IACxD,IAAI,MAAM,CAAC,MAAM,KAAK,eAAe;QAAE,OAAO,MAAM,CAAC,EAAE,IAAI,IAAI,CAAC;IAChE,OAAO,IAAA,6BAAY,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAOM,KAAK,UAAU,+BAA+B,CACnD,KAAmB;IAEnB,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO;IACtD,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,CAAC,UAAU;QAAE,OAAO;IACxB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAA,uCAAsB,EAAC,UAAU,CAAC,CAAC;QACxD,IAAI,MAAM;YAAE,MAAM,IAAA,0CAAgC,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,KAAK,CACX,GAAG,UAAU,2CAA2C,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE,EAChF,KAAK,CACN,CAAC;IACJ,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,8 @@
+import type { AvailableUpcomingInvoicePreview } from "@antelopejs/interface-dms-saas/billing";
+import type Stripe from "stripe";
+export interface PreviewPricingContext {
+    billingDate: Date;
+    usageThrough: Date | null;
+    computedAt: Date;
+}
+export declare function toAvailablePreview(invoice: Stripe.Invoice, pricing: PreviewPricingContext): AvailableUpcomingInvoicePreview;

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/utils/invoice-lines-type.d.ts

@@ -10,8 +10,8 @@ export declare class InvoiceLinesType extends DataType {
         periodStart: z.ZodNullable<z.ZodDate>;
         periodEnd: z.ZodNullable<z.ZodDate>;
     }, "strip", z.ZodTypeAny, {
-        currency: string;
         description: string;
+        currency: string;
         amount: number;
         periodStart: Date | null;
         periodEnd: Date | null;

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;