feat(WHE-20): implement deterministic monthly settlement engine

This commit is contained in:
2026-03-05 04:04:07 +04:00
parent 64c7d41ba9
commit 40c2313f1f
8 changed files with 453 additions and 2 deletions

View File

@@ -0,0 +1,153 @@
import { describe, expect, test } from 'bun:test'
import {
BillingCycleId,
BillingPeriod,
DomainError,
MemberId,
Money,
PurchaseEntryId
} from '@household/domain'
import { calculateMonthlySettlement } from './settlement-engine'
function fixtureBase() {
return {
cycleId: BillingCycleId.from('cycle-2026-03'),
period: BillingPeriod.fromString('2026-03'),
rent: Money.fromMajor('700.00', 'USD'),
utilities: Money.fromMajor('120.00', 'USD')
}
}
describe('calculateMonthlySettlement', () => {
test('3-member equal split with purchase offsets', () => {
const input = {
...fixtureBase(),
utilitySplitMode: 'equal' as const,
members: [
{ memberId: MemberId.from('alice'), active: true },
{ memberId: MemberId.from('bob'), active: true },
{ memberId: MemberId.from('carol'), active: true }
],
purchases: [
{
purchaseId: PurchaseEntryId.from('p1'),
payerId: MemberId.from('alice'),
amount: Money.fromMajor('30.00', 'USD')
}
]
}
const result = calculateMonthlySettlement(input)
expect(result.lines.map((line) => line.memberId.toString())).toEqual(['alice', 'bob', 'carol'])
expect(result.lines.map((line) => line.rentShare.amountMinor)).toEqual([23334n, 23333n, 23333n])
expect(result.lines.map((line) => line.utilityShare.amountMinor)).toEqual([4000n, 4000n, 4000n])
expect(result.lines.map((line) => line.purchaseOffset.amountMinor)).toEqual([
-2000n,
1000n,
1000n
])
expect(result.lines.map((line) => line.netDue.amountMinor)).toEqual([25334n, 28333n, 28333n])
expect(result.totalDue.amountMinor).toBe(82000n)
})
test('4-member weighted utility split by days', () => {
const input = {
...fixtureBase(),
utilitySplitMode: 'weighted_by_days' as const,
members: [
{ memberId: MemberId.from('a'), active: true, utilityDays: 31 },
{ memberId: MemberId.from('b'), active: true, utilityDays: 31 },
{ memberId: MemberId.from('c'), active: true, utilityDays: 20 },
{ memberId: MemberId.from('d'), active: true, utilityDays: 10 }
],
purchases: []
}
const result = calculateMonthlySettlement(input)
expect(result.lines.map((line) => line.utilityShare.amountMinor)).toEqual([
4044n,
4043n,
2609n,
1304n
])
expect(result.lines.map((line) => line.rentShare.amountMinor)).toEqual([
17500n,
17500n,
17500n,
17500n
])
expect(result.totalDue.amountMinor).toBe(82000n)
})
test('5-member scenario with two purchases remains deterministic', () => {
const input = {
...fixtureBase(),
utilitySplitMode: 'equal' as const,
members: [
{ memberId: MemberId.from('m1'), active: true },
{ memberId: MemberId.from('m2'), active: true },
{ memberId: MemberId.from('m3'), active: true },
{ memberId: MemberId.from('m4'), active: true },
{ memberId: MemberId.from('m5'), active: true }
],
purchases: [
{
purchaseId: PurchaseEntryId.from('p1'),
payerId: MemberId.from('m1'),
amount: Money.fromMajor('25.00', 'USD')
},
{
purchaseId: PurchaseEntryId.from('p2'),
payerId: MemberId.from('m4'),
amount: Money.fromMajor('41.00', 'USD')
}
]
}
const result = calculateMonthlySettlement(input)
expect(result.lines.map((line) => line.netDue.amountMinor)).toEqual([
15220n,
17720n,
17720n,
13620n,
17720n
])
expect(result.totalDue.amountMinor).toBe(82000n)
})
test('throws if weighted split is selected without valid utility days', () => {
const input = {
...fixtureBase(),
utilitySplitMode: 'weighted_by_days' as const,
members: [
{ memberId: MemberId.from('a'), active: true, utilityDays: 31 },
{ memberId: MemberId.from('b'), active: true }
],
purchases: []
}
expect(() => calculateMonthlySettlement(input)).toThrow(DomainError)
})
test('throws if purchase payer is not active', () => {
const input = {
...fixtureBase(),
utilitySplitMode: 'equal' as const,
members: [{ memberId: MemberId.from('a'), active: true }],
purchases: [
{
purchaseId: PurchaseEntryId.from('p1'),
payerId: MemberId.from('ghost'),
amount: Money.fromMajor('10.00', 'USD')
}
]
}
expect(() => calculateMonthlySettlement(input)).toThrow(DomainError)
})
})