@casomoltd/nhs-pay 0.24.2 → 0.26.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
@@ -523,7 +523,11 @@ nation's or year's figures.
523
523
 
524
524
  ## Test fixtures
525
525
 
526
- `tests/fixtures/band-take-home.csv` — 90 golden-value rows
526
+ `tests/working-week.test.ts` pins the AfC week and its 365/7 year
527
+ against every hourly rate Scotland's circular prints beside a salary, and
528
+ the Welsh living-wage pair.
529
+
530
+ `tests/fixtures/band-take-home.csv` — golden-value rows
527
531
  covering bands 5, 7, 8a across all 4 nations (England,
528
532
  Scotland, Wales, NI), both tax years, 3 HCAS zones, and
529
533
  part-time (0.6 FTE). Gross figures are derived from
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export { afcBand1 } from './afc-scales.js';
2
2
  export type { AfcBand1, AfcBand1Published } from './afc-scales.js';
3
- export { AFC_BANDS, AFC_BAND_IDS, AFC_HOURS_PER_YEAR, afcScaleSource, latestAfcYear, payYearLag, isAwaitingPayAward, assertPayYearLagIsSane, afcPayYears, NLW_HOURLY, WALES_LIVING_WAGE, annualiseHourly, } from './scales.js';
3
+ export { AFC_BANDS, AFC_BAND_IDS, afcScaleSource, latestAfcYear, payYearLag, isAwaitingPayAward, assertPayYearLagIsSane, afcPayYears, NLW_HOURLY, WALES_LIVING_WAGE, annualiseHourly, } from './scales.js';
4
4
  export type { AfcBandId, HcasZone, HcasZones, WalesLivingWage, } from './scales.js';
5
5
  export type { ScalePoint } from './scale-point.js';
6
6
  export { PensionTiers, getEmployerPensionRate, getPensionScheme, getPensionTiers, getPensionTiersVO, lookupPensionTier, pensionTierRate, } from './pension.js';
