@casomoltd/nhs-pay 0.5.0 → 0.7.2

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 (56) hide show
  1. package/README.md +134 -3
  2. package/dist/award.d.ts +32 -0
  3. package/dist/award.js +59 -0
  4. package/dist/award.js.map +1 -0
  5. package/dist/bands.d.ts +8 -8
  6. package/dist/bands.js +6 -8
  7. package/dist/bands.js.map +1 -1
  8. package/dist/circulars/england-md-1-2026r.d.ts +257 -0
  9. package/dist/circulars/england-md-1-2026r.js +302 -0
  10. package/dist/circulars/england-md-1-2026r.js.map +1 -0
  11. package/dist/circulars/ni-hsc-tc8-05-2025.d.ts +166 -0
  12. package/dist/circulars/ni-hsc-tc8-05-2025.js +249 -0
  13. package/dist/circulars/ni-hsc-tc8-05-2025.js.map +1 -0
  14. package/dist/circulars/scotland-pcs-dd-2026-01.d.ts +34 -0
  15. package/dist/circulars/scotland-pcs-dd-2026-01.js +96 -0
  16. package/dist/circulars/scotland-pcs-dd-2026-01.js.map +1 -0
  17. package/dist/circulars/wales-mdw-01-2025.d.ts +130 -0
  18. package/dist/circulars/wales-mdw-01-2025.js +221 -0
  19. package/dist/circulars/wales-mdw-01-2025.js.map +1 -0
  20. package/dist/dental-scales.d.ts +44 -0
  21. package/dist/dental-scales.js +103 -0
  22. package/dist/dental-scales.js.map +1 -0
  23. package/dist/errors.d.ts +33 -5
  24. package/dist/errors.js +44 -6
  25. package/dist/errors.js.map +1 -1
  26. package/dist/index.d.ts +14 -7
  27. package/dist/index.js +8 -3
  28. package/dist/index.js.map +1 -1
  29. package/dist/medical-scales.d.ts +64 -0
  30. package/dist/medical-scales.js +153 -0
  31. package/dist/medical-scales.js.map +1 -0
  32. package/dist/pension.d.ts +18 -15
  33. package/dist/pension.js +99 -25
  34. package/dist/pension.js.map +1 -1
  35. package/dist/post.d.ts +78 -3
  36. package/dist/post.js +59 -6
  37. package/dist/post.js.map +1 -1
  38. package/dist/resolver.d.ts +17 -0
  39. package/dist/resolver.js +61 -0
  40. package/dist/resolver.js.map +1 -1
  41. package/dist/role.d.ts +25 -4
  42. package/dist/role.js +1 -2
  43. package/dist/role.js.map +1 -1
  44. package/dist/scale-point.d.ts +21 -0
  45. package/dist/scale-point.js +2 -0
  46. package/dist/scale-point.js.map +1 -0
  47. package/dist/scale-tables.d.ts +69 -0
  48. package/dist/scale-tables.js +98 -0
  49. package/dist/scale-tables.js.map +1 -0
  50. package/dist/scales.d.ts +2 -5
  51. package/dist/scales.js +1 -1
  52. package/dist/scales.js.map +1 -1
  53. package/dist/take-home.d.ts +36 -7
  54. package/dist/take-home.js +59 -13
  55. package/dist/take-home.js.map +1 -1
  56. package/package.json +2 -2
