@casomoltd/nhs-pay 0.5.0 → 0.6.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 (49) 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 +6 -7
  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 +17 -3
  24. package/dist/errors.js +24 -4
  25. package/dist/errors.js.map +1 -1
  26. package/dist/index.d.ts +9 -4
  27. package/dist/index.js +7 -2
  28. package/dist/index.js.map +1 -1
  29. package/dist/medical-scales.d.ts +64 -0
  30. package/dist/medical-scales.js +148 -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.js +1 -1
  36. package/dist/post.js.map +1 -1
  37. package/dist/resolver.d.ts +17 -0
  38. package/dist/resolver.js +61 -0
  39. package/dist/resolver.js.map +1 -1
  40. package/dist/role.d.ts +23 -3
  41. package/dist/role.js +1 -2
  42. package/dist/role.js.map +1 -1
  43. package/dist/scale-tables.d.ts +63 -0
  44. package/dist/scale-tables.js +87 -0
  45. package/dist/scale-tables.js.map +1 -0
  46. package/dist/scales.d.ts +1 -1
  47. package/dist/scales.js +1 -1
  48. package/dist/scales.js.map +1 -1
  49. package/package.json +1 -1
@@ -0,0 +1,148 @@
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 "Threshold X · Ny". */
57
+ const consultantByYear = (rows) => rows.map((r) => ({
58
+ label: `Threshold ${r.threshold} · ${r.yearCompleted}y`,
59
+ salary: r.salary,
60
+ }));
61
+ const england = {
62
+ resident: byStage(ENG.doctorsInTraining),
63
+ consultant: consultantByYear(ENG.consultant),
64
+ 'specialty-doctor': byCode(ENG.specialtyDoctor),
65
+ specialist: byCode(ENG.specialist),
66
+ 'salaried-gp': range(ENG.salariedGpRange),
67
+ 'gp-educator': byCode(ENG.gpEducators),
68
+ 'locally-employed-doctor': byCode(ENG.locallyEmployedDoctors),
69
+ 'staff-grade': stepped(scaleSalaries(ENG.closedGrades, (g) => g.code === 'MH01', 'MH01')),
70
+ 'associate-specialist': stepped(scaleSalaries(ENG.closedGrades, (g) => g.code === 'MC01', 'MC01')),
71
+ 'specialty-doctor-2008': byCode(ENG.specialtyDoctor2008),
72
+ 'associate-specialist-2008': byCode(ENG.associateSpecialist2008),
73
+ };
74
+ const scotland = {
75
+ fho1: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Foundation House Officer 1', 'Sco FHO1')),
76
+ fho2: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Foundation House Officer 2', 'Sco FHO2')),
77
+ sho: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade.startsWith('Senior House Officer'), 'Sco SHO')),
78
+ spr: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialist Registrar', 'Sco SpR')),
79
+ str: stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialty Registrar (Full)', 'Sco StR')),
80
+ 'specialty-registrar-core': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialty Registrar (Core Training)', 'Sco StR core')),
81
+ 'specialty-registrar-fixed': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'Specialty Registrar (Fixed Term)', 'Sco StR fixed')),
82
+ 'gp-registrar-sho': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'GP Specialty Registrar (SHO)', 'Sco GP SHO')),
83
+ 'gp-registrar-spr': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'GP Specialty Registrar (SpR)', 'Sco GP SpR')),
84
+ 'gp-registrar-str': stepped(scaleSalaries(SCO.trainingGrades, (g) => g.grade === 'GP Specialty Registrar (StR)', 'Sco GP StR')),
85
+ };
86
+ const wales = {
87
+ consultant: consultantByYear(WAL.consultant),
88
+ str: stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN37', 'Wal MN37')),
89
+ 'specialty-registrar-core': stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN39', 'Wal MN39')),
90
+ 'specialty-registrar-fixed': stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN35', 'Wal MN35')),
91
+ fho1: stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN13', 'Wal MN13')),
92
+ fho2: stepped(scaleSalaries(WAL.trainingGrades, (g) => g.code === 'MN15', 'Wal MN15')),
93
+ 'specialty-doctor': byCode(WAL.specialtyDoctor),
94
+ specialist: byCode(WAL.specialist),
95
+ 'salaried-gp': stepped(WAL.salariedGp.salaries),
96
+ 'staff-grade': stepped(scaleSalaries(WAL.closedGrades, (g) => g.code === 'MH01', 'Wal MH01')),
97
+ 'associate-specialist': stepped(scaleSalaries(WAL.closedGrades, (g) => g.code === 'MC01', 'Wal MC01')),
98
+ 'specialty-doctor-2008': byCode(WAL.specialtyDoctor2008),
99
+ 'associate-specialist-2008': byCode(WAL.associateSpecialist2008),
100
+ 'hospital-practitioner': stepped(scaleSalaries(WAL.closedGrades, (g) => g.code === 'MD01-41', 'Wal HP')),
101
+ };
102
+ const northernIreland = {
103
+ fho1: stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M220', 'NI M220')),
104
+ fho2: stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M230', 'NI M230')),
105
+ str: stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M241', 'NI M241')),
106
+ 'specialty-registrar-fixed': stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M240', 'NI M240')),
107
+ 'specialty-registrar-core': stepped(scaleSalaries(NI.residentGrades, (g) => g.code === 'M242', 'NI M242')),
108
+ 'specialty-doctor': NI.specialtyDoctor.map((r) => ({
109
+ label: `${r.yearsExperience}y (pt ${r.payPoint})`, salary: r.salary,
110
+ })),
111
+ specialist: NI.specialist.map((r) => ({
112
+ label: `${r.yearsExperience}y (pt ${r.payPoint})`, salary: r.salary,
113
+ })),
114
+ consultant: NI.consultant.map((r) => ({
115
+ label: `Threshold ${r.threshold} · pt ${r.payPoint}`, salary: r.salary,
116
+ })),
117
+ 'salaried-gp': range(NI.salariedGpRange),
118
+ 'gp-educator': NI.gpEducators.map((r) => ({ label: r.point, salary: r.salary })),
119
+ 'hospital-practitioner': numbered(NI.hospitalPractitioner),
120
+ 'specialty-doctor-2008': byCode(NI.specialtyDoctor2008),
121
+ 'associate-specialist-2008': byCode(NI.associateSpecialist2008),
122
+ 'associate-specialist': stepped(scaleSalaries(NI.closedGrades, (g) => g.code === 'M080', 'NI M080')),
123
+ 'staff-grade': stepped(scaleSalaries(NI.closedGrades, (g) => g.code === 'M211', 'NI M211')),
124
+ };
125
+ const MEDICAL_SCALES = {
126
+ [TAX_YEARS.Y2026_27]: {
127
+ [NATION_KEYS.england]: england,
128
+ [NATION_KEYS.scotland]: scotland,
129
+ },
130
+ [TAX_YEARS.Y2025_26]: {
131
+ [NATION_KEYS.wales]: wales,
132
+ [NATION_KEYS.northernIreland]: northernIreland,
133
+ },
134
+ };
135
+ /**
136
+ * Tax years this family publishes, newest first — derived from the
137
+ * data so a new pay round can't leave a hand-maintained list stale.
138
+ */
139
+ export const MEDICAL_TAX_YEARS = Object.keys(MEDICAL_SCALES).sort().reverse();
140
+ /**
141
+ * Published doctor grades for a nation and tax year, each with its
142
+ * scale points and salary range. Both args required — no default;
143
+ * an absent grade set throws `ScaleUnavailable`.
144
+ */
145
+ export function getMedicalScales(year, nation) {
146
+ return resolveGradeMetas(MEDICAL_SCALES, MEDICAL_GRADE_IDS, year, nation);
147
+ }
148
+ //# 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,uEAAuE;AACvE,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,MAAM,CAAC,CAAC,aAAa,GAAG;IACvD,MAAM,EAAE,CAAC,CAAC,MAAM;CACjB,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,GAAG,CAAC,CAAC,eAAe,SAAS,CAAC,CAAC,QAAQ,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM;KACpE,CAAC,CAAC;IACH,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpC,KAAK,EAAE,GAAG,CAAC,CAAC,eAAe,SAAS,CAAC,CAAC,QAAQ,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM;KACpE,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.js CHANGED
@@ -35,7 +35,7 @@ export class Post {
35
35
  }
