@voltro/plugin-billing 0.85.0 → 0.86.0

package/dist/dunning.js

@@ -0,0 +1,209 @@
+import { BillingError as e, DEFAULT_PLAN as t } from "./types.js";
+import { Effect as n } from "effect";
+import { and as r, eq as i, id as a, table as o, text as s, timestamp as c } from "@voltro/database";
+//#region src/dunning.ts
+var l = "_voltro_billing_dunning_notices", u = o(l, {
+	id: a({ prefix: "bdun" }),
+	tenantId: s().maxLength(191),
+	episode: s().maxLength(32),
+	stepId: s().maxLength(64),
+	sentAt: c()
+}).unique("byBillingDunningNotice", [
+	"tenantId",
+	"episode",
+	"stepId"
+]), d = "locked", f = [
+	{
+		id: "payment-failed",
+		afterHours: 0
+	},
+	{
+		id: "reminder",
+		afterHours: 72
+	},
+	{
+		id: "final-warning",
+		afterHours: 144
+	}
+], p = 168, m = "hard", h = (e, t, n) => {
+	if (e === void 0 || e.trim() === "") return t;
+	let r = Number(e);
+	if (!Number.isFinite(r) || r < 0) throw Error(`billingPlugin: ${n} must be a non-negative number, got '${e}'`);
+	return r;
+}, g = (e, t) => {
+	let n = t.VOLTRO_BILLING_DUNNING;
+	if (n !== void 0 && n !== "" && n !== "on" && n !== "off") throw Error(`billingPlugin: VOLTRO_BILLING_DUNNING must be 'on' or 'off', got '${n}'`);
+	let r = n === "off" ? !1 : n === "on" ? !0 : e?.enabled ?? !0, i = t.VOLTRO_BILLING_LOCKOUT;
+	if (i !== void 0 && i !== "" && i !== "hard" && i !== "soft") throw Error(`billingPlugin: VOLTRO_BILLING_LOCKOUT must be 'hard' or 'soft', got '${i}'`);
+	let a = i === "hard" || i === "soft" ? i : e?.lockout ?? "hard", o = h(t.VOLTRO_BILLING_GRACE_HOURS, e?.graceHours ?? 168, "VOLTRO_BILLING_GRACE_HOURS"), s = e?.steps ?? f, c = t.VOLTRO_BILLING_DUNNING_STEP_HOURS, l = s;
+	if (c !== void 0 && c.trim() !== "") {
+		let e = c.split(",").map((e) => e.trim());
+		if (e.length !== s.length) throw Error(`billingPlugin: VOLTRO_BILLING_DUNNING_STEP_HOURS lists ${e.length} value(s) but the sequence declares ${s.length} step(s) (${s.map((e) => e.id).join(", ")})`);
+		l = s.map((t, n) => ({
+			id: t.id,
+			afterHours: h(e[n], t.afterHours, "VOLTRO_BILLING_DUNNING_STEP_HOURS")
+		}));
+	}
+	let u = /* @__PURE__ */ new Set();
+	for (let e of l) {
+		if (e.id === "locked") throw Error(`billingPlugin: '${d}' is the reserved lockout step id`);
+		if (u.has(e.id)) throw Error(`billingPlugin: duplicate dunning step id '${e.id}'`);
+		u.add(e.id);
+	}
+	return {
+		enabled: r,
+		graceHours: o,
+		lockout: a,
+		steps: [...l].sort((e, t) => e.afterHours - t.afterHours),
+		...e?.notify === void 0 ? {} : { notify: e.notify },
+		...e?.resolveRecipient === void 0 ? {} : { resolveRecipient: e.resolveRecipient },
+		...e?.portalReturnUrl === void 0 ? {} : { portalReturnUrl: e.portalReturnUrl }
+	};
+}, _ = 36e5, v = (e) => String(e.getTime()), y = (e, t) => new Date(e.getTime() + t * _), b = (e, t, n) => {
+	let r = (n.getTime() - t.getTime()) / _;
+	return e.filter((e) => r >= e.afterHours);
+}, x = (e, n, r, i) => {
+	let a = {
+		tenantId: e?.tenantId ?? i ?? "",
+		lockout: n.lockout
+	};
+	if (e === null) return {
+		...a,
+		plan: t,
+		billedPlan: t,
+		status: "none",
+		entitled: !0,
+		inGrace: !1,
+		graceEndsAt: null,
+		lockedSince: null
+	};
+	if (e.status === "active" || e.status === "trialing") return {
+		...a,
+		plan: e.plan,
+		billedPlan: e.plan,
+		status: e.status,
+		entitled: !0,
+		inGrace: !1,
+		graceEndsAt: null,
+		lockedSince: null
+	};
+	if (e.status === "pastDue") {
+		if (!n.enabled) return {
+			...a,
+			plan: t,
+			billedPlan: e.plan,
+			status: e.status,
+			entitled: !0,
+			inGrace: !1,
+			graceEndsAt: null,
+			lockedSince: null
+		};
+		if (e.pastDueSince === null) return {
+			...a,
+			plan: e.plan,
+			billedPlan: e.plan,
+			status: e.status,
+			entitled: !0,
+			inGrace: !0,
+			graceEndsAt: null,
+			lockedSince: null
+		};
+		let i = y(e.pastDueSince, n.graceHours), o = r.getTime() >= i.getTime();
+		return {
+			...a,
+			plan: o && n.lockout === "hard" ? t : e.plan,
+			billedPlan: e.plan,
+			status: e.status,
+			entitled: !o,
+			inGrace: !o,
+			graceEndsAt: i,
+			lockedSince: o ? i : null
+		};
+	}
+	return {
+		...a,
+		plan: t,
+		billedPlan: e.plan,
+		status: e.status,
+		entitled: !0,
+		inGrace: !1,
+		graceEndsAt: null,
+		lockedSince: null
+	};
+}, S = (e) => e.toISOString().slice(0, 10), C = (e) => {
+	let t = e.portalUrl, n = t === null ? "<p>Please update your payment method in the billing settings.</p>" : `<p><a href="${t}">Update your payment method</a></p>`, r = t === null ? "Please update your payment method in the billing settings." : `Update your payment method: ${t}`;
+	if (e.locked) return {
+		subject: "Your subscription has been suspended",
+		html: `<p>We were unable to collect payment, and your subscription is now suspended.</p>${n}`,
+		text: `We were unable to collect payment, and your subscription is now suspended.\n\n${r}`
+	};
+	let i = S(e.graceEndsAt), a = e.stepId === "payment-failed" ? "Your last payment could not be collected." : "Your payment is still outstanding.";
+	return {
+		subject: "Action needed: your payment could not be collected",
+		html: `<p>${a} Your subscription stays active until ${i}.</p>${n}`,
+		text: `${a} Your subscription stays active until ${i}.\n\n${r}`
+	};
+}, w = (e) => (t) => t.to === null ? n.void : e.send({
+	to: t.to,
+	subject: t.subject,
+	html: t.html,
+	text: t.text
+}).pipe(n.asVoid), T = (e, t, n) => `${e}\u0000${t}\u0000${n}`, E = () => {
+	let e = /* @__PURE__ */ new Map();
+	return {
+		claim: (t, r, i, a) => n.sync(() => {
+			let n = T(t, r, i);
+			return !e.has(n) && (e.set(n, {
+				tenantId: t,
+				episode: r,
+				stepId: i,
+				sentAt: a
+			}), !0);
+		}),
+		sentSteps: (t, r) => n.sync(() => [...e.values()].filter((e) => e.tenantId === t && e.episode === r))
+	};
+}, D = () => `bdun_${Math.random().toString(36).slice(2)}${Date.now().toString(36)}`, O = (t) => ({
+	claim: (r, i, a, o) => n.tryPromise({
+		try: async () => {
+			let e = D(), n = await t.insertIgnore(l, {
+				id: e,
+				tenantId: r,
+				episode: i,
+				stepId: a,
+				sentAt: o
+			}, { conflictColumns: [
+				"tenantId",
+				"episode",
+				"stepId"
+			] });
+			return String(n.id) === e;
+		},
+		catch: (t) => new e({
+			source: "dunningNoticeStore",
+			message: String(t?.message ?? t),
+			transient: !0
+		})
+	}),
+	sentSteps: (a, o) => n.tryPromise({
+		try: async () => (await t.query({
+			table: l,
+			predicate: r(i("tenantId", a), i("episode", o)),
+			order: [],
+			take: void 0,
+			skip: void 0,
+			projection: void 0
+		})).map((e) => ({
+			tenantId: String(e.tenantId),
+			episode: String(e.episode),
+			stepId: String(e.stepId),
+			sentAt: e.sentAt == null ? null : new Date(e.sentAt)
+		})),
+		catch: (t) => new e({
+			source: "dunningNoticeStore",
+			message: String(t?.message ?? t),
+			transient: !0
+		})
+	})
+});
+//#endregion
+export { l as BILLING_DUNNING_NOTICES_TABLE, f as DEFAULT_DUNNING_STEPS, p as DEFAULT_GRACE_HOURS, m as DEFAULT_LOCKOUT, d as DUNNING_LOCK_STEP_ID, u as billingDunningNoticesTable, O as dataStoreDunningNoticeStore, C as defaultDunningEmail, b as dueSteps, w as dunningMailNotifier, v as episodeKeyOf, x as evaluateBillingEntitlement, y as graceEndOf, E as memoryDunningNoticeStore, g as resolveDunningConfig };