@@ -0,0 +1,64 @@
1
+ /**
2
+ * Medical (doctors) translation layer.
3
+ *
4
+ * Imports the verbatim circular files (src/circulars/*) and maps their
5
+ * pay tables into the canonical `getMedicalScales(year, nation)` view
6
+ * the resolver reads. This is where the *selection* lives — which
7
+ * scales feed the calculator domain — and the default is inclusive:
8
+ * every substantive salary scale a member could be on is wired,
9
+ * including the devolved training variants and the closed grades.
10
+ *
11
+ * Point granularity: one canonical point per source row, labelled by
12
+ * that row's own step identity (stage / years / pay-scale code /
13
+ * increment), so no pay step is collapsed away.
14
+ *
15
+ * Grades captured in the circulars but not yet wired here (add when a
16
+ * page needs them — they are one mapping line each): England's ultra-
17
+ * legacy closed grades SCMO (KB11), CMO (KB01), pre-2003 consultant
18
+ * (MC21), closed Specialist Registrar (MN25) and closed training
19
+ * variants (MN13/15/21/35/37/39); the second staff-grade scales
20
+ * (England MH03/05, NI M212).
21
+ */
22
+ import type { Nation, TaxYear } from '@casomoltd/paye-calc';
23
+ import type { GradeMeta } from './scale-tables.js';
24
+ /** Doctor grade identifiers wired into the domain. */
25
+ export declare const MEDICAL_GRADES: {
26
+ readonly resident: "resident";
27
+ readonly consultant: "consultant";
28
+ readonly specialtyDoctor: "specialty-doctor";
29
+ readonly specialist: "specialist";
30
+ readonly salariedGp: "salaried-gp";
31
+ readonly gpEducator: "gp-educator";
32
+ readonly locallyEmployedDoctor: "locally-employed-doctor";
33
+ readonly fho1: "fho1";
34
+ readonly fho2: "fho2";
35
+ readonly sho: "sho";
36
+ readonly spr: "spr";
37
+ readonly str: "str";
38
+ readonly specialtyRegistrarCore: "specialty-registrar-core";
39
+ readonly specialtyRegistrarFixed: "specialty-registrar-fixed";
40
+ readonly gpRegistrarSho: "gp-registrar-sho";
41
+ readonly gpRegistrarSpr: "gp-registrar-spr";
42
+ readonly gpRegistrarStr: "gp-registrar-str";
43
+ readonly staffGrade: "staff-grade";
44
+ readonly associateSpecialist: "associate-specialist";
45
+ readonly specialtyDoctor2008: "specialty-doctor-2008";
46
+ readonly associateSpecialist2008: "associate-specialist-2008";
47
+ readonly hospitalPractitioner: "hospital-practitioner";
48
+ };
49
+ export type MedicalGradeId = (typeof MEDICAL_GRADES)[keyof typeof MEDICAL_GRADES];
50
+ /** Ordered grade IDs — stable iteration/enumeration. */
51
+ export declare const MEDICAL_GRADE_IDS: MedicalGradeId[];
52
+ /** A doctor grade's scale points in a nation/year, with its range. */
53
+ export type MedicalGradeMeta = GradeMeta<MedicalGradeId>;
54
+ /**
55
+ * Tax years this family publishes, newest first — derived from the
56
+ * data so a new pay round can't leave a hand-maintained list stale.
57
+ */
58
+ export declare const MEDICAL_TAX_YEARS: readonly TaxYear[];
59
+ /**
60
+ * Published doctor grades for a nation and tax year, each with its
61
+ * scale points and salary range. Both args required — no default;
62
+ * an absent grade set throws `ScaleUnavailable`.
63
+ */
64
+ export declare function getMedicalScales(year: TaxYear, nation: Nation): MedicalGradeMeta[];
@@ -0,0 +1,153 @@
1
+ /**
2
+ * Medical (doctors) translation layer.
3
+ *
4
+ * Imports the verbatim circular files (src/circulars/*) and maps their
5
+ * pay tables into the canonical `getMedicalScales(year, nation)` view
6
+ * the resolver reads. This is where the *selection* lives — which
7
+ * scales feed the calculator domain — and the default is inclusive:
8
+ * every substantive salary scale a member could be on is wired,
9
+ * including the devolved training variants and the closed grades.
10
+ *
11
+ * Point granularity: one canonical point per source row, labelled by
12
+ * that row's own step identity (stage / years / pay-scale code /
13
+ * increment), so no pay step is collapsed away.
14
+ *
15
+ * Grades captured in the circulars but not yet wired here (add when a
16
+ * page needs them — they are one mapping line each): England's ultra-
17
+ * legacy closed grades SCMO (KB11), CMO (KB01), pre-2003 consultant
18
+ * (MC21), closed Specialist Registrar (MN25) and closed training
19
+ * variants (MN13/15/21/35/37/39); the second staff-grade scales
20
+ * (England MH03/05, NI M212).
21
+ */
22
+ import { NATION_KEYS, TAX_YEARS } from '@casomoltd/paye-calc';
23
+ import { byCode, byStage, numbered, range, resolveGradeMetas, scaleSalaries, stepped, } from './scale-tables.js';
24
+ import { ENGLAND_MD_1_2026R as ENG } from './circulars/england-md-1-2026r.js';
25
+ import { SCOTLAND_PCS_DD_2026_01 as SCO } from './circulars/scotland-pcs-dd-2026-01.js';
26
+ import { WALES_MDW_01_2025 as WAL } from './circulars/wales-mdw-01-2025.js';
27
+ import { NI_HSC_TC8_05_2025 as NI } from './circulars/ni-hsc-tc8-05-2025.js';
28
+ /** Doctor grade identifiers wired into the domain. */
29
+ export const MEDICAL_GRADES = {
30
+ resident: 'resident',
31
+ consultant: 'consultant',
32
+ specialtyDoctor: 'specialty-doctor',
33
+ specialist: 'specialist',
34
+ salariedGp: 'salaried-gp',
35
+ gpEducator: 'gp-educator',
36
+ locallyEmployedDoctor: 'locally-employed-doctor',
37
+ fho1: 'fho1',
38
+ fho2: 'fho2',
39
+ sho: 'sho',
40
+ spr: 'spr',
41
+ str: 'str',
42
+ specialtyRegistrarCore: 'specialty-registrar-core',
43
+ specialtyRegistrarFixed: 'specialty-registrar-fixed',
44
+ gpRegistrarSho: 'gp-registrar-sho',
45
+ gpRegistrarSpr: 'gp-registrar-spr',
46
+ gpRegistrarStr: 'gp-registrar-str',
47
+ staffGrade: 'staff-grade',
48
+ associateSpecialist: 'associate-specialist',
49
+ specialtyDoctor2008: 'specialty-doctor-2008',
50
+ associateSpecialist2008: 'associate-specialist-2008',
51
+ hospitalPractitioner: 'hospital-practitioner',
52
+ };
53
+ /** Ordered grade IDs — stable iteration/enumeration. */
54
+ export const MEDICAL_GRADE_IDS = Object.values(MEDICAL_GRADES);
55
+ // ── Mapping helpers ─────────────────────────────
56
+ /** Consultant year-point rows → points labelled by threshold, with the
57
+ * year of completed service carried on the point (not baked into the
58
+ * label) — the same `yearsExperience` axis the SAS scales use. */
59
+ const consultantByYear = (rows) => rows.map((r) => ({
60
+ label: `Threshold ${r.threshold}`,
61
+ salary: r.salary,
62
+ yearsExperience: r.yearCompleted,
63
+ }));
64
+ const england = {
65
+ resident: byStage(ENG.doctorsInTraining),
66
+ consultant: consultantByYear(ENG.consultant),
67
+ 'specialty-doctor': byCode(ENG.specialtyDoctor),
68
+ specialist: byCode(ENG.specialist),
69
+ 'salaried-gp': range(ENG.salariedGpRange),
70
+ 'gp-educator': byCode(ENG.gpEducators),
71
+ 'locally-employed-doctor': byCode(ENG.locallyEmployedDoctors),
72
+ 'staff-grade': stepped(scaleSalaries(ENG.closedGrades, (g) => g.code === 'MH01', 'MH01')),
73
+ 'associate-specialist': stepped(scaleSalaries(ENG.closedGrades, (g) => g.code === 'MC01', 'MC01')),
74
+ 'specialty-doctor-2008': byCode(ENG.specialtyDoctor2008),
75
+ 'associate-specialist-2008': byCode(ENG.associateSpecialist2008),
76
+ };
77
+ const scotland = {
78
+ fho1: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Foundation House Officer 1', 'Sco FHO1')),
79
+ fho2: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Foundation House Officer 2', 'Sco FHO2')),
80
+ sho: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade.startsWith('Senior House Officer'), 'Sco SHO')),
81
+ spr: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialist Registrar', 'Sco SpR')),
82
+ str: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialty Registrar (Full)', 'Sco StR')),
83
+ 'specialty-registrar-core': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialty Registrar (Core Training)', 'Sco StR core')),
84
+ 'specialty-registrar-fixed': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialty Registrar (Fixed Term)', 'Sco StR fixed')),
85
+ 'gp-registrar-sho': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'GP Specialty Registrar (SHO)', 'Sco GP SHO')),
86
+ 'gp-registrar-spr': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'GP Specialty Registrar (SpR)', 'Sco GP SpR')),
87
+ 'gp-registrar-str': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'GP Specialty Registrar (StR)', 'Sco GP StR')),
88
+ };
89
+ const wales = {
90
+ consultant: consultantByYear(WAL.consultant),
91
+ str: stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN37', 'Wal MN37')),
92
+ 'specialty-registrar-core': stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN39', 'Wal MN39')),
93
+ 'specialty-registrar-fixed': stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN35', 'Wal MN35')),
94
+ fho1: stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN13', 'Wal MN13')),
95
+ fho2: stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN15', 'Wal MN15')),
96
+ 'specialty-doctor': byCode(WAL.specialtyDoctor),
97
+ specialist: byCode(WAL.specialist),
98
+ 'salaried-gp': stepped(WAL.salariedGp.salaries),
99
+ 'staff-grade': stepped(scaleSalaries(WAL.closedGrades, (g) => g.code === 'MH01', 'Wal MH01')),
100
+ 'associate-specialist': stepped(scaleSalaries(WAL.closedGrades, (g) => g.code === 'MC01', 'Wal MC01')),
101
+ 'specialty-doctor-2008': byCode(WAL.specialtyDoctor2008),
102
+ 'associate-specialist-2008': byCode(WAL.associateSpecialist2008),
103
+ 'hospital-practitioner': stepped(scaleSalaries(WAL.closedGrades, (g) => g.code === 'MD01-41', 'Wal HP')),
104
+ };
105
+ const northernIreland = {
106
+ fho1: stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M220', 'NI M220')),
107
+ fho2: stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M230', 'NI M230')),
108
+ str: stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M241', 'NI M241')),
109
+ 'specialty-registrar-fixed': stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M240', 'NI M240')),
110
+ 'specialty-registrar-core': stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M242', 'NI M242')),
111
+ 'specialty-doctor': NI.specialtyDoctor.map((r) => ({
112
+ label: `Point ${r.payPoint}`, salary: r.salary,
113
+ yearsExperience: r.yearsExperience,
114
+ })),
115
+ specialist: NI.specialist.map((r) => ({
116
+ label: `Point ${r.payPoint}`, salary: r.salary,
117
+ yearsExperience: r.yearsExperience,
118
+ })),
119
+ consultant: NI.consultant.map((r) => ({
120
+ label: `Threshold ${r.threshold} · pt ${r.payPoint}`, salary: r.salary,
121
+ })),
122
+ 'salaried-gp': range(NI.salariedGpRange),
123
+ 'gp-educator': NI.gpEducators.map((r) => ({ label: r.point, salary: r.salary })),
124
+ 'hospital-practitioner': numbered(NI.hospitalPractitioner),
125
+ 'specialty-doctor-2008': byCode(NI.specialtyDoctor2008),
126
+ 'associate-specialist-2008': byCode(NI.associateSpecialist2008),
127
+ 'associate-specialist': stepped(scaleSalaries(NI.closedGrades, (g) => g.code === 'M080', 'NI M080')),
128
+ 'staff-grade': stepped(scaleSalaries(NI.closedGrades, (g) => g.code === 'M211', 'NI M211')),
129
+ };
130
+ const MEDICAL_SCALES = {
131
+ [TAX_YEARS.Y2026_27]: {
132
+ [NATION_KEYS.england]: england,
133
+ [NATION_KEYS.scotland]: scotland,
134
+ },
135
+ [TAX_YEARS.Y2025_26]: {
136
+ [NATION_KEYS.wales]: wales,
137
+ [NATION_KEYS.northernIreland]: northernIreland,
138
+ },
139
+ };
140
+ /**
141
+ * Tax years this family publishes, newest first — derived from the
142
+ * data so a new pay round can't leave a hand-maintained list stale.
143
+ */
144
+ export const MEDICAL_TAX_YEARS = Object.keys(MEDICAL_SCALES).sort().reverse();
145
+ /**
146
+ * Published doctor grades for a nation and tax year, each with its
147
+ * scale points and salary range. Both args required — no default;
148
+ * an absent grade set throws `ScaleUnavailable`.
149
+ */
150
+ export function getMedicalScales(year, nation) {
151
+ return resolveGradeMetas(MEDICAL_SCALES, MEDICAL_GRADE_IDS, year, nation);
152
+ }
153
+ //# sourceMappingURL=medical-scales.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"medical-scales.js","sourceRoot":"","sources":["../src/medical-scales.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH,OAAO,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAG5D,OAAO,EACL,MAAM,EACN,OAAO,EACP,QAAQ,EACR,KAAK,EACL,iBAAiB,EACjB,aAAa,EACb,OAAO,GACR,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAC,kBAAkB,IAAI,GAAG,EAAC,MAAM,mCAAmC,CAAC;AAC5E,OAAO,EAAC,uBAAuB,IAAI,GAAG,EAAC,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAC,iBAAiB,IAAI,GAAG,EAAC,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAC,kBAAkB,IAAI,EAAE,EAAC,MAAM,mCAAmC,CAAC;AAE3E,sDAAsD;AACtD,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,YAAY;IACxB,eAAe,EAAE,kBAAkB;IACnC,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,aAAa;IACzB,qBAAqB,EAAE,yBAAyB;IAChD,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,sBAAsB,EAAE,0BAA0B;IAClD,uBAAuB,EAAE,2BAA2B;IACpD,cAAc,EAAE,kBAAkB;IAClC,cAAc,EAAE,kBAAkB;IAClC,cAAc,EAAE,kBAAkB;IAClC,UAAU,EAAE,aAAa;IACzB,mBAAmB,EAAE,sBAAsB;IAC3C,mBAAmB,EAAE,uBAAuB;IAC5C,uBAAuB,EAAE,2BAA2B;IACpD,oBAAoB,EAAE,uBAAuB;CACrC,CAAC;AAKX,wDAAwD;AACxD,MAAM,CAAC,MAAM,iBAAiB,GAC5B,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AAKhC,mDAAmD;AAEnD;;mEAEmE;AACnE,MAAM,gBAAgB,GAAG,CACvB,IAA2E,EACpD,EAAE,CACzB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACf,KAAK,EAAE,aAAa,CAAC,CAAC,SAAS,EAAE;IACjC,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB,eAAe,EAAE,CAAC,CAAC,aAAa;CACjC,CAAC,CAAC,CAAC;AAMN,MAAM,OAAO,GAAiB;IAC5B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IACxC,UAAU,EAAE,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC;IAC5C,kBAAkB,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;IAC/C,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC;IAClC,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC;IACzC,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;IACtC,yBAAyB,EAAE,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC;IAC7D,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,MAAM,CAAC,CAAC;IACzF,sBAAsB,EAAE,OAAO,CAC7B,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,MAAM,CAAC,CAClE;IACD,uBAAuB,EAAE,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC;IACxD,2BAA2B,EAAE,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC;CACjE,CAAC;AAEF,MAAM,QAAQ,GAAiB;IAC7B,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,4BAA4B,EAAE,UAAU,CAAC,CAAC;IAC7G,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,4BAA4B,EAAE,UAAU,CAAC,CAAC;IAC7G,GAAG,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,SAAS,CAAC,CAAC;IAC7G,GAAG,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,sBAAsB,EAAE,SAAS,CAAC,CAAC;IACrG,GAAG,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,4BAA4B,EAAE,SAAS,CAAC,CAAC;IAC3G,0BAA0B,EAAE,OAAO,CACjC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,qCAAqC,EAAE,cAAc,CAAC,CAC5G;IACD,2BAA2B,EAAE,OAAO,CAClC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,kCAAkC,EAAE,eAAe,CAAC,CAC1G;IACD,kBAAkB,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,8BAA8B,EAAE,YAAY,CAAC,CAAC;IAC/H,kBAAkB,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,8BAA8B,EAAE,YAAY,CAAC,CAAC;IAC/H,kBAAkB,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,8BAA8B,EAAE,YAAY,CAAC,CAAC;CAChI,CAAC;AAEF,MAAM,KAAK,GAAiB;IAC1B,UAAU,EAAE,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC;IAC5C,GAAG,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IACrF,0BAA0B,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5G,2BAA2B,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7G,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IACtF,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IACtF,kBAAkB,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;IAC/C,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC;IAClC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC;IAC/C,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7F,sBAAsB,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IACtG,uBAAuB,EAAE,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC;IACxD,2BAA2B,EAAE,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC;IAChE,uBAAuB,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,EAAE,QAAQ,CAAC,CAAC;CACzG,CAAC;AAEF,MAAM,eAAe,GAAiB;IACpC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,SAAS,CAAC,CAAC;IACpF,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,SAAS,CAAC,CAAC;IACpF,GAAG,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,SAAS,CAAC,CAAC;IACnF,2BAA2B,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,SAAS,CAAC,CAAC;IAC3G,0BAA0B,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1G,kBAAkB,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACjD,KAAK,EAAE,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM;QAC9C,eAAe,EAAE,CAAC,CAAC,eAAe;KACnC,CAAC,CAAC;IACH,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpC,KAAK,EAAE,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM;QAC9C,eAAe,EAAE,CAAC,CAAC,eAAe;KACnC,CAAC,CAAC;IACH,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpC,KAAK,EAAE,aAAa,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM;KACvE,CAAC,CAAC;IACH,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAAC;IACxC,aAAa,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAC,CAAC,CAAC;IAC9E,uBAAuB,EAAE,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC1D,uBAAuB,EAAE,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC;IACvD,2BAA2B,EAAE,MAAM,CAAC,EAAE,CAAC,uBAAuB,CAAC;IAC/D,sBAAsB,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,SAAS,CAAC,CAAC;IACpG,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,SAAS,CAAC,CAAC;CAC5F,CAAC;AAEF,MAAM,cAAc,GAAqC;IACvD,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;QACpB,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO;QAC9B,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,QAAQ;KACjC;IACD,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;QACpB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK;QAC1B,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,eAAe;KAC/C;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAC5B,MAAM,CAAC,IAAI,CAAC,cAAc,CAC3B,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;AAEnB;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAa,EACb,MAAc;IAEd,OAAO,iBAAiB,CACtB,cAAc,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,CAChD,CAAC;AACJ,CAAC"}
package/dist/pension.d.ts CHANGED
@@ -1,11 +1,13 @@
1
1
  /**
2
2
  * NHS pension contributions: member tier types, the
3
- * `PensionTiers` lookup value object, year-specific tier
4
- * data, and the per-nation employer contribution rates.
3
+ * `PensionTiers` lookup value object, the per-scheme member
4
+ * tier tables (NHSBSA for England & Wales, SPPA for Scotland,
5
+ * HSC for Northern Ireland), and the per-nation employer
6
+ * contribution rates.
5
7
  *
6
- * Sources:
7
- * - Member tiers: https://www.nhsbsa.nhs.uk/member-hub/member-hub-contribution-rates
8
- * - Employer rates: see `EmployerPensionRate.source` per nation below.
8
+ * Member-tier sources are cited per table below and pinned in
9
+ * tests/fixtures/pension-tiers.csv; employer rates carry their
10
+ * own `EmployerPensionRate.source` per nation.
9
11
  */
