@casomoltd/nhs-pay 0.19.4 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +69 -5
  2. package/dist/afc-scales.d.ts +14 -7
  3. package/dist/afc-scales.js +19 -19
  4. package/dist/afc-scales.js.map +1 -1
  5. package/dist/bands.d.ts +2 -2
  6. package/dist/commutation.d.ts +49 -5
  7. package/dist/commutation.js +124 -43
  8. package/dist/commutation.js.map +1 -1
  9. package/dist/dates.d.ts +2 -0
  10. package/dist/dates.js +4 -0
  11. package/dist/dates.js.map +1 -1
  12. package/dist/errors.d.ts +70 -12
  13. package/dist/errors.js +85 -19
  14. package/dist/errors.js.map +1 -1
  15. package/dist/factor-basis.d.ts +87 -0
  16. package/dist/factor-basis.js +99 -0
  17. package/dist/factor-basis.js.map +1 -0
  18. package/dist/gad/erf-1-401-2023-06-30.d.ts +47 -0
  19. package/dist/gad/erf-1-401-2023-06-30.js +73 -0
  20. package/dist/gad/erf-1-401-2023-06-30.js.map +1 -0
  21. package/dist/gad/erf-1-402-2023-06-30.d.ts +48 -0
  22. package/dist/gad/erf-1-402-2023-06-30.js +84 -0
  23. package/dist/gad/erf-1-402-2023-06-30.js.map +1 -0
  24. package/dist/gad/erf-1-407-2023-06-30.d.ts +47 -0
  25. package/dist/gad/erf-1-407-2023-06-30.js +73 -0
  26. package/dist/gad/erf-1-407-2023-06-30.js.map +1 -0
  27. package/dist/gad/erf-2023-06-30.d.ts +3 -0
  28. package/dist/gad/erf-2023-06-30.js +1 -0
  29. package/dist/gad/erf-2023-06-30.js.map +1 -1
  30. package/dist/gad/factor-table.d.ts +62 -31
  31. package/dist/gad/factor-table.js +67 -34
  32. package/dist/gad/factor-table.js.map +1 -1
  33. package/dist/gad/lrf-2-416-2023-06-30.d.ts +46 -0
  34. package/dist/gad/lrf-2-416-2023-06-30.js +72 -0
  35. package/dist/gad/lrf-2-416-2023-06-30.js.map +1 -0
  36. package/dist/gad/lrf-2023-06-30.d.ts +3 -0
  37. package/dist/gad/lrf-2023-06-30.js +1 -0
  38. package/dist/gad/lrf-2023-06-30.js.map +1 -1
  39. package/dist/gad/promotional-scale-2020.d.ts +37 -0
  40. package/dist/gad/promotional-scale-2020.js +38 -0
  41. package/dist/gad/promotional-scale-2020.js.map +1 -0
  42. package/dist/index.d.ts +16 -3
  43. package/dist/index.js +21 -12
  44. package/dist/index.js.map +1 -1
  45. package/dist/iso-date.d.ts +7 -0
  46. package/dist/iso-date.js +11 -0
  47. package/dist/iso-date.js.map +1 -1
  48. package/dist/member-benefits.d.ts +237 -0
  49. package/dist/member-benefits.js +440 -0
  50. package/dist/member-benefits.js.map +1 -0
  51. package/dist/pay-path.d.ts +70 -0
  52. package/dist/pay-path.js +155 -0
  53. package/dist/pay-path.js.map +1 -0
  54. package/dist/pension/curve.d.ts +74 -0
  55. package/dist/pension/curve.js +134 -0
  56. package/dist/pension/curve.js.map +1 -0
  57. package/dist/pension/history.js +3 -3
  58. package/dist/pension/history.js.map +1 -1
  59. package/dist/pension/ledger.d.ts +71 -31
  60. package/dist/pension/ledger.js +41 -6
  61. package/dist/pension/ledger.js.map +1 -1
  62. package/dist/pension/money.d.ts +23 -6
  63. package/dist/pension/money.js +23 -1
  64. package/dist/pension/money.js.map +1 -1
  65. package/dist/pension/uplift.d.ts +23 -0
  66. package/dist/pension/uplift.js +34 -1
  67. package/dist/pension/uplift.js.map +1 -1
  68. package/dist/pension-projection.d.ts +25 -31
  69. package/dist/pension-projection.js +40 -197
  70. package/dist/pension-projection.js.map +1 -1
  71. package/dist/scale-point.d.ts +11 -1
  72. package/dist/scales.d.ts +9 -9
  73. package/dist/scales.js +68 -67
  74. package/dist/scales.js.map +1 -1
  75. package/dist/sections/final-salary.d.ts +97 -0
  76. package/dist/sections/final-salary.js +99 -0
  77. package/dist/sections/final-salary.js.map +1 -0
  78. package/dist/sections/section-1995.d.ts +20 -0
  79. package/dist/sections/section-1995.js +52 -0
  80. package/dist/sections/section-1995.js.map +1 -0
  81. package/dist/sections/section-2008.d.ts +16 -0
  82. package/dist/sections/section-2008.js +44 -0
  83. package/dist/sections/section-2008.js.map +1 -0
  84. package/dist/sections/section-2015.d.ts +43 -0
  85. package/dist/sections/section-2015.js +57 -0
  86. package/dist/sections/section-2015.js.map +1 -0
  87. package/dist/values.d.ts +4 -5
  88. package/dist/values.js +4 -5
  89. package/dist/values.js.map +1 -1
  90. package/package.json +5 -3