@@ -71,8 +71,9 @@ export { AFC_REGIONS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, is
71
71
  export type { AfcRegionId, ResolvedRegion, } from './regions.js';
72
72
  export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
73
73
  export type { AfcBandMeta, AfcScaleData, } from './bands.js';
74
- export { nhsTakeHome } from './take-home.js';
74
+ export { nhsAnnualAllowance, nhsTakeHome } from './take-home.js';
75
+ export { afcWeekInForce, afcWeeklyHours, hoursPerYear } from './working-week.js';
75
76
  export type { NhsTakeHomeOptions } from './take-home.js';
76
77
  export { fmtMoney, fmtPct, fmtSalary, formatGBP, formatGBPPrecise, formatPct, formatPctPrecise, yearLabel, } from './format.js';
77
- export { TAX_REGIONS, TAX_YEARS, NATIONS, NATION_KEYS, TakeHomePay, GrossAnnual, PensionBasis, PensionPercent, StudentLoanPlan, nationToTaxRegion, getTaxYearConfig, hoursPerYear, } from '@casomoltd/paye-calc';
78
+ export { TAX_REGIONS, TAX_YEARS, NATIONS, NATION_KEYS, TakeHomePay, GrossAnnual, PensionBasis, PensionPercent, StudentLoanPlan, nationToTaxRegion, getTaxYearConfig, } from '@casomoltd/paye-calc';
78
79
  export type { Nation, TaxRegion, TaxYear, PayYear, YearLabel, } from '@casomoltd/paye-calc';
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  // ── Scales ───────────────────────────────────────
2
2
  export { afcBand1 } from './afc-scales.js';
3
- export { AFC_BANDS, AFC_BAND_IDS, AFC_HOURS_PER_YEAR, afcScaleSource, latestAfcYear, payYearLag, isAwaitingPayAward, assertPayYearLagIsSane, afcPayYears, NLW_HOURLY, WALES_LIVING_WAGE, annualiseHourly, } from './scales.js';
3
+ export { AFC_BANDS, AFC_BAND_IDS, afcScaleSource, latestAfcYear, payYearLag, isAwaitingPayAward, assertPayYearLagIsSane, afcPayYears, NLW_HOURLY, WALES_LIVING_WAGE, annualiseHourly, } from './scales.js';
4
4
  // ── Pension ──────────────────────────────────────
5
5
  export { PensionTiers, getEmployerPensionRate, getPensionScheme, getPensionTiers, getPensionTiersVO, lookupPensionTier, pensionTierRate, } from './pension.js';
6
6
  // ── Post & resolvers ─────────────────────────────
@@ -74,11 +74,13 @@ export { AFC_REGIONS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, is
74
74
  // ── Bands ────────────────────────────────────────
75
75
  export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
76
76
  // ── Take-home ────────────────────────────────────
77
- export { nhsTakeHome } from './take-home.js';
77
+ export { nhsAnnualAllowance, nhsTakeHome } from './take-home.js';
78
+ // ── Working week ──────────────────────────────
79
+ export { afcWeekInForce, afcWeeklyHours, hoursPerYear } from './working-week.js';
78
80
  // ── Format ───────────────────────────────────────
79
81
  export { fmtMoney, fmtPct, fmtSalary, formatGBP, formatGBPPrecise, formatPct, formatPctPrecise, yearLabel, } from './format.js';
80
82
  // ── Re-exports from paye-calc ────────────────────
81
83
  // Types that appear in our public API so consumers
82
84
  // don't need a direct paye-calc import for NHS work.
83
- export { TAX_REGIONS, TAX_YEARS, NATIONS, NATION_KEYS, TakeHomePay, GrossAnnual, PensionBasis, PensionPercent, StudentLoanPlan, nationToTaxRegion, getTaxYearConfig, hoursPerYear, } from '@casomoltd/paye-calc';
85
+ export { TAX_REGIONS, TAX_YEARS, NATIONS, NATION_KEYS, TakeHomePay, GrossAnnual, PensionBasis, PensionPercent, StudentLoanPlan, nationToTaxRegion, getTaxYearConfig, } from '@casomoltd/paye-calc';
84
86
  //# sourceMappingURL=index.js.map
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,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAEzC,OAAO,EACL,SAAS,EACT,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,sBAAsB,EACtB,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,eAAe,GAChB,MAAM,aAAa,CAAC;AASrB,oDAAoD;AACpD,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,GAChB,MAAM,cAAc,CAAC;AAUtB,oDAAoD;AACpD,OAAO,EAAC,IAAI,EAAE,cAAc,EAAC,MAAM,WAAW,CAAC;AAU/C,OAAO,EAAC,WAAW,EAAE,cAAc,EAAE,eAAe,EAAC,MAAM,eAAe,CAAC;AAS3E,oDAAoD;AACpD,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAK7B,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAK5B,oDAAoD;AACpD,OAAO,EACL,wBAAwB,EACxB,2BAA2B,EAC3B,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,yBAAyB,CAAC;AAKjC,OAAO,EAAC,yBAAyB,EAAC,MAAM,mCAAmC,CAAC;AAK5E,oDAAoD;AACpD,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAGrB,oDAAoD;AACpD,uEAAuE;AACvE,sEAAsE;AACtE,mCAAmC;AACnC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AACpD,OAAO,EACL,OAAO,EACP,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,WAAW,EACX,SAAS,EACT,SAAS,GACV,MAAM,eAAe,CAAC;AAMvB,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,aAAa,EACb,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,cAAc,EACd,uBAAuB,EACvB,cAAc,EACd,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB,oDAAoD;AACpD,OAAO,EACL,cAAc,EACd,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,SAAS,EACT,UAAU,GACX,MAAM,YAAY,CAAC;AASpB,oDAAoD;AACpD,sEAAsE;AACtE,oDAAoD;AACpD,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAGxC,oDAAoD;AACpD,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAMzB,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,cAAc,GACf,MAAM,kBAAkB,CAAC;AAG1B,sDAAsD;AACtD,sEAAsE;AACtE,uEAAuE;AACvE,YAAY;AACZ,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAC,MAAM,eAAe,CAAC;AAGxE,sDAAsD;AACtD,sEAAsE;AACtE,qEAAqE;AACrE,2BAA2B;AAC3B,OAAO,EACL,QAAQ,EACR,cAAc,EACd,UAAU,EACV,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,cAAc,EACd,QAAQ,GACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AAoBxD,OAAO,EAAC,cAAc,EAAE,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAG9C,sDAAsD;AACtD,iEAAiE;AACjE,iEAAiE;AACjE,sEAAsE;AACtE,iEAAiE;AACjE,qEAAqE;AACrE,gBAAgB;AAChB,OAAO,EACL,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,aAAa,GACd,MAAM,yBAAyB,CAAC;AAEjC,wDAAwD;AACxD,6DAA6D;AAC7D,4DAA4D;AAC5D,gCAAgC;AAChC,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,OAAO,GACR,MAAM,kBAAkB,CAAC;AAe1B,wDAAwD;AACxD,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAU1C,wDAAwD;AACxD,+DAA+D;AAC/D,OAAO,EACL,YAAY,EACZ,qBAAqB,EACrB,eAAe,EACf,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EACL,aAAa,EACb,eAAe,EACf,UAAU,GACX,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAUhD,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;AAG3C,oDAAoD;AACpD,OAAO,EACL,QAAQ,EACR,MAAM,EACN,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,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,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAEzC,OAAO,EACL,SAAS,EACT,YAAY,EACZ,cAAc,EACd,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,sBAAsB,EACtB,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,eAAe,GAChB,MAAM,aAAa,CAAC;AASrB,oDAAoD;AACpD,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,GAChB,MAAM,cAAc,CAAC;AAUtB,oDAAoD;AACpD,OAAO,EAAC,IAAI,EAAE,cAAc,EAAC,MAAM,WAAW,CAAC;AAU/C,OAAO,EAAC,WAAW,EAAE,cAAc,EAAE,eAAe,EAAC,MAAM,eAAe,CAAC;AAS3E,oDAAoD;AACpD,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAK7B,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAK5B,oDAAoD;AACpD,OAAO,EACL,wBAAwB,EACxB,2BAA2B,EAC3B,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,yBAAyB,CAAC;AAKjC,OAAO,EAAC,yBAAyB,EAAC,MAAM,mCAAmC,CAAC;AAK5E,oDAAoD;AACpD,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAGrB,oDAAoD;AACpD,uEAAuE;AACvE,sEAAsE;AACtE,mCAAmC;AACnC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AACpD,OAAO,EACL,OAAO,EACP,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,WAAW,EACX,SAAS,EACT,SAAS,GACV,MAAM,eAAe,CAAC;AAMvB,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,aAAa,EACb,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,cAAc,EACd,uBAAuB,EACvB,cAAc,EACd,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB,oDAAoD;AACpD,OAAO,EACL,cAAc,EACd,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,SAAS,EACT,UAAU,GACX,MAAM,YAAY,CAAC;AASpB,oDAAoD;AACpD,sEAAsE;AACtE,oDAAoD;AACpD,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAGxC,oDAAoD;AACpD,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAMzB,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,cAAc,GACf,MAAM,kBAAkB,CAAC;AAG1B,sDAAsD;AACtD,sEAAsE;AACtE,uEAAuE;AACvE,YAAY;AACZ,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAC,MAAM,eAAe,CAAC;AAGxE,sDAAsD;AACtD,sEAAsE;AACtE,qEAAqE;AACrE,2BAA2B;AAC3B,OAAO,EACL,QAAQ,EACR,cAAc,EACd,UAAU,EACV,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,cAAc,EACd,QAAQ,GACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AAoBxD,OAAO,EAAC,cAAc,EAAE,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAG9C,sDAAsD;AACtD,iEAAiE;AACjE,iEAAiE;AACjE,sEAAsE;AACtE,iEAAiE;AACjE,qEAAqE;AACrE,gBAAgB;AAChB,OAAO,EACL,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,aAAa,GACd,MAAM,yBAAyB,CAAC;AAEjC,wDAAwD;AACxD,6DAA6D;AAC7D,4DAA4D;AAC5D,gCAAgC;AAChC,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,OAAO,GACR,MAAM,kBAAkB,CAAC;AAe1B,wDAAwD;AACxD,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAU1C,wDAAwD;AACxD,+DAA+D;AAC/D,OAAO,EACL,YAAY,EACZ,qBAAqB,EACrB,eAAe,EACf,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EACL,aAAa,EACb,eAAe,EACf,UAAU,GACX,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAUhD,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,kBAAkB,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE/D,iDAAiD;AACjD,OAAO,EAAC,cAAc,EAAE,cAAc,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAG/E,oDAAoD;AACpD,OAAO,EACL,QAAQ,EACR,MAAM,EACN,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,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,GACjB,MAAM,sBAAsB,CAAC"}
package/dist/post.d.ts CHANGED
@@ -10,7 +10,7 @@
10
10
  * a value by building a new one (see {@link Post.withSalary},
11
11
  * {@link Post.withAdjustments}).
12
12
  */
13
- import type { Nation, PayYear, TaxYear, TakeHomePay, StudentLoanPlan, TaxCode } from '@casomoltd/paye-calc';
13
+ import type { Nation, PayYear, TaxYear, TakeHomePay, AnnualAllowance, StudentLoanPlan, TaxCode } from '@casomoltd/paye-calc';
14
14
  import type { Role } from './role.js';
15
15
  import type { DocumentSource } from './document-source.js';
16
16
  import type { PayAward } from './award.js';
@@ -201,8 +201,17 @@ export declare class Post {
201
201
  * never drift from what paye-calc actually deducts.
202
202
  */
203
203
  get pensionContribution(): number;
204
+ /** The contribution rate as a fraction, as the take-home reads it;
205
+ * `pensionRate` is per cent. */
206
+ private get _pensionFraction();
204
207
  /** Full take-home breakdown (tax, NI, pension, net). */
205
208
  get takeHome(): TakeHomePay;
209
+ /**
210
+ * The pension annual allowance this post's year meets, with the
211
+ * scheme's defined-benefit pension input: read it here, not off
212
+ * `takeHome`, whose own allowance has no scheme input.
213
+ */
214
+ get annualAllowance(): AnnualAllowance;
206
215
  /** Annual income tax (£). */
207
216
  get tax(): number;
208
217
  /** Annual national insurance (£). */
package/dist/post.js CHANGED
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import { nationToTaxRegion } from '@casomoltd/paye-calc';
14
14
  import { getPensionTiersVO } from './pension.js';
15
- import { nhsTakeHome } from './take-home.js';
15
+ import { nhsAnnualAllowance, nhsTakeHome } from './take-home.js';
16
16
  import { awardsFor } from './award.js';
17
17
  import { afcScaleSource } from './scales.js';
18
18
  import { ScaleUnavailable } from './errors.js';
@@ -48,6 +48,8 @@ export const NO_ADJUSTMENTS = {
48
48
  taxCode: null,
49
49
  pensionOptedOut: false,
50
50
  };
51
+ /** `pensionRate` is per cent. */
52
+ const PER_CENT = 100;
51
53
  export class Post {
52
54
  identity;
53
55
  salary;
@@ -193,13 +195,26 @@ export class Post {
193
195
  get pensionContribution() {
194
196
  return this.takeHome.pensionDeduction;
195
197
  }
198
+ /** The contribution rate as a fraction, as the take-home reads it;
199
+ * `pensionRate` is per cent. */
200
+ get _pensionFraction() {
201
+ return this.pensionRate / PER_CENT;
202
+ }
196
203
  /** Full take-home breakdown (tax, NI, pension, net). */
197
204
  get takeHome() {
198
- return nhsTakeHome(this.pensionablePay, this.pensionRate / 100, this.identity.taxYear, nationToTaxRegion(this.identity.nation), {
205
+ return nhsTakeHome(this.pensionablePay, this._pensionFraction, this.identity.taxYear, nationToTaxRegion(this.identity.nation), {
199
206
  studentLoans: this.adjustments.studentLoans,
200
207
  taxCode: this.adjustments.taxCode,
201
208
  });
202
209
  }
210
+ /**
211
+ * The pension annual allowance this post's year meets, with the
212
+ * scheme's defined-benefit pension input: read it here, not off
213
+ * `takeHome`, whose own allowance has no scheme input.
214
+ */
215
+ get annualAllowance() {
216
+ return nhsAnnualAllowance(this.pensionablePay, this._pensionFraction, this.identity.taxYear, nationToTaxRegion(this.identity.nation));
217
+ }
203
218
  /** Annual income tax (£). */
204
219
  get tax() {
205
220
  return this.takeHome.incomeTax;
package/dist/post.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"post.js","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AASvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAC;AAErC,OAAO,EAAC,cAAc,EAAC,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAGnD;;6CAE6C;AAC7C,SAAS,WAAW,CAClB,KAAoD,EACpD,KAAQ,EACR,QAA4C;IAE5C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CACxB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CACzC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CAAC,IAAU;IACzB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAwFD,mFAAmF;AACnF,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC7C,GAAG,EAAE,CAAC;IACN,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,IAAI,GAAG,EAAE;IACvB,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,KAAK;CACvB,CAAC;AAEF,MAAM,OAAO,IAAI;IAEJ;IACA;IACA;IACA;IAJX,YACW,QAAsB,EACtB,MAAc,EACd,IAAU,EACV,cAA+B,cAAc;QAH7C,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAM;QACV,gBAAW,GAAX,WAAW,CAAkC;IACrD,CAAC;IAEJ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,CACf,MAAc,EACd,MAAc;IACd,yDAAyD;IACzD,IAAa;IACb;;;;;;;;;;OAUG;IACH,OAAgB,EAChB,OAAa,EAAC,IAAI,EAAE,KAAK,EAAC;QAE1B,OAAO,IAAI,IAAI,CACb,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,EAAE,MAAM,EAAE,IAAI,CAC/C,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,cAAc;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CACnC,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CACb,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAChD,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,KAAK;QACP,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI;QAChD,6DAA6D;QAC7D,gEAAgE;QAChE,6CAA6C;QAC7C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,CAC/B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,WAAW;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5D,KAAK,SAAS;gBACZ,OAAO,WAAW,CAChB,gBAAgB,CACd,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,KAAK,QAAQ;gBACX,OAAO,WAAW,CAChB,eAAe,CACb,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,gEAAgE;YAChE,+DAA+D;YAC/D,gEAAgE;YAChE,KAAK,KAAK;gBACR,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH;;;;;OAKG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC/B,CAAC;IAED,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,iBAAiB,CACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjC,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,cAAc,EACnB,IAAI,CAAC,WAAW,GAAG,GAAG,EACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EACvC;YACE,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY;YAC3C,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;SAClC,CACF,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,CACb,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CACnD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,KAA+B;QAC7C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE;YACrD,GAAG,IAAI,CAAC,WAAW;YACnB,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"post.js","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAUvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,kBAAkB,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE/D,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAC;AAErC,OAAO,EAAC,cAAc,EAAC,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAGnD;;6CAE6C;AAC7C,SAAS,WAAW,CAClB,KAAoD,EACpD,KAAQ,EACR,QAA4C;IAE5C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CACxB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CACzC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC;AACrB,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CAAC,IAAU;IACzB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAwFD,mFAAmF;AACnF,MAAM,CAAC,MAAM,cAAc,GAAoB;IAC7C,GAAG,EAAE,CAAC;IACN,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,IAAI,GAAG,EAAE;IACvB,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,KAAK;CACvB,CAAC;AAEF,iCAAiC;AACjC,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB,MAAM,OAAO,IAAI;IAEJ;IACA;IACA;IACA;IAJX,YACW,QAAsB,EACtB,MAAc,EACd,IAAU,EACV,cAA+B,cAAc;QAH7C,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAM;QACV,gBAAW,GAAX,WAAW,CAAkC;IACrD,CAAC;IAEJ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,CACf,MAAc,EACd,MAAc;IACd,yDAAyD;IACzD,IAAa;IACb;;;;;;;;;;OAUG;IACH,OAAgB,EAChB,OAAa,EAAC,IAAI,EAAE,KAAK,EAAC;QAE1B,OAAO,IAAI,IAAI,CACb,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,EAAE,MAAM,EAAE,IAAI,CAC/C,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,cAAc;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CACnC,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CACb,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAChD,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,KAAK;QACP,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI;QAChD,6DAA6D;QAC7D,gEAAgE;QAChE,6CAA6C;QAC7C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,CAC/B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,WAAW;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5D,KAAK,SAAS;gBACZ,OAAO,WAAW,CAChB,gBAAgB,CACd,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,KAAK,QAAQ;gBACX,OAAO,WAAW,CAChB,eAAe,CACb,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CACnC,EACD,IAAI,CAAC,KAAK,EACV,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAC,CACtD,CAAC;YACJ,gEAAgE;YAChE,+DAA+D;YAC/D,gEAAgE;YAChE,KAAK,KAAK;gBACR,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH;;;;;OAKG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC/B,CAAC;IAED,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,iBAAiB,CACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED;qCACiC;IACjC,IAAY,gBAAgB;QAC1B,OAAO,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED,wDAAwD;IACxD,IAAI,QAAQ;QACV,OAAO,WAAW,CAChB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EACvC;YACE,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY;YAC3C,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;SAClC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,IAAI,eAAe;QACjB,OAAO,kBAAkB,CACvB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,gBAAgB,EACrB,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,CACb,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CACnD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,KAA+B;QAC7C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE;YACrD,GAAG,IAAI,CAAC,WAAW;YACnB,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;CACF"}
package/dist/scales.d.ts CHANGED
@@ -74,33 +74,16 @@ interface AfcScaleYear {
74
74
  scales: Record<AfcBandId, SteppedPoint[]>;
75
75
  }
76
76
  export declare const NLW_HOURLY: Partial<Record<YearLabel, number>>;
77
- /**
78
- * Standard AfC working hours per year (37.5 × 365/7 ≈ 1,955.4).
79
- *
80
- * The week-year is 365/7, not 52, matching every publisher that prints
81
- * an hourly rate beside an annual salary, and matching NHS Employers'
82
- * own ~1,955.4-hour year. A 52-week year gives 1,950, which no
83
- * publisher prints.
84
- *
85
- * @deprecated Use `hoursPerYear(config)` from
86
- * paye-calc for region-aware hours. This constant
87
- * assumes rUK 37.5h weeks and is wrong for Scotland
88
- * from 2026-27.
89
- */
90
- export declare const AFC_HOURS_PER_YEAR: number;
91
77
  /**
92
78
  * Annualise an hourly rate at given weekly hours.
93
79
  *
94
- * `weeklyHours` is required: the standard week is the
95
- * axis that varies by nation (Scotland's AfC week is 37
96
- * hours to 2025-26 and 36 from 2026-27, rUK's 37.5), so
97
- * defaulting it would silently return an rUK answer for a
98
- * Scottish rate. Pass `config.standardWeeklyHours`.
80
+ * `weeklyHours` is required: the standard week varies by
81
+ * nation and year (`afcWeeklyHours`), so defaulting it
82
+ * would silently return an rUK answer for a Scottish rate.
83
+ * Pass `afcWeeklyHours(year, nation)`.
99
84
  *
100
- * The week-year is 365/7, the same basis `hoursPerYear`
101
- * uses — the two are inverses of one another and a
102
- * divisor that disagreed would round-trip a salary to a
103
- * different number.
85
+ * The inverse of dividing by `hoursPerYear`, which it reads, so the two
86
+ * agree up to the rounding of the hourly rate and of the result.
104
87
  */
105
88
  export declare function annualiseHourly(hourly: number, weeklyHours: number): number;
106
89
  /** The Welsh living-wage floor for a year, as its pay
@@ -150,14 +133,14 @@ export declare function afcPayYears(nation: Nation): PayYear[];
150
133
  *
151
134
  * A person's salary comes from an Agenda for Change round; the tax, NI
152
135
  * and pension tiers applied to it come from the tax year they are
153
- * being paid IN. Those are different facts, and they normally name the
154
- * same year — which is why one value was long used for both, and why
155
- * the day they diverge nothing complains.
136
+ * being paid IN. Those are different facts that normally name the
137
+ * same year, so one value serving both looks right until the day they
138
+ * diverge.
156
139
  *
157
140
  * They diverge in exactly one way. An AfC round is agreed and
158
141
  * implemented by each nation separately, and a nation whose award is
159
- * not yet funded keeps paying last year's scales into this tax year.
160
- * Northern Ireland is doing that now. Tax never waits: the thresholds
142
+ * not yet funded keeps paying last year's scales into this tax year;
143
+ * this function says which nations are. Tax never waits: the thresholds
161
144
  * change on 6 April whatever the employer has settled.
162
145
  *
163
146
  * So the legitimate values are:
@@ -172,10 +155,9 @@ export declare function afcPayYears(nation: Nation): PayYear[];
172
155
  * the world: a lag of 2 means a whole round was never transcribed.
173
156
  * {@link assertPayYearLagIsSane} is where that is enforced.
174
157
  *
175
- * The one thing this CANNOT catch is the mistake it was written after:
176
- * passing a pay year where a tax year was wanted. Both are `TaxYear`,
177
- * so both type-check, and the values here would look perfectly legal.
178
- * Only distinct types would stop that.
158
+ * What this cannot catch is a pay year passed where a tax year was
159
+ * wanted: the values here would look perfectly legal. The distinct
160
+ * `PayYear` and `TaxYear` types are what stop that.
179
161
  */
180
162
  export declare function payYearLag(nation: Nation): number;
181
163
  /**
package/dist/scales.js CHANGED
@@ -58,6 +58,7 @@ import { ScaleUnavailable, invariant } from './errors.js';
58
58
  import { AFC_ENGLAND_SCALES_2025, AFC_ENGLAND_SCALES_2026, AFC_NI_2025, AFC_SCOTLAND, AFC_W_02_2025, AFC_W_02_2026, } from './sources.js';
59
59
  import { NI_SCALES_2025_26, SCOTLAND_SCALES_2025_26, SCOTLAND_SCALES_2026_27, WALES_SCALES_2025_26, WALES_SCALES_2026_27, } from './afc-scales.js';
60
60
  import { afcPoint } from './afc-scales.js';
61
+ import { hoursPerYear } from './working-week.js';
61
62
  // The band registry lives in its own module so the translation layer
62
63
  // can name a band without importing this one — see `afc-band.ts`.
63
64
  export { AFC_BANDS, AFC_BAND_IDS } from './afc-band.js';
@@ -103,7 +104,7 @@ const AFC_SCALES_2025_26 = {
103
104
  // and the wage floor has compressed the two to the same cash
104
105
  // figure — so the structure is published and the equality is
105
106
  // the fact, not a reason to collapse it. Wales's Band 2 is the
106
- // same shape and was already modelled this way.
107
+ // same shape and is modelled the same way.
107
108
  '2': [
108
109
  afcPoint(1, false, 24465),
109
110
  afcPoint(3, true, 24465),
@@ -167,7 +168,7 @@ const AFC_SCALES_2026_27 = {
167
168
  // and the wage floor has compressed the two to the same cash
168
169
  // figure — so the structure is published and the equality is
169
170
  // the fact, not a reason to collapse it. Wales's Band 2 is the
170
- // same shape and was already modelled this way.
171
+ // same shape and is modelled the same way.
171
172
  '2': [
172
173
  afcPoint(1, false, 25272),
173
174
  afcPoint(3, true, 25272),
@@ -306,38 +307,19 @@ export const NLW_HOURLY = {
306
307
  [TAX_YEARS.Y2025_26]: 12.21,
307
308
  [TAX_YEARS.Y2026_27]: 12.71,
308
309
  };
309
- /** Standard rUK AfC weekly hours (Scotland differs from 2026-27). */
310
- const RUK_WEEKLY_HOURS = 37.5;
311
- /**
312
- * Standard AfC working hours per year (37.5 × 365/7 ≈ 1,955.4).
313
- *
314
- * The week-year is 365/7, not 52, matching every publisher that prints
315
- * an hourly rate beside an annual salary, and matching NHS Employers'
316
- * own ~1,955.4-hour year. A 52-week year gives 1,950, which no
317
- * publisher prints.
318
- *
319
- * @deprecated Use `hoursPerYear(config)` from
320
- * paye-calc for region-aware hours. This constant
321
- * assumes rUK 37.5h weeks and is wrong for Scotland
322
- * from 2026-27.
323
- */
324
- export const AFC_HOURS_PER_YEAR = (RUK_WEEKLY_HOURS * 365) / 7;
325
310
  /**
326
311
  * Annualise an hourly rate at given weekly hours.
327
312
  *
328
- * `weeklyHours` is required: the standard week is the
329
- * axis that varies by nation (Scotland's AfC week is 37
330
- * hours to 2025-26 and 36 from 2026-27, rUK's 37.5), so
331
- * defaulting it would silently return an rUK answer for a
332
- * Scottish rate. Pass `config.standardWeeklyHours`.
313
+ * `weeklyHours` is required: the standard week varies by
314
+ * nation and year (`afcWeeklyHours`), so defaulting it
315
+ * would silently return an rUK answer for a Scottish rate.
316
+ * Pass `afcWeeklyHours(year, nation)`.
333
317
  *
334
- * The week-year is 365/7, the same basis `hoursPerYear`
335
- * uses — the two are inverses of one another and a
336
- * divisor that disagreed would round-trip a salary to a
337
- * different number.
318
+ * The inverse of dividing by `hoursPerYear`, which it reads, so the two
319
+ * agree up to the rounding of the hourly rate and of the result.
338
320
  */
339
321
  export function annualiseHourly(hourly, weeklyHours) {
340
- return Math.round((hourly * weeklyHours * 365) / 7);
322
+ return Math.round(hourly * hoursPerYear(weeklyHours));
341
323
  }
342
324
  export const WALES_LIVING_WAGE = {
343
325
  [TAX_YEARS.Y2026_27]: { annual: 26300, hourly: 13.45 },
@@ -504,14 +486,14 @@ export function afcPayYears(nation) {
504
486
  *
505
487
  * A person's salary comes from an Agenda for Change round; the tax, NI
506
488
  * and pension tiers applied to it come from the tax year they are
507
- * being paid IN. Those are different facts, and they normally name the
508
- * same year — which is why one value was long used for both, and why
509
- * the day they diverge nothing complains.
489
+ * being paid IN. Those are different facts that normally name the
490
+ * same year, so one value serving both looks right until the day they
491
+ * diverge.
510
492
  *
511
493
  * They diverge in exactly one way. An AfC round is agreed and
512
494
  * implemented by each nation separately, and a nation whose award is
513
- * not yet funded keeps paying last year's scales into this tax year.
514
- * Northern Ireland is doing that now. Tax never waits: the thresholds
495
+ * not yet funded keeps paying last year's scales into this tax year;
496
+ * this function says which nations are. Tax never waits: the thresholds
515
497
  * change on 6 April whatever the employer has settled.
516
498
  *
517
499
  * So the legitimate values are:
@@ -526,10 +508,9 @@ export function afcPayYears(nation) {
526
508
  * the world: a lag of 2 means a whole round was never transcribed.
527
509
  * {@link assertPayYearLagIsSane} is where that is enforced.
528
510
  *
529
- * The one thing this CANNOT catch is the mistake it was written after:
530
- * passing a pay year where a tax year was wanted. Both are `TaxYear`,
531
- * so both type-check, and the values here would look perfectly legal.
532
- * Only distinct types would stop that.
511
+ * What this cannot catch is a pay year passed where a tax year was
512
+ * wanted: the values here would look perfectly legal. The distinct
513
+ * `PayYear` and `TaxYear` types are what stop that.
533
514
  */
534
515
  export function payYearLag(nation) {
535
516
  const order = Object.values(TAX_YEARS);
@@ -1 +1 @@
1
- {"version":3,"file":"scales.js","sourceRoot":"","sources":["../src/scales.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAKH,OAAO,EACL,WAAW,EACX,SAAS,EACT,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,gBAAgB,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAExD,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,EACX,YAAY,EACZ,aAAa,EACb,aAAa,GACd,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAGzC,qEAAqE;AACrE,kEAAkE;AAClE,OAAO,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAoBtD,mDAAmD;AACnD,EAAE;AACF,6DAA6D;AAC7D,4DAA4D;AAC5D,8DAA8D;AAC9D,4DAA4D;AAC5D,uDAAuD;AACvD,EAAE;AACF,gEAAgE;AAChE,gEAAgE;AAChE,+BAA+B;AAE/B,MAAM,YAAY,GAAc;IAC9B,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC9B;CACF,CAAC;AAEF,MAAM,YAAY,GAAc;IAC9B,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC9B;CACF,CAAC;AAEF,mDAAmD;AAEnD,MAAM,kBAAkB,GAAiB;IACvC,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE;QACN,8DAA8D;QAC9D,8DAA8D;QAC9D,6DAA6D;QAC7D,6DAA6D;QAC7D,+DAA+D;QAC/D,gDAAgD;QAChD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;KACF;CACF,CAAC;AAEF,mDAAmD;AAEnD,MAAM,kBAAkB,GAAiB;IACvC,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE;QACN,8DAA8D;QAC9D,8DAA8D;QAC9D,6DAA6D;QAC7D,6DAA6D;QAC7D,+DAA+D;QAC/D,gDAAgD;QAChD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;KACF;CACF,CAAC;AAEF,oDAAoD;AACpD,qDAAqD;AACrD,iDAAiD;AACjD,yDAAyD;AACzD,oDAAoD;AACpD,uDAAuD;AACvD,uDAAuD;AACvD,oDAAoD;AACpD,0CAA0C;AAC1C,wDAAwD;AACxD,2BAA2B;AAE3B,MAAM,2BAA2B,GAAiB;IAChD,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,uBAAuB;CAChC,CAAC;AAEF,oDAAoD;AACpD,sDAAsD;AACtD,mCAAmC;AACnC,wDAAwD;AACxD,0BAA0B;AAE1B,MAAM,2BAA2B,GAAiB;IAChD,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,uBAAuB;CAChC,CAAC;AAEF,oDAAoD;AACpD,EAAE;AACF,yDAAyD;AACzD,2DAA2D;AAC3D,2DAA2D;AAC3D,wDAAwD;AACxD,4DAA4D;AAC5D,mDAAmD;AACnD,EAAE;AACF,yDAAyD;AACzD,kCAAkC;AAClC,EAAE;AACF,sDAAsD;AACtD,kDAAkD;AAClD,gDAAgD;AAChD,+CAA+C;AAC/C,EAAE;AACF,wDAAwD;AACxD,6CAA6C;AAE7C,MAAM,wBAAwB,GAAiB;IAC7C,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,oBAAoB;CAC7B,CAAC;AAEF,MAAM,wBAAwB,GAAiB;IAC7C,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,oBAAoB;CAC7B,CAAC;AAEF,MAAM,gBAAgB,GAElB;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,wBAAwB;IAC9C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,wBAAwB;CAC/C,CAAC;AAEF,oDAAoD;AACpD,EAAE;AACF,0DAA0D;AAC1D,0DAA0D;AAC1D,0DAA0D;AAC1D,uDAAuD;AACvD,wDAAwD;AACxD,8BAA8B;AAC9B,2DAA2D;AAE3D,MAAM,CAAC,MAAM,UAAU,GAEnB;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK;IAC3B,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK;CAC5B,CAAC;AAEF,qEAAqE;AACrE,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAE9B;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,gBAAgB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;AAE/D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAc,EACd,WAAmB;IAEnB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,WAAW,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AACtD,CAAC;AAuCD,MAAM,CAAC,MAAM,iBAAiB,GAE1B;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;CACrD,CAAC;AAGF,mDAAmD;AAEnD,MAAM,UAAU,GAEZ;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB;IACxC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB;CACzC,CAAC;AAEF,MAAM,mBAAmB,GAErB;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAClB,2BAA2B;IAC7B,CAAC,SAAS,CAAC,QAAQ,CAAC,EAClB,2BAA2B;CAC9B,CAAC;AAEF;;;iBAGiB;AACjB;;;;;;;;;;;;;GAaG;AACH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,aAAa,GAA6C;IAC9D,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;QACpB,gEAAgE;QAChE,6DAA6D;QAC7D,kDAAkD;QAClD,IAAI,EAAE,kBAAkB,CAAC,IAAI;QAC7B,8DAA8D;QAC9D,kEAAkE;QAClE,kEAAkE;QAClE,iEAAiE;QACjE,+DAA+D;QAC/D,4BAA4B;QAC5B,MAAM,EAAE,iBAAiB;KAC1B;CACF,CAAC;AAGF,MAAM,cAAc,GAEhB;IACF,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,UAAU;IACjC,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,aAAa;IAC5C,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,mBAAmB;IAC3C,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,gBAAgB;CACtC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,iBAAiB,GAEnB;IACF,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;QACrB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,uBAAuB;QAC7C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,uBAAuB;KAC9C;IACD,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE;QAC7B,mEAAmE;QACnE,gEAAgE;QAChE,kEAAkE;QAClE,WAAW;QACX,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW;KAClC;IACD,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACtB,+DAA+D;QAC/D,4DAA4D;QAC5D,+CAA+C;QAC/C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,YAAY;QAClC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,YAAY;KACnC;IACD,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;QACnB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,aAAa;QACnC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,aAAa;KACpC;CACF,CAAC;AAEF;;;6BAG6B;AAC7B,MAAM,UAAU,cAAc,CAC5B,IAAa,EACb,MAAc;IAEd,gEAAgE;IAChE,MAAM,GAAG,GAAc,IAAI,CAAC;IAC5B,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;gEAQgE;AAChE,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,6DAA6D;IAC7D,mEAAmE;IACnE,oEAAoE;IACpE,8DAA8D;IAC9D,4DAA4D;IAC5D,OACE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CACnC,CAAC,IAAI,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CACP,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EACpB,eAAe,MAAM,oCAAoC,CAC1D,CAAC;IACF,OAAO,GAAG,GAAG,GAAG,CAAC;AACnB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB;IACpC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAa,EAAE,CAAC;QAC7D,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/B,SAAS,CACP,GAAG,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,EACrB,GAAG,MAAM,OAAO,GAAG,oCAAoC;cACrD,IAAI,gBAAgB,mCAAmC;cACvD,GAAG,aAAa,CAAC,MAAM,CAAC,sCAAsC;cAC9D,6DAA6D,CAChE,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,+DAA+D;QAC/D,+DAA+D;QAC/D,kEAAkE;QAClE,iBAAiB;QACjB,MAAM,IAAI,KAAK,CACb,kBAAkB,MAAM,qCAAqC,CAC9D,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;uDAQuD;AACvD,MAAM,UAAU,gBAAgB,CAC9B,IAAa,EACb,MAAc;IAEd,MAAM,GAAG,GAAc,IAAI,CAAC;IAC5B,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
1
+ {"version":3,"file":"scales.js","sourceRoot":"","sources":["../src/scales.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAKH,OAAO,EACL,WAAW,EACX,SAAS,EACT,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,gBAAgB,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAExD,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,EACX,YAAY,EACZ,aAAa,EACb,aAAa,GACd,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAEzC,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAE/C,qEAAqE;AACrE,kEAAkE;AAClE,OAAO,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAoBtD,mDAAmD;AACnD,EAAE;AACF,6DAA6D;AAC7D,4DAA4D;AAC5D,8DAA8D;AAC9D,4DAA4D;AAC5D,uDAAuD;AACvD,EAAE;AACF,gEAAgE;AAChE,gEAAgE;AAChE,+BAA+B;AAE/B,MAAM,YAAY,GAAc;IAC9B,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC9B;CACF,CAAC;AAEF,MAAM,YAAY,GAAc;IAC9B,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC/B;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI;KAC9B;CACF,CAAC;AAEF,mDAAmD;AAEnD,MAAM,kBAAkB,GAAiB;IACvC,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE;QACN,8DAA8D;QAC9D,8DAA8D;QAC9D,6DAA6D;QAC7D,6DAA6D;QAC7D,+DAA+D;QAC/D,2CAA2C;QAC3C,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;KACF;CACF,CAAC;AAEF,mDAAmD;AAEnD,MAAM,kBAAkB,GAAiB;IACvC,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE;QACN,8DAA8D;QAC9D,8DAA8D;QAC9D,6DAA6D;QAC7D,6DAA6D;QAC7D,+DAA+D;QAC/D,2CAA2C;QAC3C,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC;SACzB;QACD,IAAI,EAAE;YACJ,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;QACD,GAAG,EAAE;YACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;SAC1B;KACF;CACF,CAAC;AAEF,oDAAoD;AACpD,qDAAqD;AACrD,iDAAiD;AACjD,yDAAyD;AACzD,oDAAoD;AACpD,uDAAuD;AACvD,uDAAuD;AACvD,oDAAoD;AACpD,0CAA0C;AAC1C,wDAAwD;AACxD,2BAA2B;AAE3B,MAAM,2BAA2B,GAAiB;IAChD,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,uBAAuB;CAChC,CAAC;AAEF,oDAAoD;AACpD,sDAAsD;AACtD,mCAAmC;AACnC,wDAAwD;AACxD,0BAA0B;AAE1B,MAAM,2BAA2B,GAAiB;IAChD,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,uBAAuB;CAChC,CAAC;AAEF,oDAAoD;AACpD,EAAE;AACF,yDAAyD;AACzD,2DAA2D;AAC3D,2DAA2D;AAC3D,wDAAwD;AACxD,4DAA4D;AAC5D,mDAAmD;AACnD,EAAE;AACF,yDAAyD;AACzD,kCAAkC;AAClC,EAAE;AACF,sDAAsD;AACtD,kDAAkD;AAClD,gDAAgD;AAChD,+CAA+C;AAC/C,EAAE;AACF,wDAAwD;AACxD,6CAA6C;AAE7C,MAAM,wBAAwB,GAAiB;IAC7C,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,oBAAoB;CAC7B,CAAC;AAEF,MAAM,wBAAwB,GAAiB;IAC7C,IAAI,EAAE,YAAY;IAClB,iDAAiD;IACjD,wDAAwD;IACxD,uDAAuD;IACvD,oDAAoD;IACpD,MAAM,EAAE,oBAAoB;CAC7B,CAAC;AAEF,MAAM,gBAAgB,GAElB;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,wBAAwB;IAC9C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,wBAAwB;CAC/C,CAAC;AAEF,oDAAoD;AACpD,EAAE;AACF,0DAA0D;AAC1D,0DAA0D;AAC1D,0DAA0D;AAC1D,uDAAuD;AACvD,wDAAwD;AACxD,8BAA8B;AAC9B,2DAA2D;AAE3D,MAAM,CAAC,MAAM,UAAU,GAEnB;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK;IAC3B,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK;CAC5B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAc,EACd,WAAmB;IAEnB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;AACxD,CAAC;AAuCD,MAAM,CAAC,MAAM,iBAAiB,GAE1B;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC;CACrD,CAAC;AAGF,mDAAmD;AAEnD,MAAM,UAAU,GAEZ;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB;IACxC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,kBAAkB;CACzC,CAAC;AAEF,MAAM,mBAAmB,GAErB;IACF,CAAC,SAAS,CAAC,QAAQ,CAAC,EAClB,2BAA2B;IAC7B,CAAC,SAAS,CAAC,QAAQ,CAAC,EAClB,2BAA2B;CAC9B,CAAC;AAEF;;;iBAGiB;AACjB;;;;;;;;;;;;;GAaG;AACH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,aAAa,GAA6C;IAC9D,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;QACpB,gEAAgE;QAChE,6DAA6D;QAC7D,kDAAkD;QAClD,IAAI,EAAE,kBAAkB,CAAC,IAAI;QAC7B,8DAA8D;QAC9D,kEAAkE;QAClE,kEAAkE;QAClE,iEAAiE;QACjE,+DAA+D;QAC/D,4BAA4B;QAC5B,MAAM,EAAE,iBAAiB;KAC1B;CACF,CAAC;AAGF,MAAM,cAAc,GAEhB;IACF,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,UAAU;IACjC,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,aAAa;IAC5C,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,mBAAmB;IAC3C,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,gBAAgB;CACtC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,iBAAiB,GAEnB;IACF,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;QACrB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,uBAAuB;QAC7C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,uBAAuB;KAC9C;IACD,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE;QAC7B,mEAAmE;QACnE,gEAAgE;QAChE,kEAAkE;QAClE,WAAW;QACX,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW;KAClC;IACD,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACtB,+DAA+D;QAC/D,4DAA4D;QAC5D,+CAA+C;QAC/C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,YAAY;QAClC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,YAAY;KACnC;IACD,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;QACnB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,aAAa;QACnC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,aAAa;KACpC;CACF,CAAC;AAEF;;;6BAG6B;AAC7B,MAAM,UAAU,cAAc,CAC5B,IAAa,EACb,MAAc;IAEd,gEAAgE;IAChE,MAAM,GAAG,GAAc,IAAI,CAAC;IAC5B,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;gEAQgE;AAChE,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,6DAA6D;IAC7D,mEAAmE;IACnE,oEAAoE;IACpE,8DAA8D;IAC9D,4DAA4D;IAC5D,OACE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CACnC,CAAC,IAAI,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CACP,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EACpB,eAAe,MAAM,oCAAoC,CAC1D,CAAC;IACF,OAAO,GAAG,GAAG,GAAG,CAAC;AACnB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB;IACpC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAa,EAAE,CAAC;QAC7D,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/B,SAAS,CACP,GAAG,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,EACrB,GAAG,MAAM,OAAO,GAAG,oCAAoC;cACrD,IAAI,gBAAgB,mCAAmC;cACvD,GAAG,aAAa,CAAC,MAAM,CAAC,sCAAsC;cAC9D,6DAA6D,CAChE,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,+DAA+D;QAC/D,+DAA+D;QAC/D,kEAAkE;QAClE,iBAAiB;QACjB,MAAM,IAAI,KAAK,CACb,kBAAkB,MAAM,qCAAqC,CAC9D,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;uDAQuD;AACvD,MAAM,UAAU,gBAAgB,CAC9B,IAAa,EACb,MAAc;IAEd,MAAM,GAAG,GAAc,IAAI,CAAC;IAC5B,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
@@ -20,7 +20,7 @@
20
20
  * library only selects the basis.
21
21
  */
22
22
  import { TakeHomePay } from '@casomoltd/paye-calc';
23
- import type { TaxYear, TaxRegion, StudentLoanPlan, TaxCode } from '@casomoltd/paye-calc';
23
+ import type { AnnualAllowance, TaxYear, TaxRegion, StudentLoanPlan, TaxCode } from '@casomoltd/paye-calc';
24
24
  /**
25
25
  * Generic PAYE deductions layered on the NHS salary — the paye-calc
26
26
  * inputs a bare scale salary doesn't carry. Each is optional and
@@ -34,6 +34,10 @@ export interface NhsTakeHomeOptions {
34
34
  readonly taxCode?: TaxCode | null;
35
35
  }
36
36
  /**
37
+ * The take-home pay of an NHS post. Its `annualAllowance()` has no
38
+ * scheme pension input; read the allowance through
39
+ * `nhsAnnualAllowance` (or `Post.annualAllowance`).
40
+ *
37
41
  * @param salary Gross annual pay assessed for tax/NI (already
38
42
  * FTE-adjusted and net of any salary sacrifice)
39
43
  * @param pensionRate Decimal fraction (e.g. 0.098); 0 = opted out
@@ -43,3 +47,14 @@ export interface NhsTakeHomeOptions {
43
47
  * @param options Student loans / tax-code override
44
48
  */
45
49
  export declare function nhsTakeHome(salary: number, pensionRate: number, taxYear: TaxYear, taxRegion: TaxRegion, options?: NhsTakeHomeOptions): TakeHomePay;
50
+ /**
51
+ * The pension annual allowance an NHS member's year meets. The scheme
52
+ * is defined benefit, so the pension input is the growth in CARE
53
+ * benefits (paye-calc's DB multiple of the year's accrual), not the
54
+ * contribution paid;
55
+ * without it adjusted income omits the scheme and the taper never
56
+ * bites for high earners. An opted-out member (rate 0) has no input.
57
+ * Source: HMRC PTM053301 (DB pension input amount), the citation
58
+ * paye-calc's `DB_PENSION_INPUT_MULTIPLIER` carries.
59
+ */
60
+ export declare function nhsAnnualAllowance(salary: number, pensionRate: number, taxYear: TaxYear, taxRegion: TaxRegion): AnnualAllowance;
package/dist/take-home.js CHANGED
@@ -19,10 +19,16 @@
19
19
  * rule to state and to cite: casomoltd/paye-calc#29. This
20
20
  * library only selects the basis.
21
21
  */
22
- import { TakeHomePay, GrossAnnual, PensionBasis, PensionPercent, } from '@casomoltd/paye-calc';
22
+ import { TakeHomePay, GrossAnnual, NO_PENSION, PensionBasis, PensionPercent, getTaxYearConfig, payAt, } from '@casomoltd/paye-calc';
23
23
  import { yearlyAccrual } from './pension-projection.js';
24
24
  import { invariant } from './errors.js';
25
+ /** A rate is a fraction here; paye-calc takes a pension per cent. */
26
+ const PER_CENT = 100;
25
27
  /**
28
+ * The take-home pay of an NHS post. Its `annualAllowance()` has no
29
+ * scheme pension input; read the allowance through
30
+ * `nhsAnnualAllowance` (or `Post.annualAllowance`).
31
+ *
26
32
  * @param salary Gross annual pay assessed for tax/NI (already
27
33
  * FTE-adjusted and net of any salary sacrifice)
28
34
  * @param pensionRate Decimal fraction (e.g. 0.098); 0 = opted out
@@ -35,25 +41,17 @@ export function nhsTakeHome(salary, pensionRate, taxYear, taxRegion, options = {
35
41
  const thp = new TakeHomePay(taxYear, taxRegion);
36
42
  thp.setSalary(GrossAnnual(salary));
37
43
  // A positive rate is scheme membership (NET arrangement); zero is an
38
- // opted-out member, so there's no pension basis at all — never a 0%
44
+ // opted-out member, so there's no pension at all — never a 0%
39
45
  // Employer contribution.
40
- if (pensionRate > 0) {
41
- thp.setPensionBasis(PensionBasis.Employer);
42
- thp.setPension(PensionPercent(pensionRate * 100));
43
- // The tapered annual allowance is driven by the DB pension INPUT
44
- // amount (growth in CARE benefits ≈ 16 × annual accrual), not the
45
- // contribution paid; without it, adjusted income omits the scheme
46
- // accrual and the taper never bites for high earners.
47
- // Source: HMRC PTM044230 (pension input amount for DB schemes).
48
- thp.setDbAnnualAccrual(yearlyAccrual(salary));
49
- }
50
- else {
51
- thp.setPensionBasis(PensionBasis.None);
52
- }
53
- // setStudentLoanPlans wants a mutable Set; the VO holds a
54
- // ReadonlySet, so copy it at the boundary.
46
+ const isMember = pensionRate > 0;
47
+ thp.setPension(isMember
48
+ ? {
49
+ basis: PensionBasis.Employer,
50
+ contribution: PensionPercent(pensionRate * PER_CENT),
51
+ }
52
+ : NO_PENSION);
55
53
  if (options.studentLoans && options.studentLoans.size > 0) {
56
- thp.setStudentLoanPlans(new Set(options.studentLoans));
54
+ thp.setStudentLoanPlans(options.studentLoans);
57
55
  }
58
56
  if (options.taxCode) {
59
57
  thp.setTaxCode(options.taxCode);
@@ -63,14 +61,35 @@ export function nhsTakeHome(salary, pensionRate, taxYear, taxRegion, options = {
63
61
  // ever changes when the pension is applied, the pension basis is
64
62
  // wrong or paye-calc's model changed — fail loud here (this runs in
65
63
  // every test and page) rather than silently overstating take-home.
66
- if (pensionRate > 0) {
67
- const niNoPension = new TakeHomePay(taxYear, taxRegion);
68
- niNoPension.setSalary(GrossAnnual(salary));
69
- invariant(thp.nationalInsurance === niNoPension.nationalInsurance, 'NHS pension is a net-pay arrangement: it must reduce income '
64
+ if (isMember) {
65
+ // The same inputs but the pension, so the pension alone is what
66
+ // the two sides differ by.
67
+ const inputs = {
68
+ config: getTaxYearConfig(taxYear, taxRegion),
69
+ pension: thp.pension,
70
+ studentLoans: thp.studentLoanPlans,
71
+ taxCode: options.taxCode ?? null,
72
+ };
73
+ invariant(payAt(salary, inputs).niBreakdown.total
74
+ === payAt(salary, { ...inputs, pension: NO_PENSION }).niBreakdown.total, 'NHS pension is a net-pay arrangement: it must reduce income '
70
75
  + 'tax but not National Insurance (NI is assessed on full '
71
76
  + 'gross). NI changed when the pension was applied. '
72
77
  + 'See HMRC PTM044230.');
73
78
  }
74
79
  return thp;
75
80
  }
81
+ /**
82
+ * The pension annual allowance an NHS member's year meets. The scheme
83
+ * is defined benefit, so the pension input is the growth in CARE
84
+ * benefits (paye-calc's DB multiple of the year's accrual), not the
85
+ * contribution paid;
86
+ * without it adjusted income omits the scheme and the taper never
87
+ * bites for high earners. An opted-out member (rate 0) has no input.
88
+ * Source: HMRC PTM053301 (DB pension input amount), the citation
89
+ * paye-calc's `DB_PENSION_INPUT_MULTIPLIER` carries.
90
+ */
91
+ export function nhsAnnualAllowance(salary, pensionRate, taxYear, taxRegion) {
92
+ const isMember = pensionRate > 0;
93
+ return nhsTakeHome(salary, pensionRate, taxYear, taxRegion).annualAllowance(isMember ? { dbAnnualAccrual: yearlyAccrual(salary) } : {});
94
+ }
76
95
  //# sourceMappingURL=take-home.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"take-home.js","sourceRoot":"","sources":["../src/take-home.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EACL,WAAW,EACX,WAAW,EACX,YAAY,EACZ,cAAc,GACf,MAAM,sBAAsB,CAAC;AAO9B,OAAO,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAetC;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CACzB,MAAc,EACd,WAAmB,EACnB,OAAgB,EAChB,SAAoB,EACpB,UAA8B,EAAE;IAEhC,MAAM,GAAG,GAAG,IAAI,WAAW,CACzB,OAAO,EAAE,SAAS,CACnB,CAAC;IACF,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACnC,qEAAqE;IACrE,oEAAoE;IACpE,yBAAyB;IACzB,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;QACpB,GAAG,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,GAAG,CAAC,UAAU,CACZ,cAAc,CAAC,WAAW,GAAG,GAAG,CAAC,CAClC,CAAC;QACF,iEAAiE;QACjE,kEAAkE;QAClE,kEAAkE;QAClE,sDAAsD;QACtD,gEAAgE;QAChE,GAAG,CAAC,kBAAkB,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAChD,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IACD,0DAA0D;IAC1D,2CAA2C;IAC3C,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAC1D,GAAG,CAAC,mBAAmB,CACrB,IAAI,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAC9B,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,kEAAkE;IAClE,mEAAmE;IACnE,iEAAiE;IACjE,oEAAoE;IACpE,mEAAmE;IACnE,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACxD,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3C,SAAS,CACP,GAAG,CAAC,iBAAiB,KAAK,WAAW,CAAC,iBAAiB,EACvD,8DAA8D;cAC1D,yDAAyD;cACzD,mDAAmD;cACnD,qBAAqB,CAC1B,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
1
+ {"version":3,"file":"take-home.js","sourceRoot":"","sources":["../src/take-home.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EACL,WAAW,EACX,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,KAAK,GACN,MAAM,sBAAsB,CAAC;AAQ9B,OAAO,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC,qEAAqE;AACrE,MAAM,QAAQ,GAAG,GAAG,CAAC;AAerB;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CACzB,MAAc,EACd,WAAmB,EACnB,OAAgB,EAChB,SAAoB,EACpB,UAA8B,EAAE;IAEhC,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAChD,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACnC,qEAAqE;IACrE,8DAA8D;IAC9D,yBAAyB;IACzB,MAAM,QAAQ,GAAG,WAAW,GAAG,CAAC,CAAC;IACjC,GAAG,CAAC,UAAU,CAAC,QAAQ;QACrB,CAAC,CAAC;YACA,KAAK,EAAE,YAAY,CAAC,QAAQ;YAC5B,YAAY,EAAE,cAAc,CAAC,WAAW,GAAG,QAAQ,CAAC;SACrD;QACD,CAAC,CAAC,UAAU,CAAC,CAAC;IAChB,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAC1D,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,kEAAkE;IAClE,mEAAmE;IACnE,iEAAiE;IACjE,oEAAoE;IACpE,mEAAmE;IACnE,IAAI,QAAQ,EAAE,CAAC;QACb,gEAAgE;QAChE,2BAA2B;QAC3B,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC;YAC5C,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,YAAY,EAAE,GAAG,CAAC,gBAAgB;YAClC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;SACjC,CAAC;QACF,SAAS,CACP,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,KAAK;gBACjC,KAAK,CAAC,MAAM,EAAE,EAAC,GAAG,MAAM,EAAE,OAAO,EAAE,UAAU,EAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EACvE,8DAA8D;cAC1D,yDAAyD;cACzD,mDAAmD;cACnD,qBAAqB,CAC1B,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAc,EACd,WAAmB,EACnB,OAAgB,EAChB,SAAoB;IAEpB,MAAM,QAAQ,GAAG,WAAW,GAAG,CAAC,CAAC;IACjC,OAAO,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,eAAe,CACzE,QAAQ,CAAC,CAAC,CAAC,EAAC,eAAe,EAAE,aAAa,CAAC,MAAM,CAAC,EAAC,CAAC,CAAC,CAAC,EAAE,CACzD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,43 @@
1
+ /**
2
+ * The Agenda for Change full-time week, by nation and pay year, and the
3
+ * hours in a year it gives. An hourly rate is an annual salary over these
4
+ * hours, so a Scottish rate read at the rest of the UK's week comes out
5
+ * low by the difference.
6
+ *
7
+ * Sources, by figure:
8
+ * - 37.5 hours, England, Wales and Northern Ireland: "NHS Terms and
9
+ * Conditions of Service Handbook, amendment 62" (#sa-41). The section
10
+ * setting the week has not been re-read for this module.
11
+ * - Scotland, 37 hours in 2025-26: "Scotland, PCS(AFC)2026/1" (#sa-13),
12
+ * Annex B p8, whose hourly rates are printed "Based on a 37 Hour Week".
13
+ * - Scotland, 36 hours from 1 April 2026: the same circular's 2026-27
14
+ * Annex B prints its rates on a 36-hour week, the week
15
+ * `AFC_SCOTLAND_36_HOUR_WEEK` (PCS(AFC)2026/2, in `sources.ts`) sets.
16
+ * Scotland's week before 2025-26 has no archived source, so those years
17
+ * throw rather than serve a figure nobody has checked.
18
+ * See docs/source-archive.md.
19
+ */
20
+ import type { Nation, PayYear, TaxYear } from '@casomoltd/paye-calc';
21
+ /**
22
+ * The full-time AfC week a pay round's scale is built on: the week its
23
+ * circular divides by. A member paid on last year's round is on last
24
+ * year's week.
25
+ */
26
+ export declare function afcWeeklyHours(year: PayYear, nation: Nation): number;
27
+ /**
28
+ * The full-time AfC week in force in a tax year, whatever round a nation
29
+ * is paying on: a week changes on 1 April, by the calendar, as Scotland's
30
+ * 36 hours did in 2026. It differs from `afcWeeklyHours` only for a
31
+ * nation still paying an earlier round.
32
+ */
33
+ export declare function afcWeekInForce(year: TaxYear, nation: Nation): number;
34
+ /**
35
+ * Hours in a year at a given week: the divisor for an hourly rate.
36
+ *
37
+ * Not 52 weeks. A year is 52 weeks and a day, and the circulars this
38
+ * library pins (Scotland's PCS(AFC)2026/1 and the Welsh living-wage
39
+ * letter) divide by the longer year; 52 would give a rate neither
40
+ * prints, about 0.3% high. Leap years are ignored, as those tables
41
+ * ignore them. `tests/working-week.test.ts` pins it.
42
+ */
43
+ export declare function hoursPerYear(weeklyHours: number): number;
@@ -0,0 +1,70 @@
1
+ /**
2
+ * The Agenda for Change full-time week, by nation and pay year, and the
3
+ * hours in a year it gives. An hourly rate is an annual salary over these
4
+ * hours, so a Scottish rate read at the rest of the UK's week comes out
5
+ * low by the difference.
6
+ *
7
+ * Sources, by figure:
8
+ * - 37.5 hours, England, Wales and Northern Ireland: "NHS Terms and
9
+ * Conditions of Service Handbook, amendment 62" (#sa-41). The section
10
+ * setting the week has not been re-read for this module.
11
+ * - Scotland, 37 hours in 2025-26: "Scotland, PCS(AFC)2026/1" (#sa-13),
12
+ * Annex B p8, whose hourly rates are printed "Based on a 37 Hour Week".
13
+ * - Scotland, 36 hours from 1 April 2026: the same circular's 2026-27
14
+ * Annex B prints its rates on a 36-hour week, the week
15
+ * `AFC_SCOTLAND_36_HOUR_WEEK` (PCS(AFC)2026/2, in `sources.ts`) sets.
16
+ * Scotland's week before 2025-26 has no archived source, so those years
17
+ * throw rather than serve a figure nobody has checked.
18
+ * See docs/source-archive.md.
19
+ */
20
+ import { NATION_KEYS } from '@casomoltd/paye-calc';
21
+ /** The week everywhere but Scotland, every year this library covers. */
22
+ const FULL_TIME_WEEK = 37.5;
23
+ /** Scotland's week, for the years a circular sets it. */
24
+ const SCOTLAND_WEEK = {
25
+ '2025-26': 37,
26
+ '2026-27': 36,
27
+ };
28
+ // A year of weeks as payroll counts it: 365 days over 7.
29
+ const DAYS_PER_YEAR = 365;
30
+ const DAYS_PER_WEEK = 7;
31
+ /**
32
+ * The full-time AfC week a pay round's scale is built on: the week its
33
+ * circular divides by. A member paid on last year's round is on last
34
+ * year's week.
35
+ */
36
+ export function afcWeeklyHours(year, nation) {
37
+ return weekFor(year, nation);
38
+ }
39
+ /**
40
+ * The full-time AfC week in force in a tax year, whatever round a nation
41
+ * is paying on: a week changes on 1 April, by the calendar, as Scotland's
42
+ * 36 hours did in 2026. It differs from `afcWeeklyHours` only for a
43
+ * nation still paying an earlier round.
44
+ */
45
+ export function afcWeekInForce(year, nation) {
46
+ return weekFor(year, nation);
47
+ }
48
+ /** The week for a year's label, whichever question asks it. */
49
+ function weekFor(label, nation) {
50
+ if (nation !== NATION_KEYS.scotland)
51
+ return FULL_TIME_WEEK;
52
+ const week = SCOTLAND_WEEK[label];
53
+ if (week === undefined) {
54
+ throw new RangeError(`No sourced AfC week for Scotland in ${label}`);
55
+ }
56
+ return week;
57
+ }
58
+ /**
59
+ * Hours in a year at a given week: the divisor for an hourly rate.
60
+ *
61
+ * Not 52 weeks. A year is 52 weeks and a day, and the circulars this
62
+ * library pins (Scotland's PCS(AFC)2026/1 and the Welsh living-wage
63
+ * letter) divide by the longer year; 52 would give a rate neither
64
+ * prints, about 0.3% high. Leap years are ignored, as those tables
65
+ * ignore them. `tests/working-week.test.ts` pins it.
66
+ */
67
+ export function hoursPerYear(weeklyHours) {
68
+ return (weeklyHours * DAYS_PER_YEAR) / DAYS_PER_WEEK;
69
+ }
70
+ //# sourceMappingURL=working-week.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"working-week.js","sourceRoot":"","sources":["../src/working-week.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAGjD,wEAAwE;AACxE,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B,yDAAyD;AACzD,MAAM,aAAa,GAAuC;IACxD,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;CACd,CAAC;AAEF,yDAAyD;AACzD,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,IAAa,EAAE,MAAc;IAC1D,OAAO,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAa,EAAE,MAAc;IAC1D,OAAO,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/B,CAAC;AAED,+DAA+D;AAC/D,SAAS,OAAO,CAAC,KAAgB,EAAE,MAAc;IAC/C,IAAI,MAAM,KAAK,WAAW,CAAC,QAAQ;QAAE,OAAO,cAAc,CAAC;IAC3D,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,UAAU,CAClB,uCAAuC,KAAK,EAAE,CAC/C,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,WAAmB;IAC9C,OAAO,CAAC,WAAW,GAAG,aAAa,CAAC,GAAG,aAAa,CAAC;AACvD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@casomoltd/nhs-pay",
3
- "version": "0.24.2",
3
+ "version": "0.26.0",
4
4
  "description": "NHS pay scales and take-home pay, and a member's NHS pension across the 1995, 2008 and 2015 Sections",
5
5
  "homepage": "https://casomo.co.uk",
6
6
  "bugs": "https://github.com/casomoltd/nhs-pay/issues",
@@ -67,10 +67,10 @@
67
67
  "provenance": true
68
68
  },
69
69
  "peerDependencies": {
70
- "@casomoltd/paye-calc": ">=0.5.9"
70
+ "@casomoltd/paye-calc": ">=0.10.0"
71
71
  },
72
72
  "devDependencies": {
73
- "@casomoltd/paye-calc": "^0.7.0",
73
+ "@casomoltd/paye-calc": "^0.10.0",
74
74
  "@casomoltd/tooling": "^0.37.0",
75
75
  "@commitlint/cli": "^20.0.0",
76
76
  "@js-temporal/polyfill": "^0.5.1",