10
12
  import type { Nation, TaxYear } from '@casomoltd/paye-calc';
11
13
  import type { SalaryRange } from './values.js';
@@ -74,17 +76,18 @@ export declare function lookupPensionTier(salary: number, tiers: PensionTier[]):
74
76
  band: PensionTier;
75
77
  } | null;
76
78
  /**
77
- * Get member pension contribution tiers for a tax year.
79
+ * Member pension contribution tiers for a nation and tax year.
78
80
  *
79
- * These thresholds are England & Wales (NHSBSA), re-based to the
80
- * AfC pay award each year. Scotland (SPPA) and NI (HSC) share the
81
- * same six contribution *rates* but set their own pay-band
82
- * thresholds, which can place the same salary in a different
83
- * tier — do not treat these as UK-wide.
81
+ * The three schemes (NHSBSA for England & Wales, SPPA for Scotland,
82
+ * HSC for Northern Ireland) publish independent tier tables — their
83
+ * thresholds AND rates differ — so the nation is required; there is
84
+ * no UK-wide default. Throws {@link PensionTiersUnavailable} for an
85
+ * unpublished combination rather than substituting another scheme's
86
+ * or year's figures.
84
87
  */
85
- export declare function getPensionTiers(year: TaxYear): PensionTier[];
88
+ export declare function getPensionTiers(year: TaxYear, nation: Nation): PensionTier[];
86
89
  /**
87
- * {@link PensionTiers} value object for a tax year — the
88
- * same data as {@link getPensionTiers}, ready to query.
90
+ * {@link PensionTiers} value object for a nation and tax year —
91
+ * the same data as {@link getPensionTiers}, ready to query.
89
92
  */
