@casomoltd/nhs-pay 0.33.0 → 0.34.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.
package/README.md CHANGED
@@ -333,7 +333,7 @@ Both Welsh years were transcribed during an outage of the NHS Wales web estate (
333
333
  | Pension contribution rates 2025/26 | [NHSBSA contribution rates][pension-2526] |
334
334
  | Income tax / NI rates | gov.uk (via paye-calc) |
335
335
  | National Living Wage | paye-calc (`nationalLivingWageHourly`) |
336
- | HCAS PCT zones | NHS Employers Annex 8 Table 12 |
336
+ | HCAS PCT zones | NHS Employers Annex 8, Tables 12 to 14 |
337
337
 
338
338
  [pension-2526]: https://www.nhsbsa.nhs.uk/nhs-pensions-contribution-rates-202526
339
339
 
@@ -4,10 +4,10 @@
4
4
  *
5
5
  * Its own module because a band id is more primitive than the scale
6
6
  * data: `scales.ts` holds the canonical tables and `afc-scales.ts`
7
- * translates the circulars into them, and both need to name a band. If
8
- * the registry lived with either, the other would import it and the
9
- * two would form a cycle that fails at module load, when the
10
- * translation runs.
7
+ * translates the circulars and England's page into them, and both need
8
+ * to name a band. If the registry lived with either, the other would
9
+ * import it and the two would form a cycle that fails at module load,
10
+ * when the translation runs.
11
11
  *
12
12
  * **Band 1 is absent, deliberately.** Every AfC circular still prints
13
13
  * it. It is closed to new entrants in England, Wales and Northern
package/dist/afc-band.js CHANGED
@@ -4,10 +4,10 @@
4
4
  *
5
5
  * Its own module because a band id is more primitive than the scale
6
6
  * data: `scales.ts` holds the canonical tables and `afc-scales.ts`
7
- * translates the circulars into them, and both need to name a band. If
8
- * the registry lived with either, the other would import it and the
9
- * two would form a cycle that fails at module load, when the
10
- * translation runs.
7
+ * translates the circulars and England's page into them, and both need
8
+ * to name a band. If the registry lived with either, the other would
9
+ * import it and the two would form a cycle that fails at module load,
10
+ * when the translation runs.
11
11
  *
12
12
  * **Band 1 is absent, deliberately.** Every AfC circular still prints
13
13
  * it. It is closed to new entrants in England, Wales and Northern
@@ -1,14 +1,14 @@
1
1
  /**
2
- * Translation layer: AfC circulars → canonical scale points.
2
+ * Translation layer: AfC tables as printed → canonical scale points.
3
3
  *
4
4
  * The counterpart to `medical-scales.ts` for Agenda for Change. The
5
- * verbatim transcriptions in `src/circulars/*` hold each publisher's
6
- * own table shape; this module maps them to the uniform
7
- * `Record<AfcBandId, SteppedPoint[]>` the rest of the library speaks.
8
- *
9
- * **England is the exception:** it publishes no AfC circular, so its
10
- * tables are transcribed from the publisher's page in
11
- * `published/england-afc.ts` (the README's AfC pay scales rule).
5
+ * verbatim transcriptions hold each publisher's own table shape: the
6
+ * devolved nations' circulars in `src/circulars/*`, and England's NHS
7
+ * Employers page in `published/england-afc.ts`, since England publishes
8
+ * no AfC circular (the README's AfC pay scales rule). This module maps
9
+ * them to the uniform `Record<AfcBandId, SteppedPoint[]>` the rest of the
10
+ * library speaks, and reads each one's Band 1 beside it. `scales.ts`
11
+ * pairs each result with its source.
12
12
  *
13
13
  * ── Point labels are DERIVED here, not authored ──
14
14
  *
@@ -25,69 +25,45 @@
25
25
  * nothing to catch it; computed from the transcribed interval, a
26
26
  * mis-read interval produces a wrong label that a fixture row fails on.
27
27
  */
28
- import type { Nation, PayYear } from '@casomoltd/paye-calc';
29
- import type { DocumentSource } from './document-source.js';
30
28
  import type { AfcBandId } from './afc-band.js';
31
29
  import type { SteppedPoint } from './scale-point.js';
32
- /** Band 1 as a nation publishes it, for the one nation still paying it
33
- * to new entrants. */
34
- export interface AfcBand1 {
35
- readonly year: PayYear;
30
+ /** Band 1 as a publisher prints it, before `scales.ts` attaches the year
31
+ * and source it is held under. */
32
+ export interface PrintedBand1 {
36
33
  readonly salary: number;
37
- /** What the circular says about the band's status, verbatim, where it
38
- * says anything — "closed to new entrants" for the three nations
39
- * that print it. Absent for Scotland, whose PCS(AFC)2026/1 carries no
40
- * closure statement and gives Band 1 a full Annex C pay journey, so
41
- * it is a band people are still hired onto. Carried with the figure
42
- * so a consumer stops typing the closure list by hand. */
34
+ /** The publisher's words for the band's status where it gives any:
35
+ * "closed to new entrants" in England, Wales and Northern Ireland,
36
+ * each of which footnotes it so. Absent for Scotland, whose
37
+ * PCS(AFC)2026/1 carries no closure statement and gives Band 1 a full
38
+ * Annex C pay journey, so it is a band people are still hired onto. */
43
39
  readonly note?: string;
44
- readonly source: DocumentSource;
45
40
  }
46
- /** A band's nation, attached from the key it is stored under rather
47
- * than stored beside it — one fact, one producer. */
48
- export interface AfcBand1Published extends AfcBand1 {
49
- readonly nation: Nation;
41
+ /** One nation-year's tables, translated: its ladder, and its Band 1. */
42
+ export interface AfcTables {
43
+ readonly scales: Record<AfcBandId, SteppedPoint[]>;
44
+ readonly band1: PrintedBand1;
50
45
  }
51
46
  /**
52
- * Band 1 for a nation and pay year, or `undefined` where that nation
53
- * publishes none we hold.
54
- *
55
- * Deliberately NOT part of `AFC_BANDS` or the scale list. Band 1 joining
56
- * either shifts every index that reads the list by position, and this
57
- * needs to shift nothing — it is a lookup beside the ladder, not a rung
58
- * added to it.
59
- */
60
- export declare function afcBand1(year: PayYear, nation: Nation): AfcBand1Published | undefined;
61
- /**
62
- * An Agenda for Change point from the year of service it is first
63
- * reached in: the label every nation's scale prints, and the same year
64
- * as a number, so a reader that needs the timing never has to parse it
65
- * back out of the label. The one producer of both, for all four nations.
47
+ * England's tables, read from the NHS Employers pay-scales pages,
48
+ * "NHS Employers — AfC pay scales 2025/26" (#sa-25) and "… 2026/27"
49
+ * (#sa-26), transcribed in `published/england-afc.ts`.
66
50
  */
67
- export declare function afcPoint(year: number, isTop: boolean, salary: number): SteppedPoint;
51
+ export declare const ENGLAND_TABLES_2025_26: AfcTables;
52
+ export declare const ENGLAND_TABLES_2026_27: AfcTables;
68
53
  /**
69
- * Wales's own ladders, read from Annex 1 of "Wales, AfC(W) 02/2025"
54
+ * Wales's own tables, read from Annex 1 of "Wales, AfC(W) 02/2025"
70
55
  * (#sa-44) and "Wales, AfC(W) 02/2026" (#sa-45). They differ from
71
56
  * England's at every band from 4 upward, so England's figures plus a
72
57
  * living-wage floor reproduce neither year: the floor lifts the bottom of
73
58
  * a ladder and cannot raise its top. Band 2 carries two points, as
74
- * England's does. Band 1 is published in both years and closed to new
75
- * entrants; it is absent here because `AFC_BANDS` starts at Band 2, and
76
- * reachable through `afcBand1`.
59
+ * England's does.
77
60
  */
78
- export declare const WALES_SCALES_2025_26: Record<AfcBandId, SteppedPoint[]>;
79
- export declare const WALES_SCALES_2026_27: Record<AfcBandId, SteppedPoint[]>;
61
+ export declare const WALES_TABLES_2025_26: AfcTables;
62
+ export declare const WALES_TABLES_2026_27: AfcTables;
80
63
  /**
81
- * Northern Ireland's ladder, from HSC (AfC) 06/2025 (3 December 2025,
82
- * effective 1 April 2025), translated from NI's own circular.
83
- *
84
- * ONE year. NI has issued no 2026-27 AfC pay circular: the Health
85
- * Minister stated a desire to proceed with 3.3% on 12 February 2026
86
- * "subject to my budgetary position", and as at the Assembly answer of
87
- * 15 July 2026 (AQW 49635/22-27) he "cannot" pay it
88
- * "until I have clarity on my Department's budget". HSC staff are
89
- * on these rates as at that answer. The 3.3% is still recorded in `award.ts` —
90
- * announced and published are different things.
64
+ * Northern Ireland's tables, from HSC (AfC) 06/2025 (3 December 2025,
65
+ * effective 1 April 2025). One year only: the circular's header says why
66
+ * NI has no 2026-27 round.
91
67
  *
92
68
  * The figures are England's for every band, because NI's circular prints
93
69
  * the same numbers. They are read from NI's circular, not England's table,
@@ -99,27 +75,37 @@ export declare const WALES_SCALES_2026_27: Record<AfcBandId, SteppedPoint[]>;
99
75
  * All 29 values are pinned against the circular in
100
76
  * `tests/fixtures/pay-scales.csv`.
101
77
  */
102
- export declare const NI_SCALES_2025_26: Record<AfcBandId, SteppedPoint[]>;
78
+ export declare const NI_TABLES_2025_26: AfcTables;
79
+ /**
80
+ * Scotland's Annex B by year: the salaries against bare point numbers.
81
+ * It gives each year's Band 1, and 2025-26's salaries; only Annex C
82
+ * carries the year of service a label needs.
83
+ */
84
+ declare const SCOTLAND_ANNEX_B: {
85
+ readonly "2025-26": {
86
+ band: string;
87
+ point: number;
88
+ salary: number;
89
+ hourly: number;
90
+ }[];
91
+ readonly "2026-27": {
92
+ band: string;
93
+ point: number;
94
+ salary: number;
95
+ hourly: number;
96
+ }[];
97
+ };
103
98
  /**
104
99
  * Scotland 2026-27, from Annex C: 3.75% on the revised 2025-26 base, so
105
100
  * the inflation guarantee reaches this year too. Source: "Scotland,
106
101
  * PCS(AFC)2026/1" (#sa-13), effective 1 April 2026.
107
102
  *
108
103
  * Annex C rather than Annex B because only Annex C carries the year of
109
- * service. Annex B gives the same salaries against a bare point
110
- * number, which cannot produce a label — `scotlandAnnexB` below exists
111
- * so a fixture can check the two annexes agree.
104
+ * service. Annex B gives the same salaries against a bare point number,
105
+ * which cannot produce a label — `scotlandAnnexB` exists so a fixture
106
+ * can check the two annexes agree.
112
107
  */
113
- export declare const SCOTLAND_SCALES_2026_27: Record<AfcBandId, SteppedPoint[]>;
114
- /**
115
- * Annex B's salaries for a year, keyed by band, in printed order.
116
- *
117
- * Exposed so a test can assert that the annex a label came from and
118
- * the annex the salaries were published in agree. Two annexes of one
119
- * circular disagreeing would mean a transcription error in one of
120
- * them, and nothing else would notice.
121
- */
122
- export declare function scotlandAnnexB(year: '2025-26' | '2026-27'): Map<AfcBandId, number[]>;
108
+ export declare const SCOTLAND_TABLES_2026_27: AfcTables;
123
109
  /**
124
110
  * Scotland 2025-26. Scotland negotiates its own award: the 2025-26
125
111
  * settlement was 4.25% with an inflation guarantee of at least one point
@@ -135,4 +121,14 @@ export declare function scotlandAnnexB(year: '2025-26' | '2026-27'): Map<AfcBand
135
121
  * publishes twice is faithful; re-typing the same increments would
136
122
  * only add a second place to mistype them.
137
123
  */
138
- export declare const SCOTLAND_SCALES_2025_26: Record<AfcBandId, SteppedPoint[]>;
124
+ export declare const SCOTLAND_TABLES_2025_26: AfcTables;
125
+ /**
126
+ * Annex B's salaries for a year, keyed by band, in printed order.
127
+ *
128
+ * Exposed so a test can assert that the annex a label came from and
129
+ * the annex the salaries were published in agree. Two annexes of one
130
+ * circular disagreeing would mean a transcription error in one of
131
+ * them, and nothing else would notice.
132
+ */
133
+ export declare function scotlandAnnexB(year: keyof typeof SCOTLAND_ANNEX_B): Map<AfcBandId, number[]>;
134
+ export {};