@casomoltd/nhs-pay 0.30.0 → 0.31.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 (77) hide show
  1. package/README.md +69 -251
  2. package/dist/bands.d.ts +9 -1
  3. package/dist/bands.js +20 -0
  4. package/dist/bands.js.map +1 -1
  5. package/dist/document-source.d.ts +16 -0
  6. package/dist/document-source.js +3 -1
  7. package/dist/document-source.js.map +1 -1
  8. package/dist/errors.d.ts +46 -11
  9. package/dist/errors.js +68 -28
  10. package/dist/errors.js.map +1 -1
  11. package/dist/factor-basis.d.ts +14 -0
  12. package/dist/factor-basis.js.map +1 -1
  13. package/dist/index.d.ts +13 -11
  14. package/dist/index.js +6 -5
  15. package/dist/index.js.map +1 -1
  16. package/dist/member/benefits.js +18 -11
  17. package/dist/member/benefits.js.map +1 -1
  18. package/dist/member/index.d.ts +1 -1
  19. package/dist/member/input-period.d.ts +4 -4
  20. package/dist/member/input-period.js +11 -9
  21. package/dist/member/input-period.js.map +1 -1
  22. package/dist/member/service.d.ts +4 -0
  23. package/dist/member/service.js +9 -3
  24. package/dist/member/service.js.map +1 -1
  25. package/dist/member/types.d.ts +81 -49
  26. package/dist/member/types.js.map +1 -1
  27. package/dist/member/valuation.d.ts +10 -8
  28. package/dist/member/valuation.js +17 -21
  29. package/dist/member/valuation.js.map +1 -1
  30. package/dist/pay-path.d.ts +21 -25
  31. package/dist/pay-path.js +85 -67
  32. package/dist/pay-path.js.map +1 -1
  33. package/dist/pension/ages.d.ts +6 -4
  34. package/dist/pension/ages.js +6 -4
  35. package/dist/pension/ages.js.map +1 -1
  36. package/dist/pension/curve.d.ts +2 -1
  37. package/dist/pension/curve.js +15 -7
  38. package/dist/pension/curve.js.map +1 -1
  39. package/dist/pension/history.d.ts +18 -3
  40. package/dist/pension/history.js +12 -5
  41. package/dist/pension/history.js.map +1 -1
  42. package/dist/pension/ledger.d.ts +15 -9
  43. package/dist/pension/ledger.js +91 -56
  44. package/dist/pension/ledger.js.map +1 -1
  45. package/dist/pension/prices.d.ts +11 -2
  46. package/dist/pension/prices.js +35 -14
  47. package/dist/pension/prices.js.map +1 -1
  48. package/dist/pension/scheme-year.d.ts +59 -0
  49. package/dist/pension/scheme-year.js +80 -0
  50. package/dist/pension/scheme-year.js.map +1 -0
  51. package/dist/pension/seed.d.ts +66 -50
  52. package/dist/pension/seed.js +111 -65
  53. package/dist/pension/seed.js.map +1 -1
  54. package/dist/pension/uplift.d.ts +13 -33
  55. package/dist/pension/uplift.js +11 -56
  56. package/dist/pension/uplift.js.map +1 -1
  57. package/dist/pension-projection.js +30 -22
  58. package/dist/pension-projection.js.map +1 -1
  59. package/dist/post.d.ts +1 -10
  60. package/dist/post.js +1 -12
  61. package/dist/post.js.map +1 -1
  62. package/dist/revaluation.d.ts +34 -35
  63. package/dist/revaluation.js +41 -41
  64. package/dist/revaluation.js.map +1 -1
  65. package/dist/scale-point.d.ts +6 -0
  66. package/dist/sections/final-salary.d.ts +3 -8
  67. package/dist/sections/final-salary.js +13 -9
  68. package/dist/sections/final-salary.js.map +1 -1
  69. package/dist/sections/section-2015.d.ts +2 -1
  70. package/dist/sections/section-2015.js.map +1 -1
  71. package/dist/sources.d.ts +10 -0
  72. package/dist/sources.js +20 -0
  73. package/dist/sources.js.map +1 -1
  74. package/dist/take-home.d.ts +4 -20
  75. package/dist/take-home.js +3 -23
  76. package/dist/take-home.js.map +1 -1
  77. package/package.json +3 -3
@@ -155,9 +155,9 @@ import { earliest, npaDate, periodInYearsMonths, } from './dates.js';
155
155
  import { createPrices } from './pension/prices.js';
156
156
  import { ACCRUAL_RATE, atDrawing, buildLedger, flatPay, } from './pension/ledger.js';
157
157
  import { estimateHistory } from './pension/history.js';
158
- import { seedFromBalanceAt } from './pension/uplift.js';
159
158
  import { buildCurve, walkThrough } from './pension/curve.js';
160
- import { schemeYearEndDate, seedFromJoinDate } from './pension/seed.js';
159
+ import { schemeYearBefore, schemeYearEndDate } from './pension/scheme-year.js';
160
+ import { seedFromBalanceAt, seedFromJoinDate } from './pension/seed.js';
161
161
  import { FACTOR_TABLES, factorTable } from './factor-basis.js';
162
162
  // ── Constants ───────────────────────────────────────