90
- export declare function getPensionTiersVO(year: TaxYear): PensionTiers;
93
+ export declare function getPensionTiersVO(year: TaxYear, nation: Nation): PensionTiers;
package/dist/pension.js CHANGED
@@ -1,13 +1,15 @@
1
1
  /**
2
2
  * NHS pension contributions: member tier types, the
3
- * `PensionTiers` lookup value object, year-specific tier
4
- * data, and the per-nation employer contribution rates.
3
+ * `PensionTiers` lookup value object, the per-scheme member
4
+ * tier tables (NHSBSA for England & Wales, SPPA for Scotland,
5
+ * HSC for Northern Ireland), and the per-nation employer
6
+ * contribution rates.
5
7
  *
6
- * Sources:
7
- * - Member tiers: https://www.nhsbsa.nhs.uk/member-hub/member-hub-contribution-rates
8
- * - Employer rates: see `EmployerPensionRate.source` per nation below.
8
+ * Member-tier sources are cited per table below and pinned in
9
+ * tests/fixtures/pension-tiers.csv; employer rates carry their
10
+ * own `EmployerPensionRate.source` per nation.
9
11
  */
10
- import { TAX_YEARS } from '@casomoltd/paye-calc';
12
+ import { NATION_KEYS, TAX_YEARS } from '@casomoltd/paye-calc';
11
13
  import { PensionTiersUnavailable } from './errors.js';
