@casomoltd/nhs-pay 0.4.15 → 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 (64) 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 +14 -24
  6. package/dist/bands.js +18 -138
  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 +44 -0
  24. package/dist/errors.js +71 -0
  25. package/dist/errors.js.map +1 -0
  26. package/dist/format.d.ts +1 -2
  27. package/dist/format.js +1 -2
  28. package/dist/format.js.map +1 -1
  29. package/dist/hcas-pcts.js +1 -1
  30. package/dist/hcas-pcts.js.map +1 -1
  31. package/dist/hcas.d.ts +17 -7
  32. package/dist/hcas.js +23 -10
  33. package/dist/hcas.js.map +1 -1
  34. package/dist/index.d.ts +16 -4
  35. package/dist/index.js +12 -3
  36. package/dist/index.js.map +1 -1
  37. package/dist/medical-scales.d.ts +64 -0
  38. package/dist/medical-scales.js +148 -0
  39. package/dist/medical-scales.js.map +1 -0
  40. package/dist/pension.d.ts +43 -14
  41. package/dist/pension.js +138 -30
  42. package/dist/pension.js.map +1 -1
  43. package/dist/post.d.ts +50 -0
  44. package/dist/post.js +65 -0
  45. package/dist/post.js.map +1 -0
  46. package/dist/regions.d.ts +0 -5
  47. package/dist/regions.js +0 -19
  48. package/dist/regions.js.map +1 -1
  49. package/dist/resolver.d.ts +56 -0
  50. package/dist/resolver.js +116 -0
  51. package/dist/resolver.js.map +1 -0
  52. package/dist/role.d.ts +51 -0
  53. package/dist/role.js +13 -0
  54. package/dist/role.js.map +1 -0
  55. package/dist/scale-tables.d.ts +63 -0
  56. package/dist/scale-tables.js +87 -0
  57. package/dist/scale-tables.js.map +1 -0
  58. package/dist/scales.d.ts +13 -9
  59. package/dist/scales.js +100 -72
  60. package/dist/scales.js.map +1 -1
  61. package/dist/values.d.ts +19 -0
  62. package/dist/values.js +13 -0
  63. package/dist/values.js.map +1 -0
  64. package/package.json +1 -1
package/dist/format.js CHANGED
@@ -1,7 +1,6 @@
1
1
  /**
2
2
  * GBP and percentage formatting helpers for NHS
3
- * pay data. Consolidates formatters previously split
4
- * across afc-format.ts and calculator format.ts.
3
+ * pay data.
5
4
  */
6
5
  // ── Intl formatters (reused across calls) ───────
