@casomoltd/nhs-pay 0.31.0 → 0.33.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 (142) hide show
  1. package/README.md +25 -22
  2. package/dist/afc-scales.d.ts +43 -10
  3. package/dist/afc-scales.js +50 -16
  4. package/dist/afc-scales.js.map +1 -1
  5. package/dist/allowances.js +11 -11
  6. package/dist/allowances.js.map +1 -1
  7. package/dist/award.d.ts +3 -3
  8. package/dist/award.js +21 -21
  9. package/dist/award.js.map +1 -1
  10. package/dist/circulars/england-md-1-2026-r2.d.ts +13 -0
  11. package/dist/circulars/england-md-1-2026-r2.js +13 -0
  12. package/dist/circulars/england-md-1-2026-r2.js.map +1 -1
  13. package/dist/circulars/ni-hsc-tc8-05-2025.d.ts +22 -0
  14. package/dist/circulars/ni-hsc-tc8-05-2025.js +22 -0
  15. package/dist/circulars/ni-hsc-tc8-05-2025.js.map +1 -1
  16. package/dist/circulars/scotland-pcs-dd-2025-01.d.ts +20 -0
  17. package/dist/circulars/scotland-pcs-dd-2025-01.js +20 -0
  18. package/dist/circulars/scotland-pcs-dd-2025-01.js.map +1 -1
  19. package/dist/circulars/scotland-pcs-dd-2026-01.d.ts +19 -0
  20. package/dist/circulars/scotland-pcs-dd-2026-01.js +30 -10
  21. package/dist/circulars/scotland-pcs-dd-2026-01.js.map +1 -1
  22. package/dist/circulars/scotland-pcs-dd-2026-02.d.ts +10 -0
  23. package/dist/circulars/scotland-pcs-dd-2026-02.js +10 -0
  24. package/dist/circulars/scotland-pcs-dd-2026-02.js.map +1 -1
  25. package/dist/circulars/wales-mdw-01-2025.d.ts +17 -0
  26. package/dist/circulars/wales-mdw-01-2025.js +17 -0
  27. package/dist/circulars/wales-mdw-01-2025.js.map +1 -1
  28. package/dist/circulars/wales-mdw-01-2026.d.ts +20 -0
  29. package/dist/circulars/wales-mdw-01-2026.js +20 -0
  30. package/dist/circulars/wales-mdw-01-2026.js.map +1 -1
  31. package/dist/commutation.js +3 -2
  32. package/dist/commutation.js.map +1 -1
  33. package/dist/dental-grades.d.ts +25 -0
  34. package/dist/dental-grades.js +25 -0
  35. package/dist/dental-grades.js.map +1 -0
  36. package/dist/dental-scales.d.ts +5 -21
  37. package/dist/dental-scales.js +73 -72
  38. package/dist/dental-scales.js.map +1 -1
  39. package/dist/document-source.d.ts +32 -23
  40. package/dist/document-source.js +32 -10
  41. package/dist/document-source.js.map +1 -1
  42. package/dist/errors.d.ts +12 -1
  43. package/dist/errors.js +18 -1
  44. package/dist/errors.js.map +1 -1
  45. package/dist/factor-basis.d.ts +9 -3
  46. package/dist/factor-basis.js +40 -28
  47. package/dist/factor-basis.js.map +1 -1
  48. package/dist/format.js +3 -2
  49. package/dist/format.js.map +1 -1
  50. package/dist/hcas-pcts.d.ts +1 -1
  51. package/dist/hcas-zone.d.ts +23 -0
  52. package/dist/hcas-zone.js +17 -0
  53. package/dist/hcas-zone.js.map +1 -0
  54. package/dist/hcas.d.ts +26 -18
  55. package/dist/hcas.js +45 -24
  56. package/dist/hcas.js.map +1 -1
  57. package/dist/index.d.ts +27 -18
  58. package/dist/index.js +17 -13
  59. package/dist/index.js.map +1 -1
  60. package/dist/medical-grades.d.ts +33 -0
  61. package/dist/medical-grades.js +33 -0
  62. package/dist/medical-grades.js.map +1 -0
  63. package/dist/medical-scales.d.ts +10 -33
  64. package/dist/medical-scales.js +104 -158
  65. package/dist/medical-scales.js.map +1 -1
  66. package/dist/member/benefits.js +9 -4
  67. package/dist/member/benefits.js.map +1 -1
  68. package/dist/member/input-period.d.ts +18 -5
  69. package/dist/member/input-period.js +24 -13
  70. package/dist/member/input-period.js.map +1 -1
  71. package/dist/member/valuation.js +3 -6
  72. package/dist/member/valuation.js.map +1 -1
  73. package/dist/pay-round.js +3 -3
  74. package/dist/pay-round.js.map +1 -1
  75. package/dist/pay-year.d.ts +17 -0
  76. package/dist/pay-year.js +20 -0
  77. package/dist/pay-year.js.map +1 -0
  78. package/dist/pension/ledger.d.ts +7 -0
  79. package/dist/pension/ledger.js +26 -18
  80. package/dist/pension/ledger.js.map +1 -1
  81. package/dist/pension/money.d.ts +2 -0
  82. package/dist/pension/money.js +4 -0
  83. package/dist/pension/money.js.map +1 -1
  84. package/dist/pension/uplift.d.ts +25 -21
  85. package/dist/pension/uplift.js +27 -12
  86. package/dist/pension/uplift.js.map +1 -1
  87. package/dist/pension.js +2 -1
  88. package/dist/pension.js.map +1 -1
  89. package/dist/post.d.ts +20 -21
  90. package/dist/post.js +54 -53
  91. package/dist/post.js.map +1 -1
  92. package/dist/published/england-afc.d.ts +29 -0
  93. package/dist/published/england-afc.js +142 -0
  94. package/dist/published/england-afc.js.map +1 -0
  95. package/dist/published/hcas-zones.d.ts +18 -0
  96. package/dist/published/hcas-zones.js +46 -0
  97. package/dist/published/hcas-zones.js.map +1 -0
  98. package/dist/published/wales-living-wage.d.ts +36 -0
  99. package/dist/published/wales-living-wage.js +30 -0
  100. package/dist/published/wales-living-wage.js.map +1 -0
  101. package/dist/regions.d.ts +25 -14
  102. package/dist/regions.js +61 -71
  103. package/dist/regions.js.map +1 -1
  104. package/dist/resolver.d.ts +46 -41
  105. package/dist/resolver.js +70 -142
  106. package/dist/resolver.js.map +1 -1
  107. package/dist/revaluation.d.ts +27 -11
  108. package/dist/revaluation.js +46 -32
  109. package/dist/revaluation.js.map +1 -1
  110. package/dist/role.d.ts +3 -3
  111. package/dist/scale-point.d.ts +11 -7
  112. package/dist/scale-point.js +29 -1
  113. package/dist/scale-point.js.map +1 -1
  114. package/dist/scale-tables.d.ts +42 -60
  115. package/dist/scale-tables.js +65 -105
  116. package/dist/scale-tables.js.map +1 -1
  117. package/dist/scale-translators.d.ts +90 -0
  118. package/dist/scale-translators.js +97 -0
  119. package/dist/scale-translators.js.map +1 -0
  120. package/dist/scales.d.ts +138 -101
  121. package/dist/scales.js +221 -457
  122. package/dist/scales.js.map +1 -1
  123. package/dist/sections/final-salary.js +3 -11
  124. package/dist/sections/final-salary.js.map +1 -1
  125. package/dist/sections/section-2015.d.ts +1 -3
  126. package/dist/sections/section-2015.js +1 -1
  127. package/dist/sections/section-2015.js.map +1 -1
  128. package/dist/sources.d.ts +12 -12
  129. package/dist/sources.js +13 -15
  130. package/dist/sources.js.map +1 -1
  131. package/dist/take-home.js +1 -2
  132. package/dist/take-home.js.map +1 -1
  133. package/dist/values.d.ts +10 -3
  134. package/dist/values.js +11 -4
  135. package/dist/values.js.map +1 -1
  136. package/dist/working-week.d.ts +23 -8
  137. package/dist/working-week.js +55 -25
  138. package/dist/working-week.js.map +1 -1
  139. package/package.json +3 -3
  140. package/dist/bands.d.ts +0 -63
  141. package/dist/bands.js +0 -78
  142. package/dist/bands.js.map +0 -1