package/dist/entitlement.js

@@ -0,0 +1,41 @@
+import { BillingService as e, EntitlementExceeded as t, SubscriptionLocked as n } from "./types.js";
+import { Effect as r } from "effect";
+//#region src/entitlement.ts
+var i = (e, t, n, r) => ({
+	allowed: !Number.isFinite(t) || r <= 0 || n + r <= t,
+	entitlement: e,
+	limit: t,
+	used: n,
+	cost: r
+}), a = (e) => e.tenantId, o = (n, i, o) => r.gen(function* () {
+	let s = a(n.request.subject);
+	if (s === null) return o <= 0 ? void 0 : yield* r.fail(new t({
+		entitlement: i,
+		limit: 0,
+		used: 0,
+		cost: o
+	}));
+	yield* (yield* e).consumeEntitlement(s, i, o);
+}), s = (t) => r.gen(function* () {
+	let i = a(t.request.subject);
+	if (i === null) return;
+	let o = yield* (yield* e).entitlementStatus(i);
+	if (!o.entitled) return yield* r.fail(new n({
+		tenantId: i,
+		status: o.status,
+		lockedSince: (o.lockedSince ?? /* @__PURE__ */ new Date()).toISOString(),
+		lockout: o.lockout
+	}));
+}), c = (e, n) => (i, a) => {
+	let o = e[a.tag];
+	if (o === void 0) return i;
+	let s = o.cost ?? 1, c = a.subject.tenantId;
+	return c === null ? s <= 0 ? i : r.fail(new t({
+		entitlement: o.entitlement,
+		limit: 0,
+		used: 0,
+		cost: s
+	})) : r.flatMap(n.consumeEntitlement(c, o.entitlement, s), () => i);
+};
+//#endregion
+export { c as buildEnforceInterceptor, i as evaluateEntitlement, s as requireEntitled, o as requireEntitlement };

package/dist/flushClaim.js

@@ -0,0 +1,20 @@
+import { id as e, table as t, text as n, timestamp as r } from "@voltro/database";
+//#region src/flushClaim.ts
+var i = "_voltro_billing_flush_claims", a = t(i, {
+	id: e({ scheme: "numeric" }),
+	windowKey: n(),
+	claimedBy: n(),
+	claimedAt: r().default("now")
+}).unique("billingFlushClaimWindow", ["windowKey"]), o = (e, t) => `billing-flush:${Math.floor(e / Math.max(1, t))}`, s = async (e, t, n, r) => {
+	try {
+		return (await e.insertIgnore(i, {
+			windowKey: t,
+			claimedBy: n,
+			claimedAt: new Date(r)
+		}, { conflictColumns: ["windowKey"] })).claimedBy === n;
+	} catch {
+		return !0;
+	}
+};
+//#endregion
+export { i as BILLING_FLUSH_CLAIMS_TABLE, a as billingFlushClaimsTable, s as claimFlushWindow, o as flushWindowKey };