7
6
  const gbpFormat = new Intl.NumberFormat('en-GB', {
@@ -1 +1 @@
1
- {"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,mDAAmD;AAEnD,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;IAC/C,KAAK,EAAE,UAAU;IACjB,QAAQ,EAAE,KAAK;IACf,qBAAqB,EAAE,CAAC;CACzB,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,YAAY,CAC5C,OAAO,EACP;IACE,KAAK,EAAE,UAAU;IACjB,QAAQ,EAAE,KAAK;IACf,qBAAqB,EAAE,CAAC;IACxB,qBAAqB,EAAE,CAAC;CACzB,CACF,CAAC;AAEF,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;IAC/C,KAAK,EAAE,SAAS;IAChB,qBAAqB,EAAE,CAAC;IACxB,qBAAqB,EAAE,CAAC;CACzB,CAAC,CAAC;AAEH,mDAAmD;AAEnD,yCAAyC;AACzC,MAAM,UAAU,SAAS,CAAC,CAAS;IACjC,OAAO,CACL,QAAQ;UACN,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAC5B,CAAC;AACJ,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,SAAS,CAAC,CAAS;IACjC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,yCAAyC;AACzC,MAAM,UAAU,gBAAgB,CAC9B,CAAS;IAET,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,8BAA8B;AAC9B,MAAM,UAAU,QAAQ,CAAC,CAAS;IAChC,OAAO,CACL,QAAQ;UACN,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CACxC,CAAC;AACJ,CAAC;AAED,mDAAmD;AAEnD,sCAAsC;AACtC,MAAM,UAAU,MAAM,CAAC,CAAS;IAC9B,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;AAC5B,CAAC;AAED,+CAA+C;AAC/C,MAAM,UAAU,SAAS,CAAC,CAAS;IACjC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;AACnC,CAAC;AAED,mDAAmD;AAEnD,4BAA4B;AAC5B,MAAM,UAAU,SAAS,CAAC,IAAa;IACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAChC,CAAC"}
1
+ {"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,mDAAmD;AAEnD,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;IAC/C,KAAK,EAAE,UAAU;IACjB,QAAQ,EAAE,KAAK;IACf,qBAAqB,EAAE,CAAC;CACzB,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,YAAY,CAC5C,OAAO,EACP;IACE,KAAK,EAAE,UAAU;IACjB,QAAQ,EAAE,KAAK;IACf,qBAAqB,EAAE,CAAC;IACxB,qBAAqB,EAAE,CAAC;CACzB,CACF,CAAC;AAEF,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;IAC/C,KAAK,EAAE,SAAS;IAChB,qBAAqB,EAAE,CAAC;IACxB,qBAAqB,EAAE,CAAC;CACzB,CAAC,CAAC;AAEH,mDAAmD;AAEnD,yCAAyC;AACzC,MAAM,UAAU,SAAS,CAAC,CAAS;IACjC,OAAO,CACL,QAAQ;UACN,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAC5B,CAAC;AACJ,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,SAAS,CAAC,CAAS;IACjC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,yCAAyC;AACzC,MAAM,UAAU,gBAAgB,CAC9B,CAAS;IAET,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,8BAA8B;AAC9B,MAAM,UAAU,QAAQ,CAAC,CAAS;IAChC,OAAO,CACL,QAAQ;UACN,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CACxC,CAAC;AACJ,CAAC;AAED,mDAAmD;AAEnD,sCAAsC;AACtC,MAAM,UAAU,MAAM,CAAC,CAAS;IAC9B,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;AAC5B,CAAC;AAED,+CAA+C;AAC/C,MAAM,UAAU,SAAS,CAAC,CAAS;IACjC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;AACnC,CAAC;AAED,mDAAmD;AAEnD,4BAA4B;AAC5B,MAAM,UAAU,SAAS,CAAC,IAAa;IACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAChC,CAAC"}
package/dist/hcas-pcts.js CHANGED
@@ -8,7 +8,7 @@
8
8
  *
9
9
  * Browser-safe — no node:fs dependency.
10
10
  */
11
- // ── PCT data (from NHS Employers Annex 8) ───────
11
+ // ── PCT data — NHS T&Cs Handbook Annex 8 (HCAS zones) ──
12
12
  const INNER_LONDON_PCTS = [
13
13
  'Hammersmith & Fulham',
14
14
  'Kensington & Chelsea',
@@ -1 +1 @@
1
- {"version":3,"file":"hcas-pcts.js","sourceRoot":"","sources":["../src/hcas-pcts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,mDAAmD;AAEnD,MAAM,iBAAiB,GAAsB;IAC3C,sBAAsB;IACtB,sBAAsB;IACtB,aAAa;IACb,QAAQ;IACR,WAAW;IACX,gBAAgB;IAChB,eAAe;IACf,SAAS;IACT,UAAU;IACV,WAAW;IACX,YAAY;CACb,CAAC;AAEF,MAAM,iBAAiB,GAAsB;IAC3C,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,QAAQ;IACR,SAAS;IACT,UAAU;IACV,oBAAoB;IACpB,UAAU;IACV,QAAQ;IACR,WAAW;IACX,iBAAiB;IACjB,QAAQ;IACR,SAAS;IACT,WAAW;IACX,SAAS;IACT,UAAU;IACV,uBAAuB;IACvB,iBAAiB;CAClB,CAAC;AAEF,MAAM,WAAW,GAAsB;IACrC,+BAA+B;IAC/B,UAAU;IACV,kCAAkC;IAClC,gBAAgB;IAChB,QAAQ;IACR,UAAU;IACV,SAAS;IACT,WAAW;IACX,yCAAyC;IACzC,0BAA0B;IAC1B,uBAAuB;IACvB,wBAAwB;IACxB,kBAAkB;IAClB,mBAAmB;IACnB,QAAQ;IACR,6BAA6B;IAC7B,WAAW;IACX,6BAA6B;IAC7B,aAAa;IACb,sBAAsB;IACtB,cAAc;IACd,yBAAyB;CAC1B,CAAC;AAEF,MAAM,SAAS,GAGT;IACJ,EAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,iBAAiB,EAAC;IAC/C,EAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,iBAAiB,EAAC;IAC/C,EAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAC;CACpC,CAAC;AAEF,mDAAmD;AAEnD,MAAM,SAAS,GACb,IAAI,GAAG,EAAE,CAAC;AAEZ,KAAK,MAAM,EAAC,IAAI,EAAE,IAAI,EAAC,IAAI,SAAS,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;AACH,CAAC;AASD,gDAAgD;AAChD,MAAM,UAAU,WAAW,CACzB,GAAW;IAEX,OAAO,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;AAClD,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,WAAW;IACzB,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,KAAK,MAAM,EAAC,IAAI,EAAE,IAAI,EAAC,IAAI,SAAS,EAAE,CAAC;QACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
1
+ {"version":3,"file":"hcas-pcts.js","sourceRoot":"","sources":["../src/hcas-pcts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,0DAA0D;AAE1D,MAAM,iBAAiB,GAAsB;IAC3C,sBAAsB;IACtB,sBAAsB;IACtB,aAAa;IACb,QAAQ;IACR,WAAW;IACX,gBAAgB;IAChB,eAAe;IACf,SAAS;IACT,UAAU;IACV,WAAW;IACX,YAAY;CACb,CAAC;AAEF,MAAM,iBAAiB,GAAsB;IAC3C,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,QAAQ;IACR,SAAS;IACT,UAAU;IACV,oBAAoB;IACpB,UAAU;IACV,QAAQ;IACR,WAAW;IACX,iBAAiB;IACjB,QAAQ;IACR,SAAS;IACT,WAAW;IACX,SAAS;IACT,UAAU;IACV,uBAAuB;IACvB,iBAAiB;CAClB,CAAC;AAEF,MAAM,WAAW,GAAsB;IACrC,+BAA+B;IAC/B,UAAU;IACV,kCAAkC;IAClC,gBAAgB;IAChB,QAAQ;IACR,UAAU;IACV,SAAS;IACT,WAAW;IACX,yCAAyC;IACzC,0BAA0B;IAC1B,uBAAuB;IACvB,wBAAwB;IACxB,kBAAkB;IAClB,mBAAmB;IACnB,QAAQ;IACR,6BAA6B;IAC7B,WAAW;IACX,6BAA6B;IAC7B,aAAa;IACb,sBAAsB;IACtB,cAAc;IACd,yBAAyB;CAC1B,CAAC;AAEF,MAAM,SAAS,GAGT;IACJ,EAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,iBAAiB,EAAC;IAC/C,EAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,iBAAiB,EAAC;IAC/C,EAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAC;CACpC,CAAC;AAEF,mDAAmD;AAEnD,MAAM,SAAS,GACb,IAAI,GAAG,EAAE,CAAC;AAEZ,KAAK,MAAM,EAAC,IAAI,EAAE,IAAI,EAAC,IAAI,SAAS,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;AACH,CAAC;AASD,gDAAgD;AAChD,MAAM,UAAU,WAAW,CACzB,GAAW;IAEX,OAAO,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;AAClD,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,WAAW;IACzB,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,KAAK,MAAM,EAAC,IAAI,EAAE,IAAI,EAAC,IAAI,SAAS,EAAE,CAAC;QACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
package/dist/hcas.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  * Browser-safe — no node:fs dependency.
6
6
  */
7
7
  import type { TaxYear } from '@casomoltd/paye-calc';
8
- import type { HcasZones } from './scales.js';
8
+ import type { HcasZone, HcasZones } from './scales.js';
9
9
  import type { AfcRegionId } from './regions.js';
10
10
  export declare const HCAS_ZONE_IDS: {
11
11
  readonly INNER_LONDON: "inner-london";
@@ -19,10 +19,20 @@ export declare function isHcasZoneId(value: string): value is HcasZoneId;
19
19
  * Calculate HCAS supplement for a base salary.
20
20
  * Applies percentage rate clamped between min/max.
21
21
  */
22
- export declare function calculateHcasSupplement(baseSalary: number, zone: {
23
- rate: number;
24
- min: number;
25
- max: number;
26
- }): number;
27
- /** Base salary + Wales floor + HCAS supplement. */
22
+ export declare function calculateHcasSupplement(baseSalary: number, zone: HcasZone): number;
23
+ /**
24
+ * Produce a region's gross from a base salary: apply the Wales
25
+ * living-wage floor for Welsh regions, then the HCAS supplement
26
+ * for England high-cost zones.
27
+ *
28
+ * The floor is applied here — not only when building the Welsh
29
+ * scale table (`getScalesForYear`) — because callers regionalise
30
+ * an *England* base (e.g. the band pages, which render England
31
+ * scales for every region) and must still floor Welsh low bands.
32
+ * `applyWalesFloor` is idempotent, so a base already read from
33
+ * the floored Welsh table is unaffected. Do NOT drop the floor
34
+ * here: the table alone does not cover the regionalise path, and
35
+ * removing it silently underpays Welsh low bands (see the
36
+ * grossSalary↔table equivalence test).
37
+ */
28
38
  export declare function grossSalary(base: number, region: AfcRegionId, hcas: HcasZones, year: TaxYear): number;
package/dist/hcas.js CHANGED
@@ -4,8 +4,8 @@
4
4
  *
5
5
  * Browser-safe — no node:fs dependency.
6
6
  */
7
- import { resolveRegion } from './regions.js';
8
7
  import { applyWalesFloor } from './scales.js';
8
+ import { resolveRegion } from './regions.js';
9
9
  export const HCAS_ZONE_IDS = {
10
10
  INNER_LONDON: 'inner-london',
11
11
  OUTER_LONDON: 'outer-london',
@@ -24,16 +24,29 @@ export function calculateHcasSupplement(baseSalary, zone) {
24
24
  const raw = baseSalary * (zone.rate / 100);
25
25
  return Math.round(Math.min(Math.max(raw, zone.min), zone.max));
26
26
  }
27
- /** Base salary + Wales floor + HCAS supplement. */
27
+ /**
28
+ * Produce a region's gross from a base salary: apply the Wales
29
+ * living-wage floor for Welsh regions, then the HCAS supplement
30
+ * for England high-cost zones.
31
+ *
32
+ * The floor is applied here — not only when building the Welsh
33
+ * scale table (`getScalesForYear`) — because callers regionalise
34
+ * an *England* base (e.g. the band pages, which render England
35
+ * scales for every region) and must still floor Welsh low bands.
36
+ * `applyWalesFloor` is idempotent, so a base already read from
37
+ * the floored Welsh table is unaffected. Do NOT drop the floor
38
+ * here: the table alone does not cover the regionalise path, and
39
+ * removing it silently underpays Welsh low bands (see the
40
+ * grossSalary↔table equivalence test).
41
+ */
28
42
  export function grossSalary(base, region, hcas, year) {
29
- const resolved = resolveRegion(region);
30
- let salary = base;
31
- if (resolved.isWales) {
32
- salary = applyWalesFloor(salary, year);
33
- }
34
- if (resolved.hcasProp) {
35
- salary += calculateHcasSupplement(salary, hcas[resolved.hcasProp]);
43
+ const { hcasProp, isWales } = resolveRegion(region);
44
+ const floored = isWales
45
+ ? applyWalesFloor(base, year)
46
+ : base;
47
+ if (!hcasProp) {
48
+ return floored;
36
49
  }
37
- return salary;
50
+ return floored + calculateHcasSupplement(floored, hcas[hcasProp]);
38
51
  }
39
52
  //# sourceMappingURL=hcas.js.map
package/dist/hcas.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"hcas.js","sourceRoot":"","sources":["../src/hcas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAC;AAE5C,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,YAAY,EAAE,cAAc;IAC5B,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;CACR,CAAC;AAOX,MAAM,YAAY,GAChB,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AAE/B,mDAAmD;AACnD,MAAM,UAAU,YAAY,CAC1B,KAAa;IAEb,OACE,YACD,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAkB,EAClB,IAA8C;IAE9C,MAAM,GAAG,GAAG,UAAU,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,WAAW,CACzB,IAAY,EACZ,MAAmB,EACnB,IAAe,EACf,IAAa;IAEb,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtB,MAAM,IAAI,uBAAuB,CAC/B,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAChC,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
1
+ {"version":3,"file":"hcas.js","sourceRoot":"","sources":["../src/hcas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAE3C,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,YAAY,EAAE,cAAc;IAC5B,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;CACR,CAAC;AAOX,MAAM,YAAY,GAChB,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AAE/B,mDAAmD;AACnD,MAAM,UAAU,YAAY,CAC1B,KAAa;IAEb,OACE,YACD,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAkB,EAClB,IAAc;IAEd,MAAM,GAAG,GAAG,UAAU,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CACzB,IAAY,EACZ,MAAmB,EACnB,IAAe,EACf,IAAa;IAEb,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,OAAO;QACrB,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC;QAC7B,CAAC,CAAC,IAAI,CAAC;IACT,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,GAAG,uBAAuB,CACtC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CACxB,CAAC;AACJ,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,17 +1,29 @@
1
1
  export { AFC_BANDS, AFC_BAND_IDS, AFC_HOURS_PER_YEAR, AFC_TAX_YEARS, NLW_HOURLY, WALES_LW_FLOOR, annualiseHourly, applyWalesFloor, } from './scales.js';
2
2
  export type { AfcBandId, HcasZone, HcasZones, ScalePoint, } from './scales.js';
3
- export { getEmployerPensionRate, getPensionTiers, lookupPensionTier, pensionTierRate, } from './pension.js';
3
+ export { PensionTiers, getEmployerPensionRate, getPensionTiers, getPensionTiersVO, lookupPensionTier, pensionTierRate, } from './pension.js';
4
4
  export type { EmployerPensionRate, PensionTier, } from './pension.js';
5
+ export type { SalaryRange } from './values.js';
6
+ export { Post } from './post.js';
7
+ export type { PostIdentity } from './post.js';
8
+ export type { AfcRole, DentalRole, MedicalRole, Role, RoleKind, VsmRole, } from './role.js';
9
+ export { afcResolver, dentalResolver, medicalResolver } from './resolver.js';
10
+ export type { AfcResolver, DentalResolver, MedicalResolver, NationScaleResolver, PayScaleResolver, } from './resolver.js';
11
+ export { MEDICAL_GRADES, MEDICAL_GRADE_IDS, getMedicalScales, } from './medical-scales.js';
12
+ export type { MedicalGradeId, MedicalGradeMeta, } from './medical-scales.js';
13
+ export { DENTAL_GRADES, DENTAL_GRADE_IDS, getDentalScales, } from './dental-scales.js';
14
+ export type { DentalGradeId, DentalGradeMeta, } from './dental-scales.js';
15
+ export { AwardUnavailable, PensionTiersUnavailable, ScaleUnavailable, } from './errors.js';
16
+ export { afcAward } from './award.js';
5
17
  export { ACCRUAL_RATE, COMMUTATION_FACTOR, commute, lookupErf1, lookupLrf1, maxLumpSum, npaDate, periodInYearsMonths, projectPension, retirementFactor, revalue, yearlyAccrual, } from './pension-projection.js';
6
18
  export type { CommutationResult, PensionEstimationInput, PensionProjectionInput, PensionProjectionResult, PensionStatementInput, ProjectionPoint, } from './pension-projection.js';
7
19
  export { HCAS_ZONE_IDS, calculateHcasSupplement, grossSalary, isHcasZoneId, } from './hcas.js';
8
20
  export type { HcasZoneId } from './hcas.js';
9
21
  export { getHcasPcts, getHcasZone, } from './hcas-pcts.js';
10
22
  export type { HcasPct } from './hcas-pcts.js';
11
- export { AFC_REGIONS, ZONE_LABELS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, isAfcRegionId, isNation, resolveRegion, } from './regions.js';
23
+ export { AFC_REGIONS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, isAfcRegionId, isNation, resolveRegion, } from './regions.js';
12
24
  export type { AfcRegionId, ResolvedRegion, } from './regions.js';
13
- export { AFC_BAND_INFO, AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
14
- export type { AfcBandInfo, AfcBandMeta, AfcScaleData, } from './bands.js';
25
+ export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
26
+ export type { AfcBandMeta, AfcScaleData, } from './bands.js';
15
27
  export { nhsTakeHome } from './take-home.js';
16
28
  export { fmtMoney, fmtPct, fmtSalary, formatGBP, formatGBPPrecise, formatPct, yearLabel, } from './format.js';
17
29
  export { TAX_REGIONS, TAX_YEARS, NATIONS, NATION_KEYS, TakeHomePay, GrossAnnual, PensionBasis, PensionPercent, StudentLoanPlan, nationToTaxRegion, getTaxYearConfig, hoursPerYear, } from '@casomoltd/paye-calc';
package/dist/index.js CHANGED
@@ -1,7 +1,16 @@
1
1
  // ── Scales ───────────────────────────────────────
2
2
  export { AFC_BANDS, AFC_BAND_IDS, AFC_HOURS_PER_YEAR, AFC_TAX_YEARS, NLW_HOURLY, WALES_LW_FLOOR, annualiseHourly, applyWalesFloor, } from './scales.js';
3
3
  // ── Pension ──────────────────────────────────────
4
- export { getEmployerPensionRate, getPensionTiers, lookupPensionTier, pensionTierRate, } from './pension.js';
4
+ export { PensionTiers, getEmployerPensionRate, getPensionTiers, getPensionTiersVO, lookupPensionTier, pensionTierRate, } from './pension.js';
5
+ // ── Post & resolvers ─────────────────────────────
6
+ export { Post } from './post.js';
7
+ export { afcResolver, dentalResolver, medicalResolver } from './resolver.js';
8
+ // ── Medical & dental scales ──────────────────────
9
+ export { MEDICAL_GRADES, MEDICAL_GRADE_IDS, getMedicalScales, } from './medical-scales.js';
10
+ export { DENTAL_GRADES, DENTAL_GRADE_IDS, getDentalScales, } from './dental-scales.js';
11
+ export { AwardUnavailable, PensionTiersUnavailable, ScaleUnavailable, } from './errors.js';
12
+ // ── AfC pay award ────────────────────────────────
13
+ export { afcAward } from './award.js';
5
14
  // ── Pension Projection ─────────────────────────────
6
15
  export { ACCRUAL_RATE, COMMUTATION_FACTOR, commute, lookupErf1, lookupLrf1, maxLumpSum, npaDate, periodInYearsMonths, projectPension, retirementFactor, revalue, yearlyAccrual, } from './pension-projection.js';
7
16
  // ── HCAS ─────────────────────────────────────────
@@ -9,9 +18,9 @@ export { HCAS_ZONE_IDS, calculateHcasSupplement, grossSalary, isHcasZoneId, } fr
9
18
  // ── HCAS PCTs ────────────────────────────────────
10
19
  export { getHcasPcts, getHcasZone, } from './hcas-pcts.js';
11
20
  // ── Regions ──────────────────────────────────────
12
- export { AFC_REGIONS, ZONE_LABELS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, isAfcRegionId, isNation, resolveRegion, } from './regions.js';
21
+ export { AFC_REGIONS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, isAfcRegionId, isNation, resolveRegion, } from './regions.js';
13
22
  // ── Bands ────────────────────────────────────────
14
- export { AFC_BAND_INFO, AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
23
+ export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
15
24
  // ── Take-home ────────────────────────────────────
16
25
  export { nhsTakeHome } from './take-home.js';
17
26
  // ── Format ───────────────────────────────────────
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,OAAO,EACL,SAAS,EACT,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,cAAc,EACd,eAAe,EACf,eAAe,GAChB,MAAM,aAAa,CAAC;AAQrB,oDAAoD;AACpD,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,eAAe,GAChB,MAAM,cAAc,CAAC;AAMtB,sDAAsD;AACtD,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,OAAO,EACP,UAAU,EACV,UAAU,EACV,UAAU,EACV,OAAO,EACP,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,aAAa,GACd,MAAM,yBAAyB,CAAC;AAUjC,oDAAoD;AACpD,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,WAAW,EACX,YAAY,GACb,MAAM,WAAW,CAAC;AAGnB,oDAAoD;AACpD,OAAO,EACL,WAAW,EACX,WAAW,GACZ,MAAM,gBAAgB,CAAC;AAGxB,oDAAoD;AACpD,OAAO,EACL,WAAW,EACX,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,aAAa,GACd,MAAM,cAAc,CAAC;AAMtB,oDAAoD;AACpD,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,GACb,MAAM,YAAY,CAAC;AAOpB,oDAAoD;AACpD,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,oDAAoD;AACpD,OAAO,EACL,QAAQ,EACR,MAAM,EACN,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,SAAS,GACV,MAAM,aAAa,CAAC;AAErB,oDAAoD;AACpD,mDAAmD;AACnD,qDAAqD;AACrD,OAAO,EACL,WAAW,EACX,SAAS,EACT,OAAO,EACP,WAAW,EACX,WAAW,EACX,WAAW,EACX,YAAY,EACZ,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,GACb,MAAM,sBAAsB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,OAAO,EACL,SAAS,EACT,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,cAAc,EACd,eAAe,EACf,eAAe,GAChB,MAAM,aAAa,CAAC;AAQrB,oDAAoD;AACpD,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,GAChB,MAAM,cAAc,CAAC;AAStB,oDAAoD;AACpD,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAU/B,OAAO,EAAC,WAAW,EAAE,cAAc,EAAE,eAAe,EAAC,MAAM,eAAe,CAAC;AAS3E,oDAAoD;AACpD,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAK7B,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAK5B,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAErB,oDAAoD;AACpD,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAEpC,sDAAsD;AACtD,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,OAAO,EACP,UAAU,EACV,UAAU,EACV,UAAU,EACV,OAAO,EACP,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,aAAa,GACd,MAAM,yBAAyB,CAAC;AAUjC,oDAAoD;AACpD,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,WAAW,EACX,YAAY,GACb,MAAM,WAAW,CAAC;AAGnB,oDAAoD;AACpD,OAAO,EACL,WAAW,EACX,WAAW,GACZ,MAAM,gBAAgB,CAAC;AAGxB,oDAAoD;AACpD,OAAO,EACL,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,aAAa,GACd,MAAM,cAAc,CAAC;AAMtB,oDAAoD;AACpD,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,GACb,MAAM,YAAY,CAAC;AAMpB,oDAAoD;AACpD,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,oDAAoD;AACpD,OAAO,EACL,QAAQ,EACR,MAAM,EACN,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,SAAS,GACV,MAAM,aAAa,CAAC;AAErB,oDAAoD;AACpD,mDAAmD;AACnD,qDAAqD;AACrD,OAAO,EACL,WAAW,EACX,SAAS,EACT,OAAO,EACP,WAAW,EACX,WAAW,EACX,WAAW,EACX,YAAY,EACZ,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,GACb,MAAM,sBAAsB,CAAC"}
@@ -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,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,15 +1,18 @@
1
1
  /**
2
- * NHS pension tier types, lookup functions, and
3
- * year-specific tier data.
2
+ * NHS pension contributions: member tier types, the
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.
4
7
  *
5
- * Source: https://www.nhsbsa.nhs.uk/member-hub/member-hub-contribution-rates
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.
6
11
  */
7
12
  import type { Nation, TaxYear } from '@casomoltd/paye-calc';
8
- export interface PensionTier {
13
+ import type { SalaryRange } from './values.js';
14
+ export interface PensionTier extends SalaryRange {
9
15
  tier: number;
10
- min: number;
11
- /** Infinity for the top tier */
12
- max: number;
13
16
  rate: number;
14
17
  }
15
18
  /**
@@ -39,6 +42,26 @@ export interface EmployerPensionRate {
39
42
  }
40
43
  /** Employer pension contribution for a nation's NHS scheme. */
41
44
  export declare function getEmployerPensionRate(nation: Nation): EmployerPensionRate;
45
+ /**
46
+ * A member's pension contribution tier table, owning the
47
+ * salary → tier / rate lookup. Wrap a tax year's tiers
48
+ * (see {@link getPensionTiersVO}) and query it directly,
49
+ * rather than re-scanning the array at each call site.
50
+ */
51
+ export declare class PensionTiers {
52
+ private readonly tiers;
53
+ constructor(tiers: readonly PensionTier[]);
54
+ /** Contribution rate (%) for a salary; 0 if unbanded. */
55
+ rateFor(salary: number): number;
56
+ /**
57
+ * Matching tier (1-based) and band for a salary, or
58
+ * null when no band contains it.
59
+ */
60
+ tierFor(salary: number): {
61
+ tier: number;
62
+ band: PensionTier;
63
+ } | null;
64
+ }
42
65
  /**
43
66
  * Pension contribution rate (%) for a salary.
44
67
  */
@@ -53,12 +76,18 @@ export declare function lookupPensionTier(salary: number, tiers: PensionTier[]):
53
76
  band: PensionTier;
54
77
  } | null;
55
78
  /**
56
- * Get member pension contribution tiers for a tax year.
79
+ * Member pension contribution tiers for a nation and tax year.
57
80
  *
58
- * These thresholds are England & Wales (NHSBSA), re-based to the
59
- * AfC pay award each year. Scotland (SPPA) and NI (HSC) share the
60
- * same six contribution *rates* but set their own pay-band
61
- * thresholds, which can place the same salary in a different
62
- * 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.
87
+ */
88
+ export declare function getPensionTiers(year: TaxYear, nation: Nation): PensionTier[];
89
+ /**
90
+ * {@link PensionTiers} value object for a nation and tax year —
91
+ * the same data as {@link getPensionTiers}, ready to query.
63
92
  */
64
- export declare function getPensionTiers(year: TaxYear): PensionTier[];
93
+ export declare function getPensionTiersVO(year: TaxYear, nation: Nation): PensionTiers;