163
163
  /* The accrual rate is owned by the ledger that applies it and
@@ -289,8 +289,30 @@ export function projectPension(input, today = new Date()) {
289
289
  todaysMoneyLedger: todays.ledger,
290
290
  };
291
291
  }
292
+ /** The flat-pay walk from `seed` to the drawing, and the factor the
293
+ * drawing takes. */
294
+ function walkToDrawing(input, seed, prices) {
295
+ const { currentSalary, dateOfBirth, exitDate, retirementDate, npa } = input;
296
+ const { factor, type: factorType } = retirementFactor(retirementDate, npaDate(dateOfBirth, npa));
297
+ const ledger = buildLedger({
298
+ seed,
299
+ payIn: flatPay(currentSalary),
300
+ exitDate,
301
+ retirementDate,
302
+ prices,
303
+ through: walkThrough(retirementDate, npaDate(dateOfBirth, npa)),
304
+ drawingFor: () => ({
305
+ on: retirementDate,
306
+ factor,
307
+ table: factorType === null
308
+ ? null
309
+ : { kind: factorType, provenance: factorProvenance(factorType) },
310
+ }),
311
+ });
312
+ return { ledger, factor, factorType };
313
+ }
292
314
  function resolveProjection(input, today) {
293
- const { currentSalary, dateOfBirth, exitDate, retirementDate, npa, assumedCpi, } = input;
315
+ const { dateOfBirth, exitDate, retirementDate, npa, assumedCpi } = input;
294
316
  /* The drawing date is used EXACTLY AS GIVEN, to the day.
295
317
  Retiring on a birthday, mid-month, or on a scheme year end
296
318
  are three different questions and this function answers
@@ -310,24 +332,8 @@ function resolveProjection(input, today) {
310
332
  // The ONLY place the input variant is read.
311
333
  const seed = isEstimation
312
334
  ? seedFromJoinDate(input.joinDate)
313
- : seedFromBalanceAt(input.accruedPension, input.statementDate, exitDate, retirementDate, prices);
314
- const { factor, type: factorType } = retirementFactor(retirementDate, npaDate(dateOfBirth, npa));
315
- const through = walkThrough(retirementDate, npaDate(dateOfBirth, npa));
316
- const ledger = buildLedger({
317
- seed,
318
- payIn: flatPay(currentSalary),
319
- exitDate,
320
- retirementDate,
321
- prices,
322
- through,
323
- drawingFor: () => ({
324
- on: retirementDate,
325
- factor,
326
- table: factorType === null
327
- ? null
328
- : { kind: factorType, provenance: factorProvenance(factorType) },
329
- }),
330
- });
335
+ : seedFromBalanceAt({ balance: input.accruedPension, asOf: input.statementDate }, exitDate, retirementDate, prices);
336
+ const { ledger, factor, factorType } = walkToDrawing(input, seed, prices);
331
337
  const { revalued, drawn } = atDrawing(ledger, retirementDate, factor);
332
338
  /* Illustration only, and only where a statement leaves a gap:
333
339
  an estimation path already walks from the join date, so
@@ -353,7 +359,9 @@ function resolveProjection(input, today) {
353
359
  other; starting the curve at today withholds them.
354
360
  Starting at today would also put a past leaving date
355
361
  outside the curve's range. */
356
- curveFrom: earliest(today, exitDate, schemeYearEndDate(history === null ? seed.atSchemeYearEnd : history.from - 1)),
362
+ curveFrom: earliest(today, exitDate, schemeYearEndDate(history === null
363
+ ? seed.atSchemeYearEnd
364
+ : schemeYearBefore(history.from))),
357
365
  // The leaving row settles on the last day of service, so the
358
366
  // entitlement is read there, before any retirement factor.
359
367
  accruedAtExit: ledger.accruedAt(exitDate),
@@ -1 +1 @@
1
- {"version":3,"file":"pension-projection.js","sourceRoot":"","sources":["../src/pension-projection.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwJG;AAEH,OAAO,EACL,QAAQ,EACR,OAAO,EACP,mBAAmB,GACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EACL,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,GAC9C,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAGrD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,UAAU,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAAC,iBAAiB,EAAE,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,mBAAmB,CAAC;AA8I7D,uDAAuD;AAEvD;;sCAEsC;AACtC,OAAO,EAAC,YAAY,EAAC,CAAC;AAEtB,uDAAuD;AAEvD,gEAAgE;AAChE,iEAAiE;AACjE,0CAA0C;AAC1C,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;AAClD,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAEjD;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAqB;IAErB,OAAO,IAAI,KAAK,KAAK;QACnB,CAAC,CAAC,IAAI,CAAC,UAAU;QACjB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;AACtB,CAAC;AAED,uDAAuD;AAEvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,cAAoB,EACpB,MAAY;IAEZ,IAAI,cAAc,IAAI,MAAM,EAAE,CAAC;QAC7B,6BAA6B;QAC7B,MAAM,MAAM,GAAG,mBAAmB,CAChC,MAAM,EACN,cAAc,CACf,CAAC;QACF,IAAI,MAAM,CAAC,KAAK,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;eACxC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,EAAC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;QACjC,CAAC;QACD,OAAO,EAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC;IACvD,CAAC;IAED,mBAAmB;IACnB,MAAM,MAAM,GAAG,mBAAmB,CAChC,cAAc,EACd,MAAM,CACP,CAAC;IACF,OAAO,EAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CACxB,MAAuC;IAEvC,OAAO,IAAI,CAAC,SAAS,CAAC,EAAC,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,EAAC,CAAC,CAAC;AAC9C,CAAC;AAED,uDAAuD;AAEvD,qDAAqD;AACrD,MAAM,UAAU,aAAa,CAC3B,cAAsB;IAEtB,OAAO,cAAc,GAAG,YAAY,CAAC;AACvC,CAAC;AAED,uDAAuD;AAEvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAC5B,KAA6B,EAC7B,QAAc,IAAI,IAAI,EAAE;IAExB;;;;;;;;;4BASwB;IACxB,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,KAAK,CAAC;QACnC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,iBAAiB,CAAC,EAAC,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC,EAAC,EAAE,KAAK,CAAC,CAAC;IAExD,MAAM,IAAI,GAAG,CACX,CAAS,EAAE,CAAS,EAAE,IAAU,EACf,EAAE,CAAC,CAAC,EAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAC,CAAC,CAAC;IAEpD,OAAO;QACL,aAAa,EAAE,IAAI,CACjB,IAAI,CAAC,aAAa,EAClB,MAAM,CAAC,aAAa,EACpB,IAAI,CAAC,QAAQ,CACd;QACD,oBAAoB,EAAE,IAAI,CACxB,IAAI,CAAC,oBAAoB,EACzB,MAAM,CAAC,oBAAoB,EAC3B,IAAI,CAAC,cAAc,CACpB;QACD,aAAa,EAAE,IAAI,CACjB,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,aAAa,EACxC,IAAI,CAAC,cAAc,CACpB;QACD,UAAU,EAAE,IAAI,CACd,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EACtD,KAAK,CACN;QACD,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,gBAAgB,EAAE,IAAI,CACpB,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAC9C,MAAM,CAAC,oBAAoB,GAAG,MAAM,CAAC,aAAa,EAClD,IAAI,CAAC,cAAc,CACpB;QACD,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,gBAAgB,EAAE,MAAM,CAAC,OAAO;QAChC,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB;;;kDAG0C;QAC1C,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,iBAAiB,EAAE,MAAM,CAAC,MAAM;KACjC,CAAC;AACJ,CAAC;AA4CD,SAAS,iBAAiB,CACxB,KAA6B,EAC7B,KAAW;IAEX,MAAM,EACJ,aAAa,EAAE,WAAW,EAAE,QAAQ,EACpC,cAAc,EAAE,GAAG,EAAE,UAAU,GAChC,GAAG,KAAK,CAAC;IAGV;;;;;;;;;;;;;kCAa8B;IAE9B,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC;IACjD,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAE/C,4CAA4C;IAC5C,MAAM,IAAI,GAAG,YAAY;QACvB,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAClC,CAAC,CAAC,iBAAiB,CACf,KAAK,CAAC,cAAc,EACpB,KAAK,CAAC,aAAa,EACnB,QAAQ,EAAE,cAAc,EAAE,MAAM,CACjC,CAAC;IAEN,MAAM,EAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAC,GAAG,gBAAgB,CACjD,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAC1C,CAAC;IACF,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;IAEvE,MAAM,MAAM,GAAG,WAAW,CAAC;QACzB,IAAI;QACJ,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC;QAC7B,QAAQ;QACR,cAAc;QACd,MAAM;QACN,OAAO;QACP,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;YACjB,EAAE,EAAE,cAAc;YAClB,MAAM;YACN,KAAK,EAAE,UAAU,KAAK,IAAI;gBACxB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,EAAC,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC,EAAC;SACjE,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,EAAC,QAAQ,EAAE,KAAK,EAAC,GAAG,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IAEpE;;;kEAG8D;IAC9D,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,KAAK,WAAW;WACnC,KAAK,CAAC,QAAQ,KAAK,SAAS;QACjC,CAAC,CAAC,eAAe,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,aAAa,EAAE,IAAI,CAAC,OAAO;YAC3B,sBAAsB,EAAE,IAAI,CAAC,eAAe;YAC5C,MAAM;SACP,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IAET,OAAO;QACL,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG;QACjD,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;QACzD;;;;;;;wCAOgC;QAChC,SAAS,EAAE,QAAQ,CACjB,KAAK,EACL,QAAQ,EACR,iBAAiB,CACf,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAC3D,CACF;QACD,6DAA6D;QAC7D,2DAA2D;QAC3D,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;QACzC,oBAAoB,EAAE,QAAQ;QAC9B,aAAa,EAAE,KAAK;KACrB,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"pension-projection.js","sourceRoot":"","sources":["../src/pension-projection.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwJG;AAEH,OAAO,EACL,QAAQ,EACR,OAAO,EACP,mBAAmB,GACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EACL,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,GAC9C,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAGrD,OAAO,EAAC,UAAU,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAAC,gBAAgB,EAAE,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAC,iBAAiB,EAAE,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AAEtE,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,mBAAmB,CAAC;AA8I7D,uDAAuD;AAEvD;;sCAEsC;AACtC,OAAO,EAAC,YAAY,EAAC,CAAC;AAEtB,uDAAuD;AAEvD,gEAAgE;AAChE,iEAAiE;AACjE,0CAA0C;AAC1C,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;AAClD,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAEjD;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAqB;IAErB,OAAO,IAAI,KAAK,KAAK;QACnB,CAAC,CAAC,IAAI,CAAC,UAAU;QACjB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;AACtB,CAAC;AAED,uDAAuD;AAEvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,cAAoB,EACpB,MAAY;IAEZ,IAAI,cAAc,IAAI,MAAM,EAAE,CAAC;QAC7B,6BAA6B;QAC7B,MAAM,MAAM,GAAG,mBAAmB,CAChC,MAAM,EACN,cAAc,CACf,CAAC;QACF,IAAI,MAAM,CAAC,KAAK,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;eACxC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,EAAC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;QACjC,CAAC;QACD,OAAO,EAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC;IACvD,CAAC;IAED,mBAAmB;IACnB,MAAM,MAAM,GAAG,mBAAmB,CAChC,cAAc,EACd,MAAM,CACP,CAAC;IACF,OAAO,EAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CACxB,MAAuC;IAEvC,OAAO,IAAI,CAAC,SAAS,CAAC,EAAC,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,EAAC,CAAC,CAAC;AAC9C,CAAC;AAED,uDAAuD;AAEvD,qDAAqD;AACrD,MAAM,UAAU,aAAa,CAC3B,cAAsB;IAEtB,OAAO,cAAc,GAAG,YAAY,CAAC;AACvC,CAAC;AAED,uDAAuD;AAEvD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAC5B,KAA6B,EAC7B,QAAc,IAAI,IAAI,EAAE;IAExB;;;;;;;;;4BASwB;IACxB,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,KAAK,CAAC;QACnC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,iBAAiB,CAAC,EAAC,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC,EAAC,EAAE,KAAK,CAAC,CAAC;IAExD,MAAM,IAAI,GAAG,CACX,CAAS,EAAE,CAAS,EAAE,IAAU,EACf,EAAE,CAAC,CAAC,EAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAC,CAAC,CAAC;IAEpD,OAAO;QACL,aAAa,EAAE,IAAI,CACjB,IAAI,CAAC,aAAa,EAClB,MAAM,CAAC,aAAa,EACpB,IAAI,CAAC,QAAQ,CACd;QACD,oBAAoB,EAAE,IAAI,CACxB,IAAI,CAAC,oBAAoB,EACzB,MAAM,CAAC,oBAAoB,EAC3B,IAAI,CAAC,cAAc,CACpB;QACD,aAAa,EAAE,IAAI,CACjB,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,aAAa,EACxC,IAAI,CAAC,cAAc,CACpB;QACD,UAAU,EAAE,IAAI,CACd,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EACtD,KAAK,CACN;QACD,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,gBAAgB,EAAE,IAAI,CACpB,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAC9C,MAAM,CAAC,oBAAoB,GAAG,MAAM,CAAC,aAAa,EAClD,IAAI,CAAC,cAAc,CACpB;QACD,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,gBAAgB,EAAE,MAAM,CAAC,OAAO;QAChC,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB;;;kDAG0C;QAC1C,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,iBAAiB,EAAE,MAAM,CAAC,MAAM;KACjC,CAAC;AACJ,CAAC;AAwCD;qBACqB;AACrB,SAAS,aAAa,CACpB,KAA6B,EAAE,IAAgB,EAAE,MAAc;IAE/D,MAAM,EAAC,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,EAAC,GAAG,KAAK,CAAC;IAC1E,MAAM,EAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAC,GAAG,gBAAgB,CACjD,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAC1C,CAAC;IACF,MAAM,MAAM,GAAG,WAAW,CAAC;QACzB,IAAI;QACJ,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC;QAC7B,QAAQ;QACR,cAAc;QACd,MAAM;QACN,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAC/D,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;YACjB,EAAE,EAAE,cAAc;YAClB,MAAM;YACN,KAAK,EAAE,UAAU,KAAK,IAAI;gBACxB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,EAAC,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC,EAAC;SACjE,CAAC;KACH,CAAC,CAAC;IACH,OAAO,EAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAC,CAAC;AACtC,CAAC;AAED,SAAS,iBAAiB,CACxB,KAA6B,EAC7B,KAAW;IAEX,MAAM,EAAC,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,EAAE,UAAU,EAAC,GAAG,KAAK,CAAC;IAGvE;;;;;;;;;;;;;kCAa8B;IAE9B,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC;IACjD,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAE/C,4CAA4C;IAC5C,MAAM,IAAI,GAAG,YAAY;QACvB,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAClC,CAAC,CAAC,iBAAiB,CACf,EAAC,OAAO,EAAE,KAAK,CAAC,cAAc,EAAE,IAAI,EAAE,KAAK,CAAC,aAAa,EAAC,EAC1D,QAAQ,EAAE,cAAc,EAAE,MAAM,CACjC,CAAC;IAEN,MAAM,EAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAC,GAAG,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACxE,MAAM,EAAC,QAAQ,EAAE,KAAK,EAAC,GAAG,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IAEpE;;;kEAG8D;IAC9D,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,KAAK,WAAW;WACnC,KAAK,CAAC,QAAQ,KAAK,SAAS;QACjC,CAAC,CAAC,eAAe,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,aAAa,EAAE,IAAI,CAAC,OAAO;YAC3B,sBAAsB,EAAE,IAAI,CAAC,eAAe;YAC5C,MAAM;SACP,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IAET,OAAO;QACL,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG;QACjD,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;QACzD;;;;;;;wCAOgC;QAChC,SAAS,EAAE,QAAQ,CACjB,KAAK,EACL,QAAQ,EACR,iBAAiB,CACf,OAAO,KAAK,IAAI;YACd,CAAC,CAAC,IAAI,CAAC,eAAe;YACtB,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CACnC,CACF;QACD,6DAA6D;QAC7D,2DAA2D;QAC3D,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;QACzC,oBAAoB,EAAE,QAAQ;QAC9B,aAAa,EAAE,KAAK;KACrB,CAAC;AACJ,CAAC"}
package/dist/post.d.ts CHANGED
@@ -10,7 +10,7 @@
10
10
  * a value by building a new one (see {@link Post.withSalary},
11
11
  * {@link Post.withAdjustments}).
12
12
  */
13
- import type { Nation, PayYear, TaxYear, TakeHomePay, AnnualAllowance, StudentLoanPlan, TaxCode } from '@casomoltd/paye-calc';
13
+ import type { Nation, PayYear, TaxYear, TakeHomePay, StudentLoanPlan, TaxCode } from '@casomoltd/paye-calc';
14
14
  import type { Role } from './role.js';
15
15
  import type { DocumentSource } from './document-source.js';
16
16
  import type { PayAward } from './award.js';
@@ -196,15 +196,6 @@ export declare class Post {
196
196
  private get _pensionFraction();
197
197
  /** Full take-home breakdown (tax, NI, pension, net). */
198
198
  get takeHome(): TakeHomePay;
199
- /**
200
- * The pension annual allowance this post's year meets, with the
201
- * scheme's defined-benefit pension input: read it here, not off
202
- * `takeHome`, whose own allowance has no scheme input. The input is
203
- * this year's accrual alone (`nhsAnnualAllowance`): a post knows no
204
- * member history, so revaluation of pension already built up is not
205
- * counted.
206
- */
207
- get annualAllowance(): AnnualAllowance;
208
199
  /** Annual income tax (£). */
209
200
  get tax(): number;
210
201
  /** Annual national insurance (£). */
package/dist/post.js CHANGED
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import { nationToTaxRegion } from '@casomoltd/paye-calc';
14
14
  import { getPensionTiersVO } from './pension.js';
15
- import { nhsAnnualAllowance, nhsTakeHome } from './take-home.js';
15
+ import { nhsTakeHome } from './take-home.js';
16
16
  import { awardsFor } from './award.js';
17
17
  import { afcScaleSource } from './scales.js';
18
18
  import { ScaleUnavailable } from './errors.js';
@@ -201,17 +201,6 @@ export class Post {
201
201
  taxCode: this.adjustments.taxCode,
202
202
  });
203
203
  }
204
- /**
205
- * The pension annual allowance this post's year meets, with the
206
- * scheme's defined-benefit pension input: read it here, not off
207
- * `takeHome`, whose own allowance has no scheme input. The input is
208
- * this year's accrual alone (`nhsAnnualAllowance`): a post knows no
209
- * member history, so revaluation of pension already built up is not
210
- * counted.
211
- */
212
- get annualAllowance() {
213
- return nhsAnnualAllowance(this.pensionablePay, this._pensionFraction, this.identity.taxYear, nationToTaxRegion(this.identity.nation));
214
- }
215
204
  /** Annual income tax (£). */
216
205
  get tax() {
217
206
  return this.takeHome.incomeTax;
package/dist/post.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"post.js","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAUvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,kBAAkB,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE/D,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAC;AAErC,OAAO,EAAC,cAAc,EAAC,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAGnD;;6CAE6C;AAC7C,SAAS,WAAW,CAClB,KAAoD,EACpD,KAAQ,EACR,QAA4C;IAE5C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CACxB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CACzC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CAAC,IAAU;IACzB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAoFD,mFAAmF;AACnF,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC7C,GAAG,EAAE,CAAC;IACN,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,IAAI,GAAG,EAAE;IACvB,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,KAAK;CACvB,CAAC;AAEF,iCAAiC;AACjC,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB,MAAM,OAAO,IAAI;IAEJ;IACA;IACA;IACA;IAJX,YACW,QAAsB,EACtB,MAAc,EACd,IAAU,EACV,cAA+B,cAAc;QAH7C,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAM;QACV,gBAAW,GAAX,WAAW,CAAkC;IACrD,CAAC;IAEJ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,CACf,MAAc,EACd,MAAc;IACd,yDAAyD;IACzD,IAAa;IACb;;;;;;;;;OASG;IACH,OAAgB,EAChB,OAAa,EAAC,IAAI,EAAE,KAAK,EAAC;QAE1B,OAAO,IAAI,IAAI,CACb,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,EAAE,MAAM,EAAE,IAAI,CAC/C,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,cAAc;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CACnC,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CACb,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAChD,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,KAAK;QACP,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI;QAChD,6DAA6D;QAC7D,gEAAgE;QAChE,6CAA6C;QAC7C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,CAC/B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,WAAW;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5D,KAAK,SAAS;gBACZ,OAAO,WAAW,CAChB,gBAAgB,CACd,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,KAAK,QAAQ;gBACX,OAAO,WAAW,CAChB,eAAe,CACb,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,gEAAgE;YAChE,+DAA+D;YAC/D,gEAAgE;YAChE,KAAK,KAAK;gBACR,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED,oDAAoD;IACpD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,iBAAiB,CACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED;qCACiC;IACjC,IAAY,gBAAgB;QAC1B,OAAO,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED,wDAAwD;IACxD,IAAI,QAAQ;QACV,OAAO,WAAW,CAChB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EACvC;YACE,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY;YAC3C,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;SAClC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,eAAe;QACjB,OAAO,kBAAkB,CACvB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CACxC,CAAC;IACJ,CAAC;IAED,6BAA6B;IAC7B,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED,qCAAqC;IACrC,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACzC,CAAC;IAED,0DAA0D;IAC1D,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,IAAI,CACb,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CACnD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,KAA+B;QAC7C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE;YACrD,GAAG,IAAI,CAAC,WAAW;YACnB,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"post.js","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AASvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAC;AAErC,OAAO,EAAC,cAAc,EAAC,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAGnD;;6CAE6C;AAC7C,SAAS,WAAW,CAClB,KAAoD,EACpD,KAAQ,EACR,QAA4C;IAE5C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CACxB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CACzC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CAAC,IAAU;IACzB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAoFD,mFAAmF;AACnF,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC7C,GAAG,EAAE,CAAC;IACN,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,IAAI,GAAG,EAAE;IACvB,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,KAAK;CACvB,CAAC;AAEF,iCAAiC;AACjC,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB,MAAM,OAAO,IAAI;IAEJ;IACA;IACA;IACA;IAJX,YACW,QAAsB,EACtB,MAAc,EACd,IAAU,EACV,cAA+B,cAAc;QAH7C,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAM;QACV,gBAAW,GAAX,WAAW,CAAkC;IACrD,CAAC;IAEJ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,CACf,MAAc,EACd,MAAc;IACd,yDAAyD;IACzD,IAAa;IACb;;;;;;;;;OASG;IACH,OAAgB,EAChB,OAAa,EAAC,IAAI,EAAE,KAAK,EAAC;QAE1B,OAAO,IAAI,IAAI,CACb,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,EAAE,MAAM,EAAE,IAAI,CAC/C,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,cAAc;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CACnC,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CACb,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAChD,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,KAAK;QACP,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI;QAChD,6DAA6D;QAC7D,gEAAgE;QAChE,6CAA6C;QAC7C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,CAC/B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,WAAW;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5D,KAAK,SAAS;gBACZ,OAAO,WAAW,CAChB,gBAAgB,CACd,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,KAAK,QAAQ;gBACX,OAAO,WAAW,CAChB,eAAe,CACb,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,gEAAgE;YAChE,+DAA+D;YAC/D,gEAAgE;YAChE,KAAK,KAAK;gBACR,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED,oDAAoD;IACpD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,iBAAiB,CACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED;qCACiC;IACjC,IAAY,gBAAgB;QAC1B,OAAO,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED,wDAAwD;IACxD,IAAI,QAAQ;QACV,OAAO,WAAW,CAChB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EACvC;YACE,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY;YAC3C,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;SAClC,CACF,CAAC;IACJ,CAAC;IAED,6BAA6B;IAC7B,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED,qCAAqC;IACrC,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACzC,CAAC;IAED,0DAA0D;IAC1D,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,IAAI,CACb,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CACnD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,KAA+B;QAC7C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE;YACrD,GAAG,IAAI,CAAC,WAAW;YACnB,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -20,10 +20,10 @@
20
20
  *
21
21
  * "HM Treasury HCWS437 — Public Service Pension
22
22
  * Scheme Indexation and Revaluation 2025", the
23
- * Chief Secretary's annual written ministerial statement. Its
24
- * per-scheme table gives NHS active revaluation as 3.2%
25
- * independently of the Order and of the valuation report, and
26
- * states why the date moved to 6 April.
23
+ * Chief Secretary's annual written ministerial statement. It
24
+ * states why the date moved to 6 April, and its per-scheme table
25
+ * is a source of the applied-rate fixture, independent of the
26
+ * Order and of the valuation report.
27
27
  *
28
28
  * "SPPA NHS Circular 2023/01 — pension indexation and CARE
29
29
  * revaluation" — the clearest annual statement of the exact NHS
@@ -32,8 +32,10 @@
32
32
  *
33
33
  * "NHS Pension Scheme Valuation Report 2020", Appendix E
34
34
  * "Inter-valuation events" — the in-service revaluation as
35
- * ACTUALLY APPLIED, year by year from April 2016. This is the
36
- * rate column's source, and it is independent of the orders.
35
+ * ACTUALLY APPLIED, year by year from April 2016, independent of
36
+ * the orders. No rate is held here: the rule derives it from the
37
+ * Order's CPI (`activeRatePct`), and the applied rates are the
38
+ * test oracle in `tests/fixtures/revaluation-applied.csv`.
37
39
  *
38
40
  * "SI 2015/94 Sch 9 para 3 — revaluation": the NHS Pension
39
41
  * Scheme Regulations 2015 add 1.5 to the prices "increase or
@@ -43,13 +45,12 @@
43
45
  * "NHSBSA KA-02728 — how your pension is revalued", on how it is
44
46
  * applied to members and on the date change below.
45
47
  *
46
- * Cross-checked against the "Revaluation" column of a member's
47
- * Annual Benefit Statement (2015 Section, updated to
48
- * 31/03/2025; name and membership number redacted), which
49
- * quoted 4.6, 11.6, 8.2 and 3.2 for the years to 2025 — the
50
- * rates above as actually applied to a real record, rather
51
- * than as legislated. Nothing else from that document is used
52
- * here: the earnings beside that column are the member's.
48
+ * The fixture is cross-checked against the "Revaluation" column
49
+ * of a member's Annual Benefit Statement (2015 Section, updated
50
+ * to 31/03/2025; name and membership number redacted): the rates
51
+ * as actually applied to a real record, rather than as
52
+ * legislated. Nothing else from that document is used: the
53
+ * earnings beside that column are the member's.
53
54
  * Archived as "Annual Benefit Statement, 2015 Section,
54
55
  * redacted" — see docs/source-archive.md.
55
56
  *
@@ -61,13 +62,13 @@
61
62
  * than letting a scheme-year boundary be assumed.
62
63
  *
63
64
  * **CPI is sourced independently of the rate**, never derived
64
- * from it. Taking `septemberCpiPct = ratePct - 1.5` would make
65
+ * from it. Taking `septemberCpiPct = rate - 1.5` would make
65
66
  * the test that checks the +1.5 rule agree with itself, which
66
- * is no test at all. So the two columns come from two
67
- * documents that do not cite each other: prices from each
68
- * Treasury Order's own operative words, and the rate AS
69
- * APPLIED from the 2020 valuation report's inter-valuation
70
- * table. They agree on all eleven years.
67
+ * is no test at all. So the two come from documents that do
68
+ * not cite each other: prices here, from each Treasury Order's
69
+ * own operative words, and the rate AS APPLIED in a test
70
+ * fixture, from the 2020 valuation report's inter-valuation
71
+ * table and a member's statement.
71
72
  *
72
73
  * **A negative prices figure is carried through, not floored.**
73
74
  * September 2015 CPI was -0.1% and the 2016 order specifies a
@@ -86,9 +87,9 @@
86
87
  * in-service revaluation was applied in April 2016. All eleven
87
88
  * years to 2026 are here, which is what lets a projection walk
88
89
  * a member's whole membership rather than only the part since
89
- * their statement. `revaluationFor` still returns null rather
90
- * than guessing for a year not held — which now means only a
91
- * year whose order has not yet been made.
90
+ * their statement. `revaluationFor` returns null rather than
91
+ * guessing for a year not held: one before 2016, or one whose
92
+ * order has not yet been made.
92
93
  *
93
94
  * ── Not this table ──────────────────────────────────
94
95
  *
@@ -97,15 +98,14 @@
97
98
  * different instrument. For 1995/2008 practitioners the
98
99
  * equivalent uplift is earnings dynamisation, not this.
99
100
  */
101
+ import type { SchemeYearEnd } from './pension/scheme-year.js';
100
102
  /** One scheme year's revaluation, and what set it. */
101
103
  export interface RevaluationYear {
102
104
  /** Scheme year END, e.g. 2022 for the 2021/22 year. */
103
- readonly yearEnd: number;
105
+ readonly yearEnd: SchemeYearEnd;
104
106
  /** The Treasury Order prices figure — the previous
105
107
  * September's CPI, as a percentage. Sourced, not derived. */
106
108
  readonly septemberCpiPct: number;
107
- /** The in-service revaluation applied, as a percentage. */
108
- readonly ratePct: number;
109
109
  /** ISO date the MEMBER'S POT moves — not the date the order
110
110
  * commences. Every Revaluation Order commences 1 April; the
111
111
  * NHS scheme moved its own application to 6 April from 2023
@@ -125,22 +125,21 @@ export interface RevaluationYear {
125
125
  /** The bonus the scheme adds to CPI while a member is paying
126
126
  * in, in PERCENTAGE POINTS. Added, never compounded. */
127
127
  export declare const ACTIVE_REVAL_BONUS_PCT = 1.5;
128
- /** In-service revaluation, oldest first. Extend when the next
129
- * Revaluation Order is made — a year's rate is known months
130
- * before the year it applies to ends. */
128
+ /** In-service revaluation, oldest first, each year a `SchemeYearEnd`. */
131
129
  export declare const IN_SERVICE_REVALUATION: readonly RevaluationYear[];
132
130
  /** The published rate for a scheme year, or null where the
133
131
  * year isn't published — never a silent fallback. */
134
- export declare function revaluationFor(yearEnd: number): RevaluationYear | null;
132
+ export declare function revaluationFor(yearEnd: SchemeYearEnd): RevaluationYear | null;
135
133
  /**
136
134
  * The date the pot moves for a given scheme year: 6 April from
137
- * 2023, 1 April before it — read off the table, never assumed.
135
+ * 2023, 1 April before it — read off the table where the year's
136
+ * Order is held, and 6 April, the scheme's day since 2023, for a
137
+ * year whose Order is not yet made.
138
138
  *
139
139
  * Lives here rather than with the uplift rule because two
140
140
  * callers need it and they must agree: the pension steps on
141
- * these days, and so must the ruler that reads it. When they
142
- * disagreed by the five days between 1 and 6 April, a ruler
143
- * anchored in the pre-2023 era counted its own anchor step and
144
- * deflated a year that had not passed.
141
+ * these days, and so must the ruler that reads it, or a ruler
142
+ * anchored before 2023 counts its own anchor step five days
143
+ * early and deflates a year that has not passed.
145
144
  */
146
- export declare function appliedOnFor(yearEnd: number): Date;
145
+ export declare function appliedOnFor(yearEnd: SchemeYearEnd): Date;
@@ -20,10 +20,10 @@
20
20
  *
21
21
  * "HM Treasury HCWS437 — Public Service Pension
22
22
  * Scheme Indexation and Revaluation 2025", the
23
- * Chief Secretary's annual written ministerial statement. Its
24
- * per-scheme table gives NHS active revaluation as 3.2%
25
- * independently of the Order and of the valuation report, and
26
- * states why the date moved to 6 April.
23
+ * Chief Secretary's annual written ministerial statement. It
24
+ * states why the date moved to 6 April, and its per-scheme table
25
+ * is a source of the applied-rate fixture, independent of the
26
+ * Order and of the valuation report.
27
27
  *
28
28
  * "SPPA NHS Circular 2023/01 — pension indexation and CARE
29
29
  * revaluation" — the clearest annual statement of the exact NHS
@@ -32,8 +32,10 @@
32
32
  *
33
33
  * "NHS Pension Scheme Valuation Report 2020", Appendix E
34
34
  * "Inter-valuation events" — the in-service revaluation as
35
- * ACTUALLY APPLIED, year by year from April 2016. This is the
36
- * rate column's source, and it is independent of the orders.
35
+ * ACTUALLY APPLIED, year by year from April 2016, independent of
36
+ * the orders. No rate is held here: the rule derives it from the
37
+ * Order's CPI (`activeRatePct`), and the applied rates are the
38
+ * test oracle in `tests/fixtures/revaluation-applied.csv`.
37
39
  *
38
40
  * "SI 2015/94 Sch 9 para 3 — revaluation": the NHS Pension
39
41
  * Scheme Regulations 2015 add 1.5 to the prices "increase or
@@ -43,13 +45,12 @@
43
45
  * "NHSBSA KA-02728 — how your pension is revalued", on how it is
44
46
  * applied to members and on the date change below.
45
47
  *
46
- * Cross-checked against the "Revaluation" column of a member's
47
- * Annual Benefit Statement (2015 Section, updated to
48
- * 31/03/2025; name and membership number redacted), which
49
- * quoted 4.6, 11.6, 8.2 and 3.2 for the years to 2025 — the
50
- * rates above as actually applied to a real record, rather
51
- * than as legislated. Nothing else from that document is used
52
- * here: the earnings beside that column are the member's.
48
+ * The fixture is cross-checked against the "Revaluation" column
49
+ * of a member's Annual Benefit Statement (2015 Section, updated
50
+ * to 31/03/2025; name and membership number redacted): the rates
51
+ * as actually applied to a real record, rather than as
52
+ * legislated. Nothing else from that document is used: the
53
+ * earnings beside that column are the member's.
53
54
  * Archived as "Annual Benefit Statement, 2015 Section,
54
55
  * redacted" — see docs/source-archive.md.
55
56
  *
@@ -61,13 +62,13 @@
61
62
  * than letting a scheme-year boundary be assumed.
62
63
  *
63
64
  * **CPI is sourced independently of the rate**, never derived
64
- * from it. Taking `septemberCpiPct = ratePct - 1.5` would make
65
+ * from it. Taking `septemberCpiPct = rate - 1.5` would make
65
66
  * the test that checks the +1.5 rule agree with itself, which
66
- * is no test at all. So the two columns come from two
67
- * documents that do not cite each other: prices from each
68
- * Treasury Order's own operative words, and the rate AS
69
- * APPLIED from the 2020 valuation report's inter-valuation
70
- * table. They agree on all eleven years.
67
+ * is no test at all. So the two come from documents that do
68
+ * not cite each other: prices here, from each Treasury Order's
69
+ * own operative words, and the rate AS APPLIED in a test
70
+ * fixture, from the 2020 valuation report's inter-valuation
71
+ * table and a member's statement.
71
72
  *
72
73
  * **A negative prices figure is carried through, not floored.**
73
74
  * September 2015 CPI was -0.1% and the 2016 order specifies a
@@ -86,9 +87,9 @@
86
87
  * in-service revaluation was applied in April 2016. All eleven
87
88
  * years to 2026 are here, which is what lets a projection walk
88
89
  * a member's whole membership rather than only the part since
89
- * their statement. `revaluationFor` still returns null rather
90
- * than guessing for a year not held — which now means only a
91
- * year whose order has not yet been made.
90
+ * their statement. `revaluationFor` returns null rather than
91
+ * guessing for a year not held: one before 2016, or one whose
92
+ * order has not yet been made.
92
93
  *
93
94
  * ── Not this table ──────────────────────────────────
94
95
  *
@@ -97,13 +98,19 @@
97
98
  * different instrument. For 1995/2008 practitioners the
98
99
  * equivalent uplift is earnings dynamisation, not this.
99
100
  */
101
+ import { schemeYearEnd } from './pension/scheme-year.js';
102
+ /** April, as `Date` counts months from nought. */
103
+ const APRIL_MONTH_INDEX = 3;
104
+ /** The day of April the scheme applies an Order from 2023, and so the day
105
+ * a year with no Order yet is read as moving on. */
106
+ const UPLIFT_DAY_FROM_2023 = 6;
100
107
  /** The bonus the scheme adds to CPI while a member is paying
101
108
  * in, in PERCENTAGE POINTS. Added, never compounded. */
102
109
  export const ACTIVE_REVAL_BONUS_PCT = 1.5;
103
110
  /** In-service revaluation, oldest first. Extend when the next
104
111
  * Revaluation Order is made — a year's rate is known months
105
112
  * before the year it applies to ends. */
106
- export const IN_SERVICE_REVALUATION = [
113
+ const REVALUATION_ROWS = [
107
114
  {
108
115
  // The scheme's FIRST uplift, and the only one from a
109
116
  // negative prices figure: September 2015 CPI was -0.1%
@@ -115,81 +122,72 @@ export const IN_SERVICE_REVALUATION = [
115
122
  // qualifier.
116
123
  yearEnd: 2016,
117
124
  septemberCpiPct: -0.1,
118
- ratePct: 1.4,
119
125
  appliedOn: '2016-04-01',
120
126
  si: 'SI 2016/438',
121
127
  },
122
128
  {
123
129
  yearEnd: 2017,
124
130
  septemberCpiPct: 1.0,
125
- ratePct: 2.5,
126
131
  appliedOn: '2017-04-01',
127
132
  si: 'SI 2017/242',
128
133
  },
129
134
  {
130
135
  yearEnd: 2018,
131
136
  septemberCpiPct: 3.0,
132
- ratePct: 4.5,
133
137
  appliedOn: '2018-04-01',
134
138
  si: 'SI 2018/338',
135
139
  },
136
140
  {
137
141
  yearEnd: 2019,
138
142
  septemberCpiPct: 2.4,
139
- ratePct: 3.9,
140
143
  appliedOn: '2019-04-01',
141
144
  si: 'SI 2019/455',
142
145
  },
143
146
  {
144
147
  yearEnd: 2020,
145
148
  septemberCpiPct: 1.7,
146
- ratePct: 3.2,
147
149
  appliedOn: '2020-04-01',
148
150
  si: 'SI 2020/230',
149
151
  },
150
152
  {
151
153
  yearEnd: 2021,
152
154
  septemberCpiPct: 0.5,
153
- ratePct: 2.0,
154
155
  appliedOn: '2021-04-01',
155
156
  si: 'SI 2021/276',
156
157
  },
157
158
  {
158
159
  yearEnd: 2022,
159
160
  septemberCpiPct: 3.1,
160
- ratePct: 4.6,
161
161
  appliedOn: '2022-04-01',
162
162
  si: 'SI 2022/215',
163
163
  },
164
164
  {
165
165
  yearEnd: 2023,
166
166
  septemberCpiPct: 10.1,
167
- ratePct: 11.6,
168
167
  appliedOn: '2023-04-06',
169
168
  si: 'SI 2023/252',
170
169
  },
171
170
  {
172
171
  yearEnd: 2024,
173
172
  septemberCpiPct: 6.7,
174
- ratePct: 8.2,
175
173
  appliedOn: '2024-04-06',
176
174
  si: 'SI 2024/290',
177
175
  },
178
176
  {
179
177
  yearEnd: 2025,
180
178
  septemberCpiPct: 1.7,
181
- ratePct: 3.2,
182
179
  appliedOn: '2025-04-06',
183
180
  si: 'SI 2025/252',
184
181
  },
185
182
  {
186
183
  yearEnd: 2026,
187
184
  septemberCpiPct: 3.8,
188
- ratePct: 5.3,
189
185
  appliedOn: '2026-04-06',
190
186
  si: 'SI 2026/254',
191
187
  },
192
188
  ];
189
+ /** In-service revaluation, oldest first, each year a `SchemeYearEnd`. */
190
+ export const IN_SERVICE_REVALUATION = REVALUATION_ROWS.map((row) => ({ ...row, yearEnd: schemeYearEnd(row.yearEnd) }));
193
191
  /** The published rate for a scheme year, or null where the
194
192
  * year isn't published — never a silent fallback. */
195
193
  export function revaluationFor(yearEnd) {
@@ -197,19 +195,21 @@ export function revaluationFor(yearEnd) {
197
195
  }
198
196
  /**
199
197
  * The date the pot moves for a given scheme year: 6 April from
200
- * 2023, 1 April before it — read off the table, never assumed.
198
+ * 2023, 1 April before it — read off the table where the year's
199
+ * Order is held, and 6 April, the scheme's day since 2023, for a
200
+ * year whose Order is not yet made.
201
201
  *
202
202
  * Lives here rather than with the uplift rule because two
203
203
  * callers need it and they must agree: the pension steps on
204
- * these days, and so must the ruler that reads it. When they
205
- * disagreed by the five days between 1 and 6 April, a ruler
206
- * anchored in the pre-2023 era counted its own anchor step and
207
- * deflated a year that had not passed.
204
+ * these days, and so must the ruler that reads it, or a ruler
205
+ * anchored before 2023 counts its own anchor step five days
206
+ * early and deflates a year that has not passed.
208
207
  */
209
208
  export function appliedOnFor(yearEnd) {
210
209
  const published = revaluationFor(yearEnd);
211
- if (published === null)
212
- return new Date(yearEnd, 3, 6);
210
+ if (published === null) {
211
+ return new Date(yearEnd, APRIL_MONTH_INDEX, UPLIFT_DAY_FROM_2023);
212
+ }
213
213
  const [y, m, d] = published.appliedOn.split('-').map(Number);
214
214
  // Built LOCAL, matching every other date in this library:
215
215
  // parsing the ISO string gives UTC midnight, and under BST
@@ -1 +1 @@
1
- {"version":3,"file":"revaluation.js","sourceRoot":"","sources":["../src/revaluation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkGG;AA4BH;wDACwD;AACxD,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C;;yCAEyC;AACzC,MAAM,CAAC,MAAM,sBAAsB,GAA+B;IAChE;QACE,qDAAqD;QACrD,uDAAuD;QACvD,yDAAyD;QACzD,uDAAuD;QACvD,wDAAwD;QACxD,wDAAwD;QACxD,qDAAqD;QACrD,aAAa;QACb,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,CAAC,GAAG;QACrB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,IAAI;QACrB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,OAAO,EAAE,GAAG;QACZ,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;CACF,CAAC;AAEF;qDACqD;AACrD,MAAM,UAAU,cAAc,CAC5B,OAAe;IAEf,OAAO,sBAAsB,CAAC,IAAI,CAChC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CACnC,IAAI,IAAI,CAAC;AACZ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC1C,IAAI,SAAS,KAAK,IAAI;QAAE,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7D,0DAA0D;IAC1D,2DAA2D;IAC3D,yCAAyC;IACzC,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/B,CAAC"}
1
+ {"version":3,"file":"revaluation.js","sourceRoot":"","sources":["../src/revaluation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmGG;AAEH,OAAO,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAGvD,kDAAkD;AAClD,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAC5B;qDACqD;AACrD,MAAM,oBAAoB,GAAG,CAAC,CAAC;AA0B/B;wDACwD;AACxD,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAO1C;;yCAEyC;AACzC,MAAM,gBAAgB,GAA8B;IAClD;QACE,qDAAqD;QACrD,uDAAuD;QACvD,yDAAyD;QACzD,uDAAuD;QACvD,wDAAwD;QACxD,wDAAwD;QACxD,qDAAqD;QACrD,aAAa;QACb,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,CAAC,GAAG;QACrB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,IAAI;QACrB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;IACD;QACE,OAAO,EAAE,IAAI;QACb,eAAe,EAAE,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,EAAE,EAAE,aAAa;KAClB;CACF,CAAC;AAEF,yEAAyE;AACzE,MAAM,CAAC,MAAM,sBAAsB,GACjC,gBAAgB,CAAC,GAAG,CAClB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAC,CAAC,CAAC,CAAC;AAE9D;qDACqD;AACrD,MAAM,UAAU,cAAc,CAC5B,OAAsB;IAEtB,OAAO,sBAAsB,CAAC,IAAI,CAChC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CACnC,IAAI,IAAI,CAAC;AACZ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC1C,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7D,0DAA0D;IAC1D,2DAA2D;IAC3D,yCAAyC;IACzC,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/B,CAAC"}
@@ -44,3 +44,9 @@ export interface ScalePoint {
44
44
  export interface SteppedPoint extends ScalePoint {
45
45
  readonly yearsExperience: number;
46
46
  }
47
+ /** A scale's points and the one a member is on, which is one of `points`
48
+ * itself, so it cannot name a point the scale does not have. */
49
+ export interface PayLadder {
50
+ readonly points: readonly SteppedPoint[];
51
+ readonly current: SteppedPoint;
52
+ }
@@ -1,6 +1,5 @@
1
- import type { FactorOutcome } from '../factor-basis.js';
1
+ import type { Factored, FactorOutcome } from '../factor-basis.js';
2
2
  import type { PayPath } from '../pay-path.js';
3
- import type { ProjectionMoney } from '../pension/money.js';
4
3
  import type { Prices } from '../pension/prices.js';
5
4
  /** The fraction of final pay a year of membership earns: an 80th in the
6
5
  * 1995 Section, a 60th in the 2008. */
@@ -47,12 +46,8 @@ export interface UnreducedPension {
47
46
  }
48
47
  /** A final-salary pension and lump sum, before and after factors. */
49
48
  interface FinalSalaryBenefit {
50
- readonly pensionBeforeFactor: ProjectionMoney;
51
- readonly pension: ProjectionMoney;
52
- readonly automaticLumpSum: ProjectionMoney;
53
- readonly automaticLumpSumBeforeFactor: ProjectionMoney;
54
- readonly pensionFactor: FactorOutcome;
55
- readonly automaticLumpSumFactor: FactorOutcome | null;
49
+ readonly pension: Factored;
50
+ readonly automaticLumpSum: Factored<FactorOutcome | null>;
56
51
  readonly membership: number;
57
52
  readonly finalPay: number;
58
53
  }
@@ -7,7 +7,7 @@
7
7
  */
8
8
  import { dayAfter, daysBetween } from '../dates.js';
9
9
  import { moneyAt } from '../pension/money.js';
10
- import { schemeYearEndFor, schemeYearStartDate } from '../pension/seed.js';
10
+ import { schemeYearAfter, schemeYearEnd, schemeYearEndFor, schemeYearStartDate, } from '../pension/scheme-year.js';
11
11
  /** How a section measures final pay, named for an award's provenance.
12
12
  * The measuring itself is each section's own `finalPay`. */
13
13
  export const PAY_MEASURES = {
@@ -42,12 +42,16 @@ export function finalSalaryBenefit(rules, { windows, payPath, dateOfBirth, leavi
42
42
  const lumpSum = lumpFactor === null ? 0 : unreducedLump * lumpFactor.factor;
43
43
  const money = (real) => moneyAt({ real, nominal: prices.payAt(real, drawing) }, drawing);
44
44
  return {
45
- pensionBeforeFactor: money(unreduced),
46
- pension: money(unreduced * pensionFactor.factor),
47
- automaticLumpSum: money(lumpSum),
48
- automaticLumpSumBeforeFactor: money(unreducedLump),
49
- pensionFactor,
50
- automaticLumpSumFactor: lumpFactor,
45
+ pension: {
46
+ beforeFactor: money(unreduced),
47
+ after: money(unreduced * pensionFactor.factor),
48
+ factor: pensionFactor,
49
+ },
50
+ automaticLumpSum: {
51
+ beforeFactor: money(unreducedLump),
52
+ after: money(lumpSum),
53
+ factor: lumpFactor,
54
+ },
51
55
  membership,
52
56
  finalPay: pay,
53
57
  };
@@ -147,9 +151,9 @@ function membershipYears(windows) {
147
151
  function yearsTo(payPath, leaving, count) {
148
152
  const last = schemeYearEndFor(leaving);
149
153
  const opened = schemeYearStartDate(last);
150
- const daysIn = daysBetween(opened, schemeYearStartDate(last + 1));
154
+ const daysIn = daysBetween(opened, schemeYearStartDate(schemeYearAfter(last)));
151
155
  const share = (daysBetween(opened, leaving) + 1) / daysIn;
152
- const pay = (year) => payPath.payFor(year).pay;
156
+ const pay = (year) => payPath.payFor(schemeYearEnd(year)).pay;
153
157
  const leftOnYearEnd = share === 1;
154
158
  return Array.from({ length: count }, (_, back) => (leftOnYearEnd
155
159
  ? pay(last - back)