package/dist/bands.d.ts DELETED
@@ -1,63 +0,0 @@
1
- /**
2
- * Merge layer — joins each AfC band id with its
3
- * year-specific salary points and the year's pension
4
- * tiers.
5
- *
6
- * Presentation copy (labels, slugs, role descriptions)
7
- * is a consumer's concern and lives there, not in this
8
- * domain library.
9
- */
10
- import type { PayYear, Nation } from '@casomoltd/paye-calc';
11
- import type { AfcBandId, HcasZones } from './scales.js';
12
- import type { PayLadder, SteppedPoint } from './scale-point.js';
13
- import type { DocumentSource } from './document-source.js';
14
- import type { SalaryRange } from './values.js';
15
- export interface AfcBandMeta {
16
- band: AfcBandId;
17
- points: SteppedPoint[];
18
- salary: SalaryRange;
19
- /** The document that publishes these figures for this nation and
20
- * year — the same value across a nation's bands, because one
21
- * circular publishes the whole ladder. Carried per band anyway so a
22
- * consumer reads a scale's source the same way whichever family it
23
- * is rendering; medical and dental genuinely differ per grade. */
24
- source: DocumentSource;
25
- }
26
- export interface AfcScaleData {
27
- bands: AfcBandMeta[];
28
- hcas: HcasZones;
29
- }
30
- /**
31
- * The AfC PAY year England, Scotland and Wales are currently on.
32
- *
33
- * Typed as a `PayYear`, not left as a bare literal. An unbranded
34
- * literal assigns to `TaxYear` and `PayYear` alike, so every consumer
35
- * passing this into a tax-year parameter compiled silently — and
36
- * several did, reading pension tiers and tax bands at a pay year.
37
- * Annotating it turns that whole class into compile errors.
38
- *
39
- * NOT a site-wide "current year": Northern Ireland is a round behind.
40
- * A consumer resolving figures for a reader's nation wants
41
- * `latestAfcYear(nation)`; a consumer applying deductions wants
42
- * `CURRENT_TAX_YEAR` from paye-calc.
43
- */
44
- export declare const AFC_CURRENT_YEAR: PayYear;
45
- /** The previous AfC pay year, for a year-on-year comparison. */
46
- export declare const AFC_PREVIOUS_YEAR: PayYear;
47
- /** Load AFC scale data — synchronous, no file I/O.
48
- * Scotland and Wales each publish their own ladder; Northern
49
- * Ireland adopts England's. Every figure is transcribed from the
50
- * nation's own instrument, so no nation's scale is computed from
51
- * another's. `year` and `nation` are both required — the accessor
52
- * never defaults a locale, since a forgotten `nation` would
53
- * silently return England figures for every region (the exact bug
54
- * this signature prevents). */
55
- export declare function getAfcScales(year: PayYear, nation: Nation): AfcScaleData;
56
- /**
57
- * The point labelled `label` on an AfC band, with the band's points, for
58
- * a pay year and nation, read from {@link getAfcScales}. Throws
59
- * `ScaleUnavailable` where the year and nation publish no scale or the
60
- * band has no such point, and `AmbiguousScalePoint` where the label names
61
- * more than one, so a caller never prices a point it did not ask for.
62
- */
63
- export declare function afcPointOf(year: PayYear, nation: Nation, band: AfcBandId, label: string): PayLadder;
package/dist/bands.js DELETED
@@ -1,78 +0,0 @@
1
- /**
2
- * Merge layer — joins each AfC band id with its
3
- * year-specific salary points and the year's pension
4
- * tiers.
5
- *
6
- * Presentation copy (labels, slugs, role descriptions)
7
- * is a consumer's concern and lives there, not in this
8
- * domain library.
9
- */
10
- import { TAX_YEARS } from '@casomoltd/paye-calc';
11
- import { AFC_BAND_IDS, afcScaleSource, getScalesForYear, } from './scales.js';
12
- import { AmbiguousScalePoint, ScaleUnavailable } from './errors.js';
13
- /**
14
- * The AfC PAY year England, Scotland and Wales are currently on.
15
- *
16
- * Typed as a `PayYear`, not left as a bare literal. An unbranded
17
- * literal assigns to `TaxYear` and `PayYear` alike, so every consumer
18
- * passing this into a tax-year parameter compiled silently — and
19
- * several did, reading pension tiers and tax bands at a pay year.
20
- * Annotating it turns that whole class into compile errors.
21
- *
22
- * NOT a site-wide "current year": Northern Ireland is a round behind.
23
- * A consumer resolving figures for a reader's nation wants
24
- * `latestAfcYear(nation)`; a consumer applying deductions wants
25
- * `CURRENT_TAX_YEAR` from paye-calc.
26
- */
27
- export const AFC_CURRENT_YEAR = TAX_YEARS.Y2026_27;
28
- /** The previous AfC pay year, for a year-on-year comparison. */
29
- export const AFC_PREVIOUS_YEAR = TAX_YEARS.Y2025_26;
30
- /** Load AFC scale data — synchronous, no file I/O.
31
- * Scotland and Wales each publish their own ladder; Northern
32
- * Ireland adopts England's. Every figure is transcribed from the
33
- * nation's own instrument, so no nation's scale is computed from
34
- * another's. `year` and `nation` are both required — the accessor
35
- * never defaults a locale, since a forgotten `nation` would
36
- * silently return England figures for every region (the exact bug
37
- * this signature prevents). */
38
- export function getAfcScales(year, nation) {
39
- const scaleYear = getScalesForYear(year, nation);
40
- const source = afcScaleSource(year, nation);
41
- const bands = AFC_BAND_IDS.map((band) => {
42
- const points = scaleYear.scales[band];
43
- const salaries = points.map((p) => p.salary);
44
- return {
45
- band,
46
- points,
47
- salary: {
48
- min: Math.min(...salaries),
49
- max: Math.max(...salaries),
50
- },
51
- source,
52
- };
53
- });
54
- return {
55
- bands,
56
- hcas: scaleYear.hcas,
57
- };
58
- }
59
- /**
60
- * The point labelled `label` on an AfC band, with the band's points, for
61
- * a pay year and nation, read from {@link getAfcScales}. Throws
62
- * `ScaleUnavailable` where the year and nation publish no scale or the
63
- * band has no such point, and `AmbiguousScalePoint` where the label names
64
- * more than one, so a caller never prices a point it did not ask for.
65
- */
66
- export function afcPointOf(year, nation, band, label) {
67
- const found = getAfcScales(year, nation).bands.find((b) => b.band === band);
68
- const matches = found?.points.filter((p) => p.label === label) ?? [];
69
- const current = matches.at(0);
70
- if (found === undefined || current === undefined) {
71
- throw new ScaleUnavailable(nation, year, band, label);
72
- }
73
- if (matches.length > 1) {
74
- throw new AmbiguousScalePoint(band, label, matches.length);
75
- }
76
- return { points: found.points, current };
77
- }
78
- //# sourceMappingURL=bands.js.map
package/dist/bands.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"bands.js","sourceRoot":"","sources":["../src/bands.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAM/C,OAAO,EACL,YAAY,EACZ,cAAc,EACd,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAC,mBAAmB,EAAE,gBAAgB,EAAC,MAAM,aAAa,CAAC;AA0BlE;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAY,SAAS,CAAC,QAAQ,CAAC;AAE5D,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAY,SAAS,CAAC,QAAQ,CAAC;AAE7D;;;;;;;gCAOgC;AAChC,MAAM,UAAU,YAAY,CAC1B,IAAa,EACb,MAAc;IAEd,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAE5C,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CACzB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAChB,CAAC;QACF,OAAO;YACL,IAAI;YACJ,MAAM;YACN,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;gBAC1B,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;aAC3B;YACD,MAAM;SACP,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,KAAK;QACL,IAAI,EAAE,SAAS,CAAC,IAAI;KACrB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CACxB,IAAa,EACb,MAAc,EACd,IAAe,EACf,KAAa;IAEb,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC5E,MAAM,OAAO,GAAG,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;IACrE,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACjD,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,mBAAmB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,EAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAC,CAAC;AACzC,CAAC"}