12
14
  // England and Wales share the NHSBSA-administered scheme, so they
13
15
  // share one rate; Scotland (SPPA) and NI (HSC) run their own.
@@ -83,8 +85,32 @@ export function pensionTierRate(salary, tiers) {
83
85
  export function lookupPensionTier(salary, tiers) {
84
86
  return new PensionTiers(tiers).tierFor(salary);
85
87
  }
86
- // ── Tier data by tax year ───────────────────────
87
- const PENSION_TIERS_2025_26 = [
88
+ // ── Member contribution tiers by scheme + year ──
89
+ //
90
+ // Three schemes, not one table per nation: England & Wales share
91
+ // NHSBSA; Scotland is SPPA; Northern Ireland is HSC. They share the
92
+ // tiered-contribution idea but publish their own thresholds AND
93
+ // rates, so the same salary can land in a different tier — and a
94
+ // different rate — by nation. Each rate is a source-cited transcription
95
+ // pinned in tests/fixtures/pension-tiers.csv.
96
+ /** The three NHS pension schemes across the UK. */
97
+ const PENSION_SCHEMES = {
98
+ nhsbsa: 'nhsbsa', // England & Wales
99
+ sppa: 'sppa', // Scotland
100
+ hsc: 'hsc', // Northern Ireland
101
+ };
102
+ const NATION_TO_SCHEME = {
103
+ [NATION_KEYS.england]: PENSION_SCHEMES.nhsbsa,
104
+ [NATION_KEYS.wales]: PENSION_SCHEMES.nhsbsa,
105
+ [NATION_KEYS.scotland]: PENSION_SCHEMES.sppa,
106
+ [NATION_KEYS.northernIreland]: PENSION_SCHEMES.hsc,
107
+ };
108
+ // NHSBSA (England & Wales). Sources (member contribution rates):
109
+ // 2025/26 https://www.nhsbsa.nhs.uk/nhs-pensions-contribution-rates-202526
110
+ // 2026/27 https://www.nhsbsa.nhs.uk/member-hub/cost-being-scheme
111
+ // Six tiers; rates unchanged year-on-year, thresholds re-based to the
112
+ // AfC award. Pinned in tests/fixtures/pension-tiers.csv.
113
+ const NHSBSA_2025_26 = [
88
114
  { tier: 1, min: 0, max: 13259, rate: 0.052 },
89
115
  { tier: 2, min: 13260, max: 27797, rate: 0.065 },
90
116
  { tier: 3, min: 27798, max: 33868, rate: 0.083 },
@@ -92,7 +118,7 @@ const PENSION_TIERS_2025_26 = [
92
118
  { tier: 5, min: 50846, max: 65190, rate: 0.107 },
93
119
  { tier: 6, min: 65191, max: Infinity, rate: 0.125 },
94
120
  ];
95
- const PENSION_TIERS_2026_27 = [
121
+ const NHSBSA_2026_27 = [
96
122
  { tier: 1, min: 0, max: 13259, rate: 0.052 },
97
123
  { tier: 2, min: 13260, max: 28854, rate: 0.065 },
98
124
  { tier: 3, min: 28855, max: 35155, rate: 0.083 },
@@ -100,31 +126,79 @@ const PENSION_TIERS_2026_27 = [
100
126
  { tier: 5, min: 52779, max: 67668, rate: 0.107 },
101
127
  { tier: 6, min: 67669, max: Infinity, rate: 0.125 },
102
128
  ];
103
- const PENSION_TIERS = {
104
- [TAX_YEARS.Y2025_26]: PENSION_TIERS_2025_26,
105
- [TAX_YEARS.Y2026_27]: PENSION_TIERS_2026_27,
129
+ // SPPA (Scotland), from 1 April 2026. Source: SPPA circular 2026/03
130
+ // (9 Mar 2026), Table 2 — bands in 2026/27 terms, applied to a
131
+ // member's current-year annualised pensionable pay:
132
+ // https://pensions.gov.scot/sites/default/files/2026-03/2026_03_-_NHS_Employee_contribution_tier_bandings_from_1_April_2026.pdf
133
+ // Nine tiers; rates differ from NHSBSA. No 2025/26 tier table sourced
134
+ // yet (fail loud).
135
+ const SPPA_2026_27 = [
136
+ { tier: 1, min: 0, max: 13330, rate: 0.057 },
137
+ { tier: 2, min: 13331, max: 28987, rate: 0.064 },
138
+ { tier: 3, min: 28988, max: 34302, rate: 0.07 },
139
+ { tier: 4, min: 34303, max: 43038, rate: 0.087 },
140
+ { tier: 5, min: 43039, max: 45134, rate: 0.098 },
141
+ { tier: 6, min: 45135, max: 54862, rate: 0.105 },
142
+ { tier: 7, min: 54863, max: 59369, rate: 0.112 },
143
+ { tier: 8, min: 59370, max: 83026, rate: 0.116 },
144
+ { tier: 9, min: 83027, max: Infinity, rate: 0.127 },
145
+ ];
146
+ // HSC (Northern Ireland). Source: HSC Pension Service member
147
+ // contribution rates:
148
+ // https://hscpensions.hscni.net/hsc-pension-scheme/hsc-pension-members-section/membership-contributions-pay/
149
+ // Six tiers; rates higher than NHSBSA in tiers 2-6. HSC sets its own
150
+ // thresholds AND rates — the 2025/26 bands differ from NHSBSA 2025/26.
151
+ const HSC_2025_26 = [
152
+ { tier: 1, min: 0, max: 13259, rate: 0.052 },
153
+ { tier: 2, min: 13260, max: 27288, rate: 0.067 },
154
+ { tier: 3, min: 27289, max: 33247, rate: 0.085 },
155
+ { tier: 4, min: 33248, max: 49913, rate: 0.1 },
156
+ { tier: 5, min: 49914, max: 63994, rate: 0.109 },
157
+ { tier: 6, min: 63995, max: Infinity, rate: 0.127 },
158
+ ];
159
+ const HSC_2026_27 = [
160
+ { tier: 1, min: 0, max: 13259, rate: 0.052 },
161
+ { tier: 2, min: 13260, max: 28854, rate: 0.067 },
162
+ { tier: 3, min: 28855, max: 35155, rate: 0.085 },
163
+ { tier: 4, min: 35156, max: 52778, rate: 0.1 },
164
+ { tier: 5, min: 52779, max: 67668, rate: 0.109 },
165
+ { tier: 6, min: 67669, max: Infinity, rate: 0.127 },
166
+ ];
167
+ const PENSION_TIERS_BY_SCHEME = {
168
+ [PENSION_SCHEMES.nhsbsa]: {
169
+ [TAX_YEARS.Y2025_26]: NHSBSA_2025_26,
170
+ [TAX_YEARS.Y2026_27]: NHSBSA_2026_27,
171
+ },
172
+ [PENSION_SCHEMES.sppa]: {
173
+ [TAX_YEARS.Y2026_27]: SPPA_2026_27,
174
+ },
175
+ [PENSION_SCHEMES.hsc]: {
176
+ [TAX_YEARS.Y2025_26]: HSC_2025_26,
177
+ [TAX_YEARS.Y2026_27]: HSC_2026_27,
178
+ },
106
179
  };
107
180
  /**
108
- * Get member pension contribution tiers for a tax year.
181
+ * Member pension contribution tiers for a nation and tax year.
109
182
  *
110
- * These thresholds are England & Wales (NHSBSA), re-based to the
111
- * AfC pay award each year. Scotland (SPPA) and NI (HSC) share the
112
- * same six contribution *rates* but set their own pay-band
113
- * thresholds, which can place the same salary in a different
114
- * tier — do not treat these as UK-wide.
183
+ * The three schemes (NHSBSA for England & Wales, SPPA for Scotland,
184
+ * HSC for Northern Ireland) publish independent tier tables — their
185
+ * thresholds AND rates differ — so the nation is required; there is
186
+ * no UK-wide default. Throws {@link PensionTiersUnavailable} for an
187
+ * unpublished combination rather than substituting another scheme's
188
+ * or year's figures.
115
189
  */
116
- export function getPensionTiers(year) {
117
- const tiers = PENSION_TIERS[year];
190
+ export function getPensionTiers(year, nation) {
191
+ const tiers = PENSION_TIERS_BY_SCHEME[NATION_TO_SCHEME[nation]][year];
118
192
  if (!tiers) {
119
- throw new PensionTiersUnavailable(year);
193
+ throw new PensionTiersUnavailable(year, nation);
120
194
  }
121
195
  return tiers;
122
196
  }
123
197
  /**
124
- * {@link PensionTiers} value object for a tax year — the
125
- * same data as {@link getPensionTiers}, ready to query.
198
+ * {@link PensionTiers} value object for a nation and tax year —
199
+ * the same data as {@link getPensionTiers}, ready to query.
126
200
  */
127
- export function getPensionTiersVO(year) {
128
- return new PensionTiers(getPensionTiers(year));
201
+ export function getPensionTiersVO(year, nation) {
202
+ return new PensionTiers(getPensionTiers(year, nation));
129
203
  }
130
204
  //# sourceMappingURL=pension.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"pension.js","sourceRoot":"","sources":["../src/pension.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EAAC,uBAAuB,EAAC,MAAM,aAAa,CAAC;AAiCpD,kEAAkE;AAClE,8DAA8D;AAC9D,MAAM,oBAAoB,GAAwB;IAChD,IAAI,EAAE,KAAK;IACX,SAAS,EAAE,MAAM;IACjB,aAAa,EAAE,SAAS,CAAC,QAAQ;IACjC,aAAa,EAAE,QAAQ;IACvB,MAAM,EACJ,iFAAiF;CACpF,CAAC;AAEF,MAAM,sBAAsB,GAGxB;IACF,OAAO,EAAE,oBAAoB;IAC7B,KAAK,EAAE,oBAAoB;IAC3B,QAAQ,EAAE;QACR,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,CAAC;QACZ,aAAa,EAAE,SAAS,CAAC,QAAQ;QACjC,aAAa,EAAE,MAAM;QACrB,MAAM,EACJ,gEAAgE;KACnE;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,CAAC;QACZ,aAAa,EAAE,SAAS,CAAC,QAAQ;QACjC,aAAa,EAAE,qBAAqB;QACpC,MAAM,EACJ,wGAAwG;KAC3G;CACF,CAAC;AAEF,+DAA+D;AAC/D,MAAM,UAAU,sBAAsB,CACpC,MAAc;IAEd,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAEJ;IADnB,YACmB,KAA6B;QAA7B,UAAK,GAAL,KAAK,CAAwB;IAC7C,CAAC;IAEJ,yDAAyD;IACzD,OAAO,CAAC,MAAc;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,OAAO,CACL,MAAc;QAEd,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,OAAO,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAC,CAAC;YACjC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAc,EACd,KAAoB;IAEpB,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAc,EACd,KAAoB;IAEpB,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACjD,CAAC;AAED,mDAAmD;AAEnD,MAAM,qBAAqB,GAAkB;IAC3C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC1C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAC;CAClD,CAAC;AAEF,MAAM,qBAAqB,GAAkB;IAC3C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC1C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAC;CAClD,CAAC;AAEF,MAAM,aAAa,GAEf;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,qBAAqB;IAC3C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,qBAAqB;CAC5C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAa;IAEb,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAa;IAEb,OAAO,IAAI,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AACjD,CAAC"}
1
+ {"version":3,"file":"pension.js","sourceRoot":"","sources":["../src/pension.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAC,uBAAuB,EAAC,MAAM,aAAa,CAAC;AAiCpD,kEAAkE;AAClE,8DAA8D;AAC9D,MAAM,oBAAoB,GAAwB;IAChD,IAAI,EAAE,KAAK;IACX,SAAS,EAAE,MAAM;IACjB,aAAa,EAAE,SAAS,CAAC,QAAQ;IACjC,aAAa,EAAE,QAAQ;IACvB,MAAM,EACJ,iFAAiF;CACpF,CAAC;AAEF,MAAM,sBAAsB,GAGxB;IACF,OAAO,EAAE,oBAAoB;IAC7B,KAAK,EAAE,oBAAoB;IAC3B,QAAQ,EAAE;QACR,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,CAAC;QACZ,aAAa,EAAE,SAAS,CAAC,QAAQ;QACjC,aAAa,EAAE,MAAM;QACrB,MAAM,EACJ,gEAAgE;KACnE;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,CAAC;QACZ,aAAa,EAAE,SAAS,CAAC,QAAQ;QACjC,aAAa,EAAE,qBAAqB;QACpC,MAAM,EACJ,wGAAwG;KAC3G;CACF,CAAC;AAEF,+DAA+D;AAC/D,MAAM,UAAU,sBAAsB,CACpC,MAAc;IAEd,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAEJ;IADnB,YACmB,KAA6B;QAA7B,UAAK,GAAL,KAAK,CAAwB;IAC7C,CAAC;IAEJ,yDAAyD;IACzD,OAAO,CAAC,MAAc;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,OAAO,CACL,MAAc;QAEd,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,OAAO,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAC,CAAC;YACjC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAc,EACd,KAAoB;IAEpB,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAc,EACd,KAAoB;IAEpB,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACjD,CAAC;AAED,mDAAmD;AACnD,EAAE;AACF,iEAAiE;AACjE,oEAAoE;AACpE,gEAAgE;AAChE,iEAAiE;AACjE,wEAAwE;AACxE,8CAA8C;AAE9C,mDAAmD;AACnD,MAAM,eAAe,GAAG;IACtB,MAAM,EAAE,QAAQ,EAAE,kBAAkB;IACpC,IAAI,EAAE,MAAM,EAAE,WAAW;IACzB,GAAG,EAAE,KAAK,EAAE,mBAAmB;CACvB,CAAC;AAIX,MAAM,gBAAgB,GAAkC;IACtD,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC,MAAM;IAC7C,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC,MAAM;IAC3C,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC,IAAI;IAC5C,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC,GAAG;CACnD,CAAC;AAEF,iEAAiE;AACjE,6EAA6E;AAC7E,mEAAmE;AACnE,sEAAsE;AACtE,yDAAyD;AACzD,MAAM,cAAc,GAAkB;IACpC,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC1C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAC;CAClD,CAAC;AAEF,MAAM,cAAc,GAAkB;IACpC,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC1C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAC;CAClD,CAAC;AAEF,oEAAoE;AACpE,+DAA+D;AAC/D,oDAAoD;AACpD,gIAAgI;AAChI,sEAAsE;AACtE,mBAAmB;AACnB,MAAM,YAAY,GAAkB;IAClC,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC1C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAC;IAC7C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAC;CAClD,CAAC;AAEF,6DAA6D;AAC7D,sBAAsB;AACtB,6GAA6G;AAC7G,qEAAqE;AACrE,uEAAuE;AACvE,MAAM,WAAW,GAAkB;IACjC,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC1C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAC;IAC5C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAC;CAClD,CAAC;AAEF,MAAM,WAAW,GAAkB;IACjC,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC1C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAC;IAC5C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAC;IAC9C,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAC;CAClD,CAAC;AAEF,MAAM,uBAAuB,GAGzB;IACF,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE;QACxB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,cAAc;QACpC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,cAAc;KACrC;IACD,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;QACtB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,YAAY;KACnC;IACD,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;QACrB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW;QACjC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW;KAClC;CACF,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAa,EACb,MAAc;IAEd,MAAM,KAAK,GACT,uBAAuB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAa,EACb,MAAc;IAEd,OAAO,IAAI,YAAY,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AACzD,CAAC"}
package/dist/post.d.ts CHANGED
@@ -7,19 +7,66 @@
7
7
  * A façade: every derived value delegates to the existing
8
8
  * NHS modules ({@link nhsTakeHome}, {@link PensionTiers});
9
9
  * nothing is absorbed here. A Post never mutates — change
10
- * a value by building a new one (see {@link Post.withSalary}).
10
+ * a value by building a new one (see {@link Post.withSalary},
11
+ * {@link Post.withAdjustments}).
11
12
  */
12
- import type { Nation, TaxYear, TakeHomePay } from '@casomoltd/paye-calc';
13
+ import type { Nation, TaxYear, TakeHomePay, StudentLoanPlan, TaxCode } from '@casomoltd/paye-calc';
13
14
  import type { Role } from './role.js';
14
15
  /** The tax/NI/pension context that fixes a Post. */
15
16
  export interface PostIdentity {
16
17
  readonly nation: Nation;
17
18
  readonly taxYear: TaxYear;
18
19
  }
20
+ /**
21
+ * Personal circumstances layered on a scale post that a bare
22
+ * salary doesn't carry — part-time hours, salary sacrifice,
23
+ * student loans, a tax-code override, and pension opt-out.
24
+ * Every field defaults to "none" ({@link NO_ADJUSTMENTS}), so
25
+ * an unadjusted Post behaves exactly as a plain scale salary.
26
+ *
27
+ * `studentLoans` and `taxCode` are paye-calc's own concerns —
28
+ * a Post carries them so it can build a complete take-home, but
29
+ * forwards them to the engine rather than re-implementing them.
30
+ * `fte` and `salarySacrifice` shape {@link Post.pensionablePay}.
31
+ */
32
+ export interface PostAdjustments {
33
+ /**
34
+ * Fraction of full-time hours worked; 1 = full-time. Since
35
+ * 1 October 2022 the contribution tier and pension are based on
36
+ * ACTUAL (pro-rated) pensionable pay, not whole-time-equivalent —
37
+ * so FTE scales pensionable pay before the tier is chosen.
38
+ * Source: NHSBSA pay & contributions
39
+ * https://www.nhsbsa.nhs.uk/employer-hub/technical-guidance/pay-and-contributions
40
+ */
41
+ readonly fte: number;
42
+ /**
43
+ * Annual salary sacrificed (£). A genuine sacrifice reduces
44
+ * contractual pay, so it lowers the tax- and NI-assessable gross
45
+ * AND — in the default NHS model (England/Wales, and Scotland since
46
+ * December 2023) — pensionable pay too, dropping the pension tier
47
+ * and base. NOT modelled: the Scotland carve-out where cycle-to-work
48
+ * and childcare vouchers leave pensionable pay untouched, and OpRA
49
+ * (post-2017) valuation for non-exempt benefits. In any case salary
50
+ * sacrifice is unavailable to most staff on standard AfC contracts.
51
+ * Sources: BMA salary-sacrifice
52
+ * https://www.bma.org.uk/pay-and-contracts/pensions/pensions-tax/salary-sacrifice-schemes ;
53
+ * NHS Employers https://www.nhsemployers.org/articles/salary-sacrifice-schemes
54
+ */
55
+ readonly salarySacrifice: number;
56
+ /** Student-loan plans being repaid — forwarded to paye-calc. */
57
+ readonly studentLoans: ReadonlySet<StudentLoanPlan>;
58
+ /** Tax-code override (forwarded to paye-calc), or null to derive. */
59
+ readonly taxCode: TaxCode | null;
60
+ /** True when the member has opted out of the NHS pension. */
61
+ readonly pensionOptedOut: boolean;
62
+ }
63
+ /** The identity adjustments: full-time, no sacrifice/loans/override, in-scheme. */
64
+ export declare const NO_ADJUSTMENTS: PostAdjustments;
19
65
  export declare class Post {
20
66
  readonly identity: PostIdentity;
21
67
  readonly salary: number;
22
68
  readonly role: Role;
69
+ readonly adjustments: PostAdjustments;
23
70
  private constructor();
24
71
  /**
25
72
  * Build a Post from a gross salary — whatever the member
@@ -29,9 +76,31 @@ export declare class Post {
29
76
  *
30
77
  * A bare salary is a `vsm` role (an off-scale post); a
31
78
  * scale-point resolver passes the scale identity instead.
79
+ * Personal circumstances are added afterwards with
80
+ * {@link Post.withAdjustments}.
32
81
  */
33
82
  static fromSalary(salary: number, nation: Nation, year: TaxYear, role?: Role): Post;
34
- /** Member contribution rate (%) for this salary. */
83
+ /**
84
+ * Pensionable pay: the pay the NHS pension contribution rate/tier
85
+ * are worked out on. Here = the FTE-pro-rated scale salary less any
86
+ * pensionable-reducing salary sacrifice ({@link PostAdjustments.salarySacrifice}).
87
+ *
88
+ * We treat the whole scale salary (incl. HCAS) as pensionable and do
89
+ * not model non-pensionable elements (overtime above WTE, one-off /
90
+ * non-consolidated awards, expenses). Since 1 October 2022 tiers use
91
+ * ACTUAL (not whole-time-equivalent) pensionable pay. Under this
92
+ * model all salary sacrifice reduces both bases, so pensionable pay
93
+ * also serves as the tax/NI-assessable gross handed to the engine.
94
+ * Sources: NHSBSA 2015 Members Guide
95
+ * https://www.nhsbsa.nhs.uk/sites/default/files/2024-05/2015%20Members%20Guide%20%28V13%29%2005.2024.pdf ;
96
+ * cost of being in the scheme https://www.nhsbsa.nhs.uk/member-hub/cost-being-scheme
97
+ */
98
+ get pensionablePay(): number;
99
+ /**
100
+ * Member contribution rate (%). The tier's single rate applies to
101
+ * the WHOLE of {@link Post.pensionablePay} (a slab/cliff-edge rate,
102
+ * not a marginal band); 0 when opted out.
103
+ */
35
104
  get pensionRate(): number;
36
105
  /**
37
106
  * Annual member pension contribution (£) — read from the
@@ -47,4 +116,10 @@ export declare class Post {
47
116
  get nationalInsurance(): number;
48
117
  /** The same post at a different salary (e.g. a raise). */
49
118
  withSalary(salary: number): Post;
119
+ /**
120
+ * The same post with some personal circumstances changed —
121
+ * merged over the current adjustments, so a caller sets only
122
+ * the fields it cares about (the rest stay at their defaults).
123
+ */
124
+ withAdjustments(patch: Partial<PostAdjustments>): Post;
50
125
  }