36
36
  /** Member contribution rate (%) for this salary. */
37
37
  get pensionRate() {
38
- return getPensionTiersVO(this.identity.taxYear).rateFor(this.salary);
38
+ return getPensionTiersVO(this.identity.taxYear, this.identity.nation).rateFor(this.salary);
39
39
  }
40
40
  /**
41
41
  * Annual member pension contribution (£) — read from the
package/dist/post.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"post.js","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAMvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAS3C,MAAM,OAAO,IAAI;IAEJ;IACA;IACA;IAHX,YACW,QAAsB,EACtB,MAAc,EACd,IAAU;QAFV,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAM;IAClB,CAAC;IAEJ;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CACf,MAAc,EACd,MAAc,EACd,IAAa,EACb,OAAa,EAAC,IAAI,EAAE,KAAK,EAAC;QAE1B,OAAO,IAAI,IAAI,CAAC,EAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAED,oDAAoD;IACpD,IAAI,WAAW;QACb,OAAO,iBAAiB,CACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,CACtB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED,wDAAwD;IACxD,IAAI,QAAQ;QACV,OAAO,WAAW,CAChB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,WAAW,GAAG,GAAG,EACtB,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,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;CACF"}
1
+ {"version":3,"file":"post.js","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAMvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAS3C,MAAM,OAAO,IAAI;IAEJ;IACA;IACA;IAHX,YACW,QAAsB,EACtB,MAAc,EACd,IAAU;QAFV,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAM;IAClB,CAAC;IAEJ;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CACf,MAAc,EACd,MAAc,EACd,IAAa,EACb,OAAa,EAAC,IAAI,EAAE,KAAK,EAAC;QAE1B,OAAO,IAAI,IAAI,CAAC,EAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAED,oDAAoD;IACpD,IAAI,WAAW;QACb,OAAO,iBAAiB,CACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED,wDAAwD;IACxD,IAAI,QAAQ;QACV,OAAO,WAAW,CAChB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,WAAW,GAAG,GAAG,EACtB,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,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;CACF"}
@@ -12,6 +12,8 @@
12
12
  import type { Nation, TaxYear } from '@casomoltd/paye-calc';
13
13
  import type { AfcBandId } from './scales.js';
14
14
  import type { AfcRegionId } from './regions.js';
15
+ import type { MedicalGradeId } from './medical-scales.js';
16
+ import type { DentalGradeId } from './dental-scales.js';
15
17
  import { Post } from './post.js';
16
18
  /**
17
19
  * The uniform contract every pay family satisfies: build a
@@ -37,3 +39,18 @@ export interface AfcResolver extends PayScaleResolver<AfcBandId> {
37
39
  fromScalePoint(band: AfcBandId, pointLabel: string, region: AfcRegionId, year: TaxYear): Post;
38
40
  }
39
41
  export declare const afcResolver: AfcResolver;
42
+ /**
43
+ * A basic-pay-by-nation resolver (medical, dental) — like the AfC
44
+ * resolver, but its scale-point entry threads a bare {@link Nation}
45
+ * (no HCAS/region), and it stamps a family-specific {@link Role} via
46
+ * the `toRole` builder its factory is given.
47
+ */
48
+ export interface NationScaleResolver<G extends string> extends PayScaleResolver<G> {
49
+ fromScalePoint(grade: G, pointLabel: string, nation: Nation, year: TaxYear): Post;
50
+ }
51
+ /** Medical (doctors) resolver — a grade + point + nation entry. */
52
+ export type MedicalResolver = NationScaleResolver<MedicalGradeId>;
53
+ /** Salaried dental resolver — a grade + point + nation entry. */
54
+ export type DentalResolver = NationScaleResolver<DentalGradeId>;
55
+ export declare const medicalResolver: MedicalResolver;
56
+ export declare const dentalResolver: DentalResolver;
package/dist/resolver.js CHANGED
@@ -13,6 +13,8 @@ import { AFC_TAX_YEARS } from './scales.js';
13
13
  import { afcRegionToNation } from './regions.js';