@@ -0,0 +1,440 @@
1
+ /**
2
+ * A member's benefits across every section they hold: built once from
3
+ * what the member told us, then asked one question per set of
4
+ * retirement choices.
5
+ *
6
+ * Everything ABOUT the member goes in once, when the owner is built;
7
+ * each method takes only the question. So a caller never assembles the
8
+ * member again per option, and no section, pay path or ledger is a
9
+ * thing it has to build.
10
+ *
11
+ * Rules come in two tiers. Each section's own — denominator, pay
12
+ * measure, pension age, lump sum, factors — belong to that section;
13
+ * the ones a caller reads are the legacy section's, through
14
+ * `MemberBenefits.legacy`. The rules over the whole set live
15
+ * here: which sections a member holds and whether their service is
16
+ * eligible for the McCloud remedy, then, at the drawing, summing every
17
+ * award into one pension and one automatic lump sum and taking cash
18
+ * across that one total.
19
+ */
20
+ import { cashAt, nhsCommutationLimits } from './commutation.js';
21
+ import { BenefitNotModelled, invariant, NOT_MODELLED } from './errors.js';
22
+ import { isoDate, isoDateOf, isoToDate } from './iso-date.js';
23
+ import { normalPensionAge } from './npa.js';
24
+ import { buildPayPath } from './pay-path.js';
25
+ import { earliest } from './dates.js';
26
+ import { buildCurve, walkThrough } from './pension/curve.js';
27
+ import { seedFromBalanceAt } from './pension/uplift.js';
28
+ import { estimateHistory } from './pension/history.js';
29
+ import { moneyAt, sumMoney } from './pension/money.js';
30
+ import { createPrices } from './pension/prices.js';
31
+ import { schemeYearEndDate, schemeYearEndFor, seedFromJoinDate, } from './pension/seed.js';
32
+ import { finalSalaryBenefit, unreducedPension, } from './sections/final-salary.js';
33
+ import { RULES_1995 } from './sections/section-1995.js';
34
+ import { RULES_2008 } from './sections/section-2008.js';
35
+ import { careerAverage } from './sections/section-2015.js';
36
+ import { npaDate } from './dates.js';
37
+ // ── Vocabulary ──────────────────────────────────────
38
+ /**
39
+ * One scheme, the NHS Pension Scheme, in three sections. "Scheme" only
40
+ * ever means the whole; each part is a section, as a member's own
41
+ * Annual Benefit Statement prints it.
42
+ */
43
+ export const SECTIONS = {
44
+ s1995: 'section-1995',
45
+ s2008: 'section-2008',
46
+ s2015: 'section-2015',
47
+ };
48
+ /**
49
+ * How the remedy window is valued, for a member who has one: as more
50
+ * service in their legacy section, or under the 2015 Section's rules
51
+ * while still paid from the legacy section. There is no default and no
52
+ * preferred answer: which pays more depends on the choices a caller
53
+ * compares, and the library cannot see them.
54
+ */
55
+ export const REMEDY_BASES = {
56
+ none: 'none',
57
+ legacy: 'legacy-basis',
58
+ section2015: 'section-2015-basis',
59
+ };
60
+ // ── What the library answers with ───────────────────
61
+ /** What a period is: service in its own right, or the McCloud remedy
62
+ * window, held in the legacy section and valued on either basis. */
63
+ export const PERIOD_KINDS = {
64
+ ordinary: 'ordinary',
65
+ remedyWindow: 'remedy-window',
66
+ };
67
+ /** How a section accrues: on final salary, or on a career average. */
68
+ export const ACCRUALS = {
69
+ finalSalary: 'final-salary',
70
+ careerAverage: 'career-average',
71
+ };
72
+ /** A legacy section's rules, as `MemberBenefits.legacy` states them. */
73
+ function legacyOf(section) {
74
+ const rules = RULES[section];
75
+ return {
76
+ section,
77
+ pensionAge: rules.pensionAge,
78
+ denominator: rules.denominator,
79
+ automaticLumpSum: rules.automaticLumpSum?.multiple ?? null,
80
+ lateUplift: rules.lateUplift,
81
+ };
82
+ }
83
+ // ── The service, checked ────────────────────────────
84
+ /** The remedy period, 1 April 2015 to 31 March 2022, as PSPJOA 2022
85
+ * s.1 defines it. The days either side are derived from it. */
86
+ const REMEDY_FROM = isoDate('2015-04-01');
87
+ const REMEDY_TO = isoDate('2022-03-31');
88
+ /** PSPJOA 2022 s.1: in pensionable service "on 31 March 2012 or any
89
+ * earlier day". */
90
+ const ELIGIBLE_BY = isoDate('2012-03-31');
91
+ /** Rollback put remedy service back in the legacy section on this
92
+ * date (SI 2023/985), so a statement before it counts the remedy
93
+ * years in the 2015 Section. */
94
+ const ROLLBACK = isoDate('2023-10-01');
95
+ /**
96
+ * The dates the McCloud remedy turns on, for a caller that has to read
97
+ * a member's answers against them before it can declare their service.
98
+ */
99
+ export const REMEDY = {
100
+ eligibleBy: ELIGIBLE_BY,
101
+ from: REMEDY_FROM,
102
+ to: REMEDY_TO,
103
+ rollback: ROLLBACK,
104
+ };
105
+ /**
106
+ * The day each later section opened: the 2008 Section to new joiners
107
+ * under SI 2008/653, and the 2015 Section, which every member moved to
108
+ * for service from that day, under SI 2015/94. The 1995 Section is
109
+ * absent: no answer a member gives turns on its opening.
110
+ */
111
+ export const SECTION_OPENED = {
112
+ [SECTIONS.s2008]: isoDate('2008-04-01'),
113
+ [SECTIONS.s2015]: REMEDY_FROM,
114
+ };
115
+ const on = (d) => isoToDate(d);
116
+ const daysFrom = (d, days) => {
117
+ const date = on(d);
118
+ return new Date(date.getFullYear(), date.getMonth(), date.getDate() + days);
119
+ };
120
+ const dayAfter = (d) => daysFrom(d, 1);
121
+ const LAST_BEFORE_2015 = isoDateOf(daysFrom(REMEDY_FROM, -1));
122
+ const AFTER_REMEDY = isoDateOf(dayAfter(REMEDY_TO));
123
+ /** The last day a period is valued to: its own end, or the leaving
124
+ * date where that comes first or the period is still open. */
125
+ const until = (p, leaving) => p.to === null || on(p.to) > leaving ? leaving : on(p.to);
126
+ const isLegacy = (section) => section !== SECTIONS.s2015;
127
+ /**
128
+ * The periods a member holds, derived from what they declared and
129
+ * refused where it describes something the library does not model.
130
+ *
131
+ * Service is taken as continuous. A break — a gap between one period
132
+ * and the next — decides whether remedy service qualifies, and how a
133
+ * member comes to hold both legacy sections; both are deferred, so a
134
+ * declared break is refused rather than priced as though it were
135
+ * continuous: https://github.com/casomoltd/nhs-pay/issues/16
136
+ *
137
+ * A member with no 2015 Section service after rollback is refused
138
+ * too: https://github.com/casomoltd/nhs-pay/issues/19
139
+ *
140
+ * A declaration that cannot be true — nothing declared, leaving
141
+ * before joining, periods that overlap — is a caller's mistake and
142
+ * throws RangeError.
143
+ */
144
+ function servicePeriods(declared) {
145
+ if (declared.length === 0) {
146
+ throw new RangeError('member: no service declared');
147
+ }
148
+ const sorted = [...declared].sort((a, b) => on(a.joined).getTime() - on(b.joined).getTime());
149
+ sorted.forEach((p, i) => {
150
+ if (p.left !== null && on(p.left) < on(p.joined)) {
151
+ throw new RangeError(`member: ${p.section} left before it was joined`);
152
+ }
153
+ const next = sorted.at(i + 1);
154
+ if (next === undefined)
155
+ return;
156
+ if (p.left === null || on(next.joined) <= on(p.left)) {
157
+ throw new RangeError(`member: ${p.section} overlaps the next period`);
158
+ }
159
+ if (dayAfter(p.left).getTime() !== on(next.joined).getTime()) {
160
+ throw new BenefitNotModelled(NOT_MODELLED.breakInService, 'a break in pensionable service');
161
+ }
162
+ });
163
+ const legacyDeclared = sorted.filter((p) => isLegacy(p.section));
164
+ const reformed = sorted.filter((p) => p.section === SECTIONS.s2015);
165
+ if (legacyDeclared.length > 1) {
166
+ throw new BenefitNotModelled(NOT_MODELLED.bothLegacySections, 'service in both legacy sections');
167
+ }
168
+ const current = reformed.at(0);
169
+ if (current === undefined || reformed.length > 1) {
170
+ throw new BenefitNotModelled(NOT_MODELLED.no2015Section, 'service without the 2015 Section');
171
+ }
172
+ const held = legacyDeclared.at(0);
173
+ const end = current.left;
174
+ const remedy = held !== undefined
175
+ && on(held.joined) <= on(ELIGIBLE_BY)
176
+ && (end === null || on(end) >= on(REMEDY_FROM));
177
+ if (remedy && end !== null && on(end) <= on(REMEDY_TO)) {
178
+ throw new BenefitNotModelled(NOT_MODELLED.remedyMemberLeftEarly, 'a remedy member who left before 1 April 2022');
179
+ }
180
+ let legacy = null;
181
+ if (held !== undefined && isLegacy(held.section)) {
182
+ // A legacy period before a 2015 one has a leaving date: the
183
+ // contiguity check above refused an open one.
184
+ invariant(held.left !== null, 'a legacy period with no end');
185
+ const own = {
186
+ section: held.section,
187
+ from: held.joined,
188
+ to: remedy ? LAST_BEFORE_2015 : held.left,
189
+ kind: PERIOD_KINDS.ordinary,
190
+ };
191
+ legacy = {
192
+ section: held.section,
193
+ periods: remedy
194
+ ? [own, {
195
+ section: held.section, from: REMEDY_FROM, to: REMEDY_TO,
196
+ kind: PERIOD_KINDS.remedyWindow,
197
+ }]
198
+ : [own],
199
+ };
200
+ }
201
+ const periods = [
202
+ ...(legacy?.periods ?? []),
203
+ {
204
+ section: SECTIONS.s2015,
205
+ from: remedy ? AFTER_REMEDY : current.joined,
206
+ to: end,
207
+ kind: PERIOD_KINDS.ordinary,
208
+ },
209
+ ];
210
+ return { periods, legacy };
211
+ }
212
+ // ── The owner ───────────────────────────────────────
213
+ const RULES = {
214
+ [SECTIONS.s1995]: RULES_1995,
215
+ [SECTIONS.s2008]: RULES_2008,
216
+ };
217
+ /** A career average walk over `window`, accruing only inside it. */
218
+ function walk(b, window, seed, { leaving, drawing }, prices) {
219
+ const first = schemeYearEndFor(on(window.from));
220
+ const last = schemeYearEndFor(until(window, leaving));
221
+ return careerAverage({
222
+ seed,
223
+ payIn: (year) => (year >= first && year <= last
224
+ ? b.payPath.payFor(year)
225
+ : null),
226
+ dateOfBirth: b.born,
227
+ leaving,
228
+ drawing,
229
+ prices,
230
+ through: walkThrough(drawing, b.npaOn),
231
+ });
232
+ }
233
+ /** The 2015 Section's own seed: its statement, or its first day. */
234
+ function seed2015(b, { leaving, drawing }, prices) {
235
+ const { statement } = b.member;
236
+ return statement === null
237
+ ? seedFromJoinDate(on(b.ordinary2015.from))
238
+ : seedFromBalanceAt(statement.accruedPension, on(statement.asAt), leaving, drawing, prices);
239
+ }
240
+ /** The legacy windows as final-salary membership, to `leaving`. */
241
+ const membershipOf = (valued, leaving) => valued
242
+ .filter((p) => on(p.from) <= leaving)
243
+ .map((p) => ({ from: on(p.from), to: until(p, leaving) }));
244
+ /** What the member holds today, with the remedy window on the legacy
245
+ * basis: unreduced, since nothing is drawn. */
246
+ function holdings(b) {
247
+ const { today } = b;
248
+ const bySection = [];
249
+ const flat = (x) => moneyAt({ nominal: x, real: x }, today);
250
+ if (b.legacy !== null) {
251
+ const { pension, automaticLumpSum } = unreducedPension(RULES[b.legacy.section], membershipOf(b.legacy.periods, today), b.payPath, schemeYearEndFor(today));
252
+ bySection.push({
253
+ section: b.legacy.section,
254
+ pension: flat(pension),
255
+ automaticLumpSum: flat(automaticLumpSum),
256
+ });
257
+ }
258
+ // Any leaving and drawing after today give the same balance today;
259
+ // these are only where the walk has to stop.
260
+ const leaving = b.ordinary2015.to === null
261
+ ? b.npaOn
262
+ : on(b.ordinary2015.to);
263
+ const dates = { leaving, drawing: leaving < b.npaOn ? b.npaOn : leaving };
264
+ const accrued = walk(b, b.ordinary2015, seed2015(b, dates, b.todaysPrices), dates, b.todaysPrices).ledger.accruedAt(today);
265
+ bySection.push({
266
+ section: SECTIONS.s2015,
267
+ pension: flat(accrued),
268
+ automaticLumpSum: flat(0),
269
+ });
270
+ return {
271
+ bySection, total: sumMoney(bySection.map((x) => x.pension), today),
272
+ };
273
+ }
274
+ /** Refuse choices that cannot be valued, and return their dates. */
275
+ function checked(b, remedy, choices) {
276
+ const leaving = on(choices.leaving);
277
+ const drawing = on(choices.drawing);
278
+ if (drawing < leaving) {
279
+ throw new RangeError('at: drawn before leaving');
280
+ }
281
+ if (b.ordinary2015.to !== null && on(b.ordinary2015.to) < leaving) {
282
+ throw new RangeError(`at: leaving after the member already left, on ${b.ordinary2015.to}`);
283
+ }
284
+ if (remedy !== (choices.remedy.kind !== REMEDY_BASES.none)) {
285
+ throw new RangeError(remedy
286
+ ? 'at: a remedy member needs an election'
287
+ : 'at: an election for a member with no remediable service');
288
+ }
289
+ return { leaving, drawing };
290
+ }
291
+ /** The legacy section's final-salary award over the periods valued on
292
+ * final salary, which the election decides. */
293
+ function legacyAward(b, legacy, valued, dates) {
294
+ const rules = RULES[legacy.section];
295
+ const benefit = finalSalaryBenefit(rules, {
296
+ windows: membershipOf(valued, dates.leaving),
297
+ payPath: b.payPath, dateOfBirth: b.born, ...dates,
298
+ prices: b.cashPrices,
299
+ });
300
+ return {
301
+ section: legacy.section,
302
+ periods: valued,
303
+ beforeFactor: benefit.beforeFactor,
304
+ pension: benefit.pension,
305
+ automaticLumpSum: benefit.automaticLumpSum,
306
+ factor: benefit.factor,
307
+ ledgers: null,
308
+ provenance: {
309
+ accrual: ACCRUALS.finalSalary,
310
+ denominator: rules.denominator,
311
+ payMeasure: rules.payMeasure,
312
+ membership: benefit.membership,
313
+ finalPay: benefit.finalPay,
314
+ },
315
+ };
316
+ }
317
+ /** A career average award over one window, walked in both rulers. */
318
+ function careerAward(b, section, window, seedFor, dates) {
319
+ const cash = walk(b, window, seedFor(b.cashPrices), dates, b.cashPrices);
320
+ const todays = walk(b, window, seedFor(b.todaysPrices), dates, b.todaysPrices);
321
+ return {
322
+ award: {
323
+ section,
324
+ periods: [window],
325
+ beforeFactor: moneyAt({ nominal: cash.revalued, real: todays.revalued }, dates.drawing),
326
+ pension: moneyAt({ nominal: cash.drawn, real: todays.drawn }, dates.drawing),
327
+ automaticLumpSum: moneyAt({ nominal: 0, real: 0 }, dates.drawing),
328
+ factor: cash.factor,
329
+ ledgers: { cash: cash.ledger, todaysMoney: todays.ledger },
330
+ provenance: { accrual: ACCRUALS.careerAverage },
331
+ },
332
+ cash,
333
+ todays,
334
+ };
335
+ }
336
+ /** The 2015 Section's balance, with its estimated run-up before a
337
+ * statement, as the ledgers, history and curve a `Position` carries. */
338
+ function section2015(b, own, { leaving, drawing }) {
339
+ const historyIn = (r, prices) => b.member.statement === null
340
+ ? null
341
+ : estimateHistory({
342
+ joinDate: on(b.ordinary2015.from),
343
+ statedBalance: r.seed.opening,
344
+ statementSchemeYearEnd: r.seed.atSchemeYearEnd,
345
+ prices,
346
+ });
347
+ const cashHistory = historyIn(own.cash, b.cashPrices);
348
+ const todaysHistory = historyIn(own.todays, b.todaysPrices);
349
+ const run = (r, history) => ({
350
+ today: b.today, dateOfBirth: b.born, exitDate: leaving,
351
+ retirementDate: drawing, npa: normalPensionAge(b.born),
352
+ ledger: r.ledger, history,
353
+ curveFrom: earliest(b.today, leaving, schemeYearEndDate(history === null
354
+ ? r.seed.atSchemeYearEnd
355
+ : history.from - 1)),
356
+ });
357
+ return {
358
+ ledger: own.cash.ledger,
359
+ todaysMoneyLedger: own.todays.ledger,
360
+ estimatedHistory: todaysHistory,
361
+ curve: buildCurve(run(own.cash, cashHistory), run(own.todays, todaysHistory)),
362
+ };
363
+ }
364
+ /** Every section's award at one set of choices, summed, with cash taken
365
+ * across the total. */
366
+ function position(b, remedy, choices) {
367
+ const dates = checked(b, remedy, choices);
368
+ const onThe2015Basis = choices.remedy.kind === REMEDY_BASES.section2015;
369
+ const awards = [];
370
+ const { legacy } = b;
371
+ if (legacy !== null) {
372
+ // On the legacy basis every legacy period is final salary; on the
373
+ // 2015 basis the remedy window leaves it for a career average walk.
374
+ const window = legacy.periods.find((p) => p.kind === PERIOD_KINDS.remedyWindow);
375
+ const valued = onThe2015Basis
376
+ ? legacy.periods.filter((p) => p.kind === PERIOD_KINDS.ordinary)
377
+ : legacy.periods;
378
+ awards.push(legacyAward(b, legacy, valued, dates));
379
+ if (onThe2015Basis) {
380
+ // `checked` refused an election for a member with no window.
381
+ invariant(window !== undefined, 'a 2015 basis with no remedy window');
382
+ awards.push(careerAward(b, legacy.section, window, () => seedFromJoinDate(on(window.from)), dates).award);
383
+ }
384
+ }
385
+ const own = careerAward(b, SECTIONS.s2015, b.ordinary2015, (prices) => seed2015(b, dates, prices), dates);
386
+ awards.push(own.award);
387
+ const pension = sumMoney(awards.map((a) => a.pension), dates.drawing);
388
+ const automaticLumpSum = sumMoney(awards.map((a) => a.automaticLumpSum), dates.drawing);
389
+ return {
390
+ choices,
391
+ awards,
392
+ crystallised: { pension, automaticLumpSum },
393
+ cash: cashAt(pension, automaticLumpSum, choices.cash, nhsCommutationLimits(b.cashPrices)),
394
+ prices: b.cashPrices,
395
+ ...section2015(b, own, dates),
396
+ };
397
+ }
398
+ /**
399
+ * Build a member's benefits. Throws `PayPathUnavailable` where there
400
+ * is no current pay to build pay from, `BenefitNotModelled` for service
401
+ * the library does not model, and RangeError for a declaration that
402
+ * cannot be true.
403
+ *
404
+ * `today` is required because it decides which answer comes back: it
405
+ * is the date the figures are as at, so a figure reproduces as at it.
406
+ */
407
+ export function memberBenefits(member, assumptions, today) {
408
+ const { periods, legacy } = servicePeriods(member.service);
409
+ const remedy = periods.some((p) => p.kind === PERIOD_KINDS.remedyWindow);
410
+ // Deferred until the split of a pre-rollback balance is read:
411
+ // https://github.com/casomoltd/nhs-pay/issues/20
412
+ if (remedy && member.statement !== null
413
+ && on(member.statement.asAt) < on(ROLLBACK)) {
414
+ throw new BenefitNotModelled(NOT_MODELLED.statementBeforeRollback, 'a statement from before rollback on 1 October 2023, which '
415
+ + 'counts the remedy years in the 2015 Section');
416
+ }
417
+ const ordinary2015 = periods.at(-1);
418
+ invariant(ordinary2015?.section === SECTIONS.s2015, 'the last period is the 2015 Section\'s');
419
+ const born = on(member.dateOfBirth);
420
+ const built = {
421
+ member,
422
+ today,
423
+ born,
424
+ npaOn: npaDate(born, normalPensionAge(born)),
425
+ payPath: buildPayPath(member.dateOfBirth, member.pay),
426
+ legacy,
427
+ ordinary2015,
428
+ cashPrices: createPrices(assumptions.assumedCpi, today),
429
+ todaysPrices: createPrices(0, today),
430
+ };
431
+ return {
432
+ periods,
433
+ remedy,
434
+ legacy: legacy === null ? null : legacyOf(legacy.section),
435
+ payPath: built.payPath,
436
+ now: () => holdings(built),
437
+ at: (choices) => position(built, remedy, choices),
438
+ };
439
+ }
440
+ //# sourceMappingURL=member-benefits.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"member-benefits.js","sourceRoot":"","sources":["../src/member-benefits.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAC,MAAM,EAAE,oBAAoB,EAAC,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAC,kBAAkB,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,aAAa,CAAC;AAGxE,OAAO,EAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAC,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAC,YAAY,EAAC,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AACpC,OAAO,EAAC,UAAU,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,4BAA4B,CAAC;AAIpC,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,aAAa,EAAC,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAEnC,uDAAuD;AAEvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,KAAK,EAAE,cAAc;IACrB,KAAK,EAAE,cAAc;IACrB,KAAK,EAAE,cAAc;CACb,CAAC;AAqCX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,cAAc;IACtB,WAAW,EAAE,oBAAoB;CACzB,CAAC;AAkBX,uDAAuD;AAEvD;qEACqE;AACrE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,YAAY,EAAE,eAAe;CACrB,CAAC;AAYX,sEAAsE;AACtE,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,gBAAgB;CACvB,CAAC;AA0HX,wEAAwE;AACxE,SAAS,QAAQ,CAAC,OAAwB;IACxC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,OAAO;QACL,OAAO;QACP,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,EAAE,QAAQ,IAAI,IAAI;QAC1D,UAAU,EAAE,KAAK,CAAC,UAAU;KAC7B,CAAC;AACJ,CAAC;AAED,uDAAuD;AAEvD;gEACgE;AAChE,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAC1C,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACxC;oBACoB;AACpB,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAC1C;;iCAEiC;AACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,UAAU,EAAE,WAAW;IACvB,IAAI,EAAE,WAAW;IACjB,EAAE,EAAE,SAAS;IACb,QAAQ,EAAE,QAAQ;CACV,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;IACvC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW;CACrB,CAAC;AAGX,MAAM,EAAE,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACxC,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAE,IAAY,EAAE,EAAE;IAC5C,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACnB,OAAO,IAAI,IAAI,CACb,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAC3D,CAAC;AACJ,CAAC,CAAC;AACF,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAChD,MAAM,gBAAgB,GAAG,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AACpD;+DAC+D;AAC/D,MAAM,KAAK,GAAG,CAAC,CAAgB,EAAE,OAAa,EAAE,EAAE,CAChD,CAAC,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAE3D,MAAM,QAAQ,GAAG,CAAC,OAAkB,EAA8B,EAAE,CAClE,OAAO,KAAK,QAAQ,CAAC,KAAK,CAAC;AAQ7B;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,cAAc,CAAC,QAAmC;IAIzD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,UAAU,CAAC,6BAA6B,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAC/B,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAC1D,CAAC;IACF,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACtB,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC,OAAO,4BAA4B,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9B,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO;QAC/B,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC,OAAO,2BAA2B,CAAC,CAAC;QACxE,CAAC;QACD,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7D,MAAM,IAAI,kBAAkB,CAC1B,YAAY,CAAC,cAAc,EAAE,gCAAgC,CAC9D,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpE,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,kBAAkB,CAC1B,YAAY,CAAC,kBAAkB,EAAE,iCAAiC,CACnE,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/B,IAAI,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,kBAAkB,CAC1B,YAAY,CAAC,aAAa,EAAE,kCAAkC,CAC/D,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IACzB,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS;WAC5B,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC;WAClC,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAClD,IAAI,MAAM,IAAI,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,kBAAkB,CAC1B,YAAY,CAAC,qBAAqB,EAClC,8CAA8C,CAC/C,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,GAAyB,IAAI,CAAC;IACxC,IAAI,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,4DAA4D;QAC5D,8CAA8C;QAC9C,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,6BAA6B,CAAC,CAAC;QAC7D,MAAM,GAAG,GAAkB;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACzC,IAAI,EAAE,YAAY,CAAC,QAAQ;SAC5B,CAAC;QACF,MAAM,GAAG;YACP,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,MAAM;gBACb,CAAC,CAAC,CAAC,GAAG,EAAE;wBACN,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS;wBACvD,IAAI,EAAE,YAAY,CAAC,YAAY;qBAChC,CAAC;gBACF,CAAC,CAAC,CAAC,GAAG,CAAC;SACV,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAoB;QAC/B,GAAG,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,CAAC;QAC1B;YACE,OAAO,EAAE,QAAQ,CAAC,KAAK;YACvB,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM;YAC5C,EAAE,EAAE,GAAG;YACP,IAAI,EAAE,YAAY,CAAC,QAAQ;SAC5B;KACF,CAAC;IACF,OAAO,EAAC,OAAO,EAAE,MAAM,EAAC,CAAC;AAC3B,CAAC;AAED,uDAAuD;AAEvD,MAAM,KAAK,GAA8C;IACvD,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU;IAC5B,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU;CAC7B,CAAC;AAyBF,oEAAoE;AACpE,SAAS,IAAI,CACX,CAAQ,EAAE,MAAqB,EAAE,IAAgB,EACjD,EAAC,OAAO,EAAE,OAAO,EAAU,EAAE,MAAc;IAE3C,MAAM,KAAK,GAAG,gBAAgB,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACtD,OAAO,aAAa,CAAC;QACnB,IAAI;QACJ,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI;YAC7C,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;YACxB,CAAC,CAAC,IAAI,CAAC;QACT,WAAW,EAAE,CAAC,CAAC,IAAI;QACnB,OAAO;QACP,OAAO;QACP,MAAM;QACN,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC;KACvC,CAAC,CAAC;AACL,CAAC;AAED,oEAAoE;AACpE,SAAS,QAAQ,CAAC,CAAQ,EAAE,EAAC,OAAO,EAAE,OAAO,EAAU,EAAE,MAAc;IACrE,MAAM,EAAC,SAAS,EAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,OAAO,SAAS,KAAK,IAAI;QACvB,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,iBAAiB,CACf,SAAS,CAAC,cAAc,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,CACzB,CAAC;AACR,CAAC;AAED,mEAAmE;AACnE,MAAM,YAAY,GAAG,CAAC,MAAgC,EAAE,OAAa,EAAE,EAAE,CACvE,MAAM;KACH,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC;KACpC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,EAAC,CAAC,CAAC,CAAC;AAE7D;gDACgD;AAChD,SAAS,QAAQ,CAAC,CAAQ;IACxB,MAAM,EAAC,KAAK,EAAC,GAAG,CAAC,CAAC;IAClB,MAAM,SAAS,GAAoC,EAAE,CAAC;IACtD,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,OAAO,CAAC,EAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAC,EAAE,KAAK,CAAC,CAAC;IAClE,IAAI,CAAC,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QACtB,MAAM,EAAC,OAAO,EAAE,gBAAgB,EAAC,GAAG,gBAAgB,CAClD,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAC9D,CAAC,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC,CACnC,CAAC;QACF,SAAS,CAAC,IAAI,CAAC;YACb,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;YACtB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC;SACzC,CAAC,CAAC;IACL,CAAC;IACD,mEAAmE;IACnE,6CAA6C;IAC7C,MAAM,OAAO,GAAG,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,IAAI;QACxC,CAAC,CAAC,CAAC,CAAC,KAAK;QACT,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,EAAC,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAC,CAAC;IACxE,MAAM,OAAO,GAAG,IAAI,CAClB,CAAC,EAAE,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,YAAY,CAAC,EACrD,KAAK,EAAE,CAAC,CAAC,YAAY,CACtB,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC1B,SAAS,CAAC,IAAI,CAAC;QACb,OAAO,EAAE,QAAQ,CAAC,KAAK;QACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QACtB,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAC;KAC1B,CAAC,CAAC;IACH,OAAO;QACL,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC;KACnE,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,SAAS,OAAO,CACd,CAAQ,EAAE,MAAe,EAAE,OAA0B;IAErD,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,OAAO,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,IAAI,UAAU,CAAC,0BAA0B,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC;QAClE,MAAM,IAAI,UAAU,CAClB,iDAAiD,CAAC,CAAC,YAAY,CAAC,EAAE,EAAE,CACrE,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,UAAU,CAAC,MAAM;YACzB,CAAC,CAAC,uCAAuC;YACzC,CAAC,CAAC,yDAAyD,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,EAAC,OAAO,EAAE,OAAO,EAAC,CAAC;AAC5B,CAAC;AAED;gDACgD;AAChD,SAAS,WAAW,CAClB,CAAQ,EAAE,MAAqB,EAAE,MAAgC,EACjE,KAAc;IAEd,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,EAAE;QACxC,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC;QAC5C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK;QACjD,MAAM,EAAE,CAAC,CAAC,UAAU;KACrB,CAAC,CAAC;IACH,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,OAAO,EAAE,MAAM;QACf,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;QAC1C,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,IAAI;QACb,UAAU,EAAE;YACV,OAAO,EAAE,QAAQ,CAAC,WAAW;YAC7B,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B;KACF,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,SAAS,WAAW,CAClB,CAAQ,EAAE,OAAkB,EAAE,MAAqB,EACnD,OAAuC,EAAE,KAAc;IAEvD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;IACzE,MAAM,MAAM,GAAG,IAAI,CACjB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,YAAY,CAC1D,CAAC;IACF,OAAO;QACL,KAAK,EAAE;YACL,OAAO;YACP,OAAO,EAAE,CAAC,MAAM,CAAC;YACjB,YAAY,EAAE,OAAO,CACnB,EAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAC,EAAE,KAAK,CAAC,OAAO,CAC/D;YACD,OAAO,EAAE,OAAO,CACd,EAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,EAAC,EAAE,KAAK,CAAC,OAAO,CACzD;YACD,gBAAgB,EAAE,OAAO,CAAC,EAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAC,EAAE,KAAK,CAAC,OAAO,CAAC;YAC/D,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAC;YACxD,UAAU,EAAE,EAAC,OAAO,EAAE,QAAQ,CAAC,aAAa,EAAC;SAC9C;QACD,IAAI;QACJ,MAAM;KACP,CAAC;AACJ,CAAC;AAED;yEACyE;AACzE,SAAS,WAAW,CAClB,CAAQ,EAAE,GAAuD,EACjE,EAAC,OAAO,EAAE,OAAO,EAAU;IAG3B,MAAM,SAAS,GAAG,CAAC,CAAmB,EAAE,MAAc,EAAE,EAAE,CACxD,CAAC,CAAC,MAAM,CAAC,SAAS,KAAK,IAAI;QACzB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,eAAe,CAAC;YAChB,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC;YACjC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO;YAC7B,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe;YAC9C,MAAM;SACP,CAAC,CAAC;IACP,MAAM,WAAW,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;IAC5D,MAAM,GAAG,GAAG,CAAC,CAAmB,EAAE,OAAgC,EAAE,EAAE,CAAC,CAAC;QACtE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO;QACtD,cAAc,EAAE,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC;QACtD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO;QACzB,SAAS,EAAE,QAAQ,CACjB,CAAC,CAAC,KAAK,EAAE,OAAO,EAChB,iBAAiB,CAAC,OAAO,KAAK,IAAI;YAChC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe;YACxB,CAAC,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CACtB;KACF,CAAC,CAAC;IACH,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM;QACvB,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM;QACpC,gBAAgB,EAAE,aAAa;QAC/B,KAAK,EAAE,UAAU,CACf,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAC3D;KACF,CAAC;AACJ,CAAC;AAED;wBACwB;AACxB,SAAS,QAAQ,CACf,CAAQ,EAAE,MAAe,EAAE,OAA0B;IAErD,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,WAAW,CAAC;IAExE,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,MAAM,EAAC,MAAM,EAAC,GAAG,CAAC,CAAC;IACnB,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,kEAAkE;QAClE,oEAAoE;QACpE,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAChC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,YAAY,CAC5C,CAAC;QACF,MAAM,MAAM,GAAG,cAAc;YAC3B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,QAAQ,CAAC;YAChE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,IAAI,cAAc,EAAE,CAAC;YACnB,6DAA6D;YAC7D,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,oCAAoC,CAAC,CAAC;YACtE,MAAM,CAAC,IAAI,CAAC,WAAW,CACrB,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,EACzB,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAC/C,CAAC,KAAK,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAG,WAAW,CACrB,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,YAAY,EACjC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,KAAK,CAC9C,CAAC;IACF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACtE,MAAM,gBAAgB,GAAG,QAAQ,CAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,EAAE,KAAK,CAAC,OAAO,CACrD,CAAC;IACF,OAAO;QACL,OAAO;QACP,MAAM;QACN,YAAY,EAAE,EAAC,OAAO,EAAE,gBAAgB,EAAC;QACzC,IAAI,EAAE,MAAM,CACV,OAAO,EAAE,gBAAgB,EAAE,OAAO,CAAC,IAAI,EACvC,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,CACnC;QACD,MAAM,EAAE,CAAC,CAAC,UAAU;QACpB,GAAG,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAc,EACd,WAAwB,EACxB,KAAW;IAEX,MAAM,EAAC,OAAO,EAAE,MAAM,EAAC,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,YAAY,CAAC,CAAC;IACzE,8DAA8D;IAC9D,iDAAiD;IACjD,IAAI,MAAM,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI;WAClC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,kBAAkB,CAC1B,YAAY,CAAC,uBAAuB,EACpC,4DAA4D;cACxD,6CAA6C,CAClD,CAAC;IACJ,CAAC;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,SAAS,CACP,YAAY,EAAE,OAAO,KAAK,QAAQ,CAAC,KAAK,EACxC,wCAAwC,CACzC,CAAC;IACF,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACpC,MAAM,KAAK,GAAU;QACnB,MAAM;QACN,KAAK;QACL,IAAI;QACJ,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC;QACrD,MAAM;QACN,YAAY;QACZ,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;QACvD,YAAY,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC;KACrC,CAAC;IACF,OAAO;QACL,OAAO;QACP,MAAM;QACN,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;QACzD,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC1B,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC;KAClD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,70 @@
1
+ import type { IsoDate } from './iso-date.js';
2
+ import type { SteppedPoint } from './scale-point.js';
3
+ /**
4
+ * GAD's promotional pay index at an age: growth from promotion and
5
+ * progression over and above general pay awards, 100 at age 25,
6
+ * linear between the published five-year rows and flat beyond their
7
+ * ends.
8
+ *
9
+ * **The two non-manual columns, averaged.** GAD splits the index by
10
+ * sex and we do not ask a member's sex, nor infer it: averaging is
11
+ * the only version that encodes no guess about the member. It
12
+ * overstates progression for women and understates it for men, which a
13
+ * caller showing its figures should disclose. Non-manual is not a second
14
+ * assumption — every Agenda for Change band is non-manual in GAD's
15
+ * terms.
16
+ */
17
+ export declare function promotionalIndex(age: number): number;
18
+ /**
19
+ * A year's pensionable pay the member gave us, in today's money, which
20
+ * the field's name says so a caller cannot pass a payslip's cash
21
+ * figure by mistake: every other year of the path is in today's money,
22
+ * and one cash figure among them would be silently low. Bringing an
23
+ * old figure forward is deferred:
24
+ * https://github.com/casomoltd/nhs-pay/issues/22
25
+ */
26
+ export interface DeclaredPay {
27
+ readonly schemeYearEnd: number;
28
+ readonly todaysMoney: number;
29
+ }
30
+ /** What a member told us about their pay. */
31
+ export interface MemberPay {
32
+ readonly declared: readonly DeclaredPay[];
33
+ /** Pensionable pay now, in today's money. The anchor every
34
+ * worked-out year scales from, so it is the one figure the path
35
+ * cannot do without. */
36
+ readonly current: {
37
+ readonly todaysMoney: number;
38
+ readonly asAt: IsoDate;
39
+ };
40
+ /** The member's pay scale and where on it they are, while steps
41
+ * remain. Null off a stepped scale, or at its top. `current` is one
42
+ * of `points`, the object itself, so it cannot name a point the
43
+ * scale does not have. */
44
+ readonly ladder: {
45
+ readonly points: readonly SteppedPoint[];
46
+ readonly current: SteppedPoint;
47
+ } | null;
48
+ }
49
+ /** What a year's pay rests on: see the module header. */
50
+ export declare const PAY_BASES: {
51
+ readonly declared: "declared";
52
+ readonly contractual: "contractual";
53
+ readonly projected: "projected";
54
+ readonly reconstructed: "reconstructed";
55
+ };
56
+ export type PayBasis = (typeof PAY_BASES)[keyof typeof PAY_BASES];
57
+ export interface YearPay {
58
+ readonly pay: number;
59
+ readonly basis: PayBasis;
60
+ }
61
+ /** A member's pensionable pay, every scheme year, in today's money. */
62
+ export interface PayPath {
63
+ payFor(schemeYearEnd: number): YearPay;
64
+ }
65
+ /**
66
+ * Build a member's pay path. Refuses only where there is nothing to
67
+ * build from: every other gap is filled, the same way for everybody,
68
+ * and labelled as filled.
69
+ */
70
+ export declare function buildPayPath(dateOfBirth: IsoDate, pay: MemberPay): PayPath;