14
14
  import { getAfcScales } from './bands.js';
15
15
  import { grossSalary } from './hcas.js';
16
+ import { getMedicalScales, MEDICAL_TAX_YEARS } from './medical-scales.js';
17
+ import { getDentalScales, DENTAL_TAX_YEARS } from './dental-scales.js';
16
18
  import { ScaleUnavailable } from './errors.js';
17
19
  import { Post } from './post.js';
18
20
  export const afcResolver = {
@@ -52,4 +54,63 @@ export const afcResolver = {
52
54
  return null;
53
55
  },
54
56
  };
57
+ // Medical & dental scales carry basic pay by nation (no HCAS), so their
58
+ // scale-point entry threads a Nation, not an AfC region. Each family
59
+ // owns the list of years it publishes (MEDICAL/DENTAL_TAX_YEARS, derived
60
+ // from its own tables), which `latestYearFor` probes newest-first.
61
+ /**
62
+ * Grade IDs published for a nation/year, or `[]` if the whole
63
+ * combination is unpublished — a non-throwing probe for `latestYearFor`
64
+ * (which walks years that may not all exist for a nation), distinct
65
+ * from `availableGrades`, which fails loud like the AfC resolver.
66
+ */
67
+ function publishedGrades(load) {
68
+ try {
69
+ return load().map((m) => m.grade);
70
+ }
71
+ catch (e) {
72
+ if (e instanceof ScaleUnavailable) {
73
+ return [];
74
+ }
75
+ throw e;
76
+ }
77
+ }
78
+ /**
79
+ * Build a {@link NationScaleResolver} over a family's `getScales`
80
+ * accessor and its {@link Role} stamp. Both the medical and dental
81
+ * resolvers are this factory with different data and role — the
82
+ * polymorphism the design intends, with no per-family machinery.
83
+ */
84
+ function makeNationScaleResolver(getScales, toRole, years) {
85
+ return {
86
+ fromSalary(salary, nation, year) {
87
+ return Post.fromSalary(salary, nation, year);
88
+ },
89
+ fromScalePoint(grade, pointLabel, nation, year) {
90
+ const meta = getScales(year, nation).find((m) => m.grade === grade);
91
+ if (!meta) {
92
+ throw new ScaleUnavailable(nation, year, grade);
93
+ }
94
+ const point = meta.points.find((p) => p.label === pointLabel);
95
+ if (!point) {
96
+ throw new ScaleUnavailable(nation, year, grade, pointLabel);
97
+ }
98
+ return Post.fromSalary(point.salary, nation, year, toRole(grade, point, nation));
99
+ },
100
+ availableGrades(nation, year) {
101
+ return getScales(year, nation).map((m) => m.grade);
102
+ },
103
+ latestYearFor(gradeId, nation) {
104
+ for (const year of years) {
105
+ const published = publishedGrades(() => getScales(year, nation)).includes(gradeId);
106
+ if (published) {
107
+ return year;
108
+ }
109
+ }
110
+ return null;
111
+ },
112
+ };
113
+ }
114
+ export const medicalResolver = makeNationScaleResolver(getMedicalScales, (grade, point, nation) => ({ kind: 'medical', grade, point, nation }), MEDICAL_TAX_YEARS);
115
+ export const dentalResolver = makeNationScaleResolver(getDentalScales, (grade, point, nation) => ({ kind: 'dental', grade, point, nation }), DENTAL_TAX_YEARS);
55
116
  //# sourceMappingURL=resolver.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,YAAY,EAAC,MAAM,YAAY,CAAC;AACxC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AACtC,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAoC/B,MAAM,CAAC,MAAM,WAAW,GAAgB;IACtC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI;QAC3C,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CACvB,CAAC;QACF,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAC9B,CAAC;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,gBAAgB,CACxB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,CAC/B,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,WAAW,CACvB,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CACxC,CAAC;QACF,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE;YAC1C,IAAI,EAAE,KAAK;YACX,IAAI;YACJ,KAAK;YACL,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,MAAM,EAAE,IAAI;QAC1B,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CACzC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CACd,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,OAAO,EAAE,MAAM;QAC3B,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YAChD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;iBACzC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;YACzC,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAI1C,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,YAAY,EAAC,MAAM,YAAY,CAAC;AACxC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAC,gBAAgB,EAAE,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAExE,OAAO,EAAC,eAAe,EAAE,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAoC/B,MAAM,CAAC,MAAM,WAAW,GAAgB;IACtC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI;QAC3C,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CACvB,CAAC;QACF,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAC9B,CAAC;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,gBAAgB,CACxB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,CAC/B,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,WAAW,CACvB,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CACxC,CAAC;QACF,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE;YAC1C,IAAI,EAAE,KAAK;YACX,IAAI;YACJ,KAAK;YACL,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,MAAM,EAAE,IAAI;QAC1B,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CACzC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CACd,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,OAAO,EAAE,MAAM;QAC3B,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YAChD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;iBACzC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;YACzC,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC;AAEF,wEAAwE;AACxE,qEAAqE;AACrE,yEAAyE;AACzE,mEAAmE;AAEnE;;;;;GAKG;AACH,SAAS,eAAe,CACtB,IAAiC;IAEjC,IAAI,CAAC;QACH,OAAO,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,YAAY,gBAAgB,EAAE,CAAC;YAClC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAkBD;;;;;GAKG;AACH,SAAS,uBAAuB,CAC9B,SAAqE,EACrE,MAA6D,EAC7D,KAAyB;IAEzB,OAAO;QACL,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;QAED,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI;YAC5C,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CACzB,CAAC;YACF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAClD,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAC9B,CAAC;YACF,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,gBAAgB,CACxB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,CAChC,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,UAAU,CACpB,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CACzD,CAAC;QACJ,CAAC;QAED,eAAe,CAAC,MAAM,EAAE,IAAI;YAC1B,OAAO,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACrD,CAAC;QAED,aAAa,CAAC,OAAO,EAAE,MAAM;YAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAE,CACrC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CACxB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpB,IAAI,SAAS,EAAE,CAAC;oBACd,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC;AACJ,CAAC;AAQD,MAAM,CAAC,MAAM,eAAe,GAAoB,uBAAuB,CACrE,gBAAgB,EAChB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC,EACnE,iBAAiB,CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAmB,uBAAuB,CACnE,eAAe,EACf,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC,EAClE,gBAAgB,CACjB,CAAC"}
package/dist/role.d.ts CHANGED
@@ -7,11 +7,13 @@
7
7
  * Resolvers set it and every Post carries one, so a Post is
8
8
  * never an anonymous salary that has forgotten what it is.
9
9
  *
10
- * `afc` and `vsm` ship today; `medical` / `dental` variants
11
- * join when their scales land (Phase 2).
10
+ * `afc`, `vsm`, `medical` and `dental` all ship today.
12
11
  */
13
12
  import type { AfcBandId, ScalePoint } from './scales.js';
14
13
  import type { AfcRegionId } from './regions.js';
14
+ import type { MedicalGradeId } from './medical-scales.js';
15
+ import type { DentalGradeId } from './dental-scales.js';
16
+ import type { Nation } from '@casomoltd/paye-calc';
15
17
  /** An Agenda-for-Change post: a band at a point, in a region. */
16
18
  export interface AfcRole {
17
19
  readonly kind: 'afc';
@@ -19,6 +21,24 @@ export interface AfcRole {
19
21
  readonly point: ScalePoint;
20
22
  readonly region: AfcRegionId;
21
23
  }
24
+ /**
25
+ * A doctor post: a medical grade at a scale point, in a nation.
26
+ * Basic medical pay has no HCAS/region model, so the identity
27
+ * carries a bare {@link Nation}, not an AfC region.
28
+ */
29
+ export interface MedicalRole {
30
+ readonly kind: 'medical';
31
+ readonly grade: MedicalGradeId;
32
+ readonly point: ScalePoint;
33
+ readonly nation: Nation;
34
+ }
35
+ /** A salaried dental post: a dental grade at a scale point, in a nation. */
36
+ export interface DentalRole {
37
+ readonly kind: 'dental';
38
+ readonly grade: DentalGradeId;
39
+ readonly point: ScalePoint;
40
+ readonly nation: Nation;
41
+ }
22
42
  /**
23
43
  * A bare custom salary — an off-scale / very-senior-manager
24
44
  * post with no published scale point. Its identity is the
@@ -27,5 +47,5 @@ export interface AfcRole {
27
47
  export interface VsmRole {
28
48
  readonly kind: 'vsm';
29
49
  }
30
- export type Role = AfcRole | VsmRole;
50
+ export type Role = AfcRole | VsmRole | MedicalRole | DentalRole;
31
51
  export type RoleKind = Role['kind'];
package/dist/role.js CHANGED
@@ -7,8 +7,7 @@
7
7
  * Resolvers set it and every Post carries one, so a Post is
8
8
  * never an anonymous salary that has forgotten what it is.
9
9
  *
10
- * `afc` and `vsm` ship today; `medical` / `dental` variants
11
- * join when their scales land (Phase 2).
10
+ * `afc`, `vsm`, `medical` and `dental` all ship today.
12
11
  */
13
12
  export {};
14
13
  //# sourceMappingURL=role.js.map
package/dist/role.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"role.js","sourceRoot":"","sources":["../src/role.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG"}
1
+ {"version":3,"file":"role.js","sourceRoot":"","sources":["../src/role.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG"}