@casomoltd/nhs-pay 0.30.0 → 0.32.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 +71 -252
- package/dist/bands.d.ts +9 -1
- package/dist/bands.js +20 -0
- package/dist/bands.js.map +1 -1
- package/dist/document-source.d.ts +32 -7
- package/dist/document-source.js +32 -8
- package/dist/document-source.js.map +1 -1
- package/dist/errors.d.ts +57 -11
- package/dist/errors.js +85 -28
- package/dist/errors.js.map +1 -1
- package/dist/factor-basis.d.ts +23 -3
- package/dist/factor-basis.js +40 -28
- package/dist/factor-basis.js.map +1 -1
- package/dist/index.d.ts +16 -14
- package/dist/index.js +9 -8
- package/dist/index.js.map +1 -1
- package/dist/member/benefits.js +25 -13
- package/dist/member/benefits.js.map +1 -1
- package/dist/member/index.d.ts +1 -1
- package/dist/member/input-period.d.ts +4 -4
- package/dist/member/input-period.js +11 -9
- package/dist/member/input-period.js.map +1 -1
- package/dist/member/service.d.ts +4 -0
- package/dist/member/service.js +9 -3
- package/dist/member/service.js.map +1 -1
- package/dist/member/types.d.ts +81 -49
- package/dist/member/types.js.map +1 -1
- package/dist/member/valuation.d.ts +10 -8
- package/dist/member/valuation.js +14 -21
- package/dist/member/valuation.js.map +1 -1
- package/dist/pay-path.d.ts +21 -25
- package/dist/pay-path.js +85 -67
- package/dist/pay-path.js.map +1 -1
- package/dist/pension/ages.d.ts +6 -4
- package/dist/pension/ages.js +6 -4
- package/dist/pension/ages.js.map +1 -1
- package/dist/pension/curve.d.ts +2 -1
- package/dist/pension/curve.js +15 -7
- package/dist/pension/curve.js.map +1 -1
- package/dist/pension/history.d.ts +18 -3
- package/dist/pension/history.js +12 -5
- package/dist/pension/history.js.map +1 -1
- package/dist/pension/ledger.d.ts +15 -9
- package/dist/pension/ledger.js +95 -59
- package/dist/pension/ledger.js.map +1 -1
- package/dist/pension/money.d.ts +2 -0
- package/dist/pension/money.js +4 -0
- package/dist/pension/money.js.map +1 -1
- package/dist/pension/prices.d.ts +11 -2
- package/dist/pension/prices.js +35 -14
- package/dist/pension/prices.js.map +1 -1
- package/dist/pension/scheme-year.d.ts +59 -0
- package/dist/pension/scheme-year.js +80 -0
- package/dist/pension/scheme-year.js.map +1 -0
- package/dist/pension/seed.d.ts +66 -50
- package/dist/pension/seed.js +111 -65
- package/dist/pension/seed.js.map +1 -1
- package/dist/pension/uplift.d.ts +38 -54
- package/dist/pension/uplift.js +38 -68
- package/dist/pension/uplift.js.map +1 -1
- package/dist/pension-projection.js +30 -22
- package/dist/pension-projection.js.map +1 -1
- package/dist/post.d.ts +1 -10
- package/dist/post.js +1 -12
- package/dist/post.js.map +1 -1
- package/dist/revaluation.d.ts +56 -41
- package/dist/revaluation.js +76 -62
- package/dist/revaluation.js.map +1 -1
- package/dist/scale-point.d.ts +6 -0
- package/dist/sections/final-salary.d.ts +3 -8
- package/dist/sections/final-salary.js +6 -10
- package/dist/sections/final-salary.js.map +1 -1
- package/dist/sections/section-2015.d.ts +3 -4
- package/dist/sections/section-2015.js +1 -1
- package/dist/sections/section-2015.js.map +1 -1
- package/dist/sources.d.ts +14 -0
- package/dist/sources.js +24 -0
- package/dist/sources.js.map +1 -1
- package/dist/take-home.d.ts +4 -20
- package/dist/take-home.js +3 -23
- package/dist/take-home.js.map +1 -1
- package/package.json +3 -3
package/dist/sources.js
CHANGED
|
@@ -20,6 +20,10 @@
|
|
|
20
20
|
* - **Legislation** — an Act's own provision, where the rule a figure
|
|
21
21
|
* turns on is the statute's rather than the scheme's.
|
|
22
22
|
*
|
|
23
|
+
* Each is a `DocumentSource`, except a publisher's web page that prints
|
|
24
|
+
* no issue date, which is a `PageSource`: it carries the day it was
|
|
25
|
+
* read, so it cannot be shown as published on that day.
|
|
26
|
+
*
|
|
23
27
|
* They diverge in every nation. England's 2026-27 medical award was
|
|
24
28
|
* enacted by HCWS1462 on parliament.uk while its salaries are printed
|
|
25
29
|
* in PC(M&D) 1/2026 R2 on nhsemployers.org. Reading the award's source
|
|
@@ -406,6 +410,26 @@ export const DHSC_PETITION_779519 = new DocumentSource({
|
|
|
406
410
|
url: 'https://petition.parliament.uk/petitions/779519?reveal_response=yes',
|
|
407
411
|
issued: isoDate('2026-10-19'),
|
|
408
412
|
});
|
|
413
|
+
/** NHSBSA's guide to the pension figures on a 2015 Section statement: "We
|
|
414
|
+
* produce your 2015 statement as of 31 March. The figures shown are not
|
|
415
|
+
* yet revalued." The source of `memberBenefits`' 31 March statement
|
|
416
|
+
* rule; archived as SA-63 in docs/source-archive.md. */
|
|
417
|
+
export const NHSBSA_STATEMENT_GUIDE = {
|
|
418
|
+
issuer: 'NHSBSA',
|
|
419
|
+
reference: 'Understanding your statement: Pension',
|
|
420
|
+
url: 'https://www.nhsbsa.nhs.uk/employee-section/understanding-your-statement'
|
|
421
|
+
+ '/pension',
|
|
422
|
+
retrieved: isoDate('2026-11-07'),
|
|
423
|
+
};
|
|
424
|
+
/** NHSBSA's page on asking for a pension estimate: "We base this on
|
|
425
|
+
* information your employer gives us up to 31 March." Archived as SA-64 in
|
|
426
|
+
* docs/source-archive.md. */
|
|
427
|
+
export const NHSBSA_ESTIMATE_GUIDE = {
|
|
428
|
+
issuer: 'NHSBSA',
|
|
429
|
+
reference: 'Getting an estimate of your pension',
|
|
430
|
+
url: 'https://www.nhsbsa.nhs.uk/member-hub/getting-estimate-your-pension',
|
|
431
|
+
retrieved: isoDate('2026-11-07'),
|
|
432
|
+
};
|
|
409
433
|
/** The Scottish scheme's own statement of who keeps 55; archived as SA-61 in
|
|
410
434
|
* docs/source-archive.md, the version with paragraph 9 updated. */
|
|
411
435
|
export const SPPA_NHS_CIRCULAR_2025_09 = new DocumentSource({
|
package/dist/sources.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sources.js","sourceRoot":"","sources":["../src/sources.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"sources.js","sourceRoot":"","sources":["../src/sources.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAC,OAAO,EAAC,MAAM,eAAe,CAAC;AAEtC,oDAAoD;AAEpD;;;6BAG6B;AAC7B,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,cAAc,CAAC;IAC9C,MAAM,EAAE,mBAAmB;IAC3B,SAAS,EAAE,wCAAwC;IACnD,GAAG,EAAE,+DAA+D;UAChE,6BAA6B;IACjC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,2DAA2D;IAC3D,oCAAoC;IACpC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,cAAc,CAAC;IAC5C,MAAM,EAAE,sBAAsB;IAC9B,SAAS,EAAE,2CAA2C;IACtD,GAAG,EAAE,uBAAuB;UACxB,qEAAqE;IACzE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,cAAc,CAAC;IAC/C,MAAM,EAAE,yBAAyB;IACjC,SAAS,EAAE,gBAAgB;IAC3B,GAAG,EAAE,2CAA2C;IAChD,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH,oDAAoD;AAEpD,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,cAAc,CAAC;IAC/C,MAAM,EAAE,mBAAmB;IAC3B,SAAS,EAAE,4BAA4B;IACvC,GAAG,EAAE,4CAA4C;UAC7C,sDAAsD;UACtD,uDAAuD;IAC3D,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,cAAc,CAAC;IAC/C,MAAM,EAAE,mBAAmB;IAC3B,SAAS,EAAE,wCAAwC;IACnD,GAAG,EAAE,+DAA+D;UAChE,6BAA6B;IACjC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,4DAA4D;IAC5D,yDAAyD;IACzD,aAAa;IACb,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;IAC7C,MAAM,EAAE,sBAAsB;IAC9B,SAAS,EAAE,6CAA6C;IACxD,GAAG,EAAE,uBAAuB;UACxB,wDAAwD;UACxD,4CAA4C;IAChD,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;IAC7C,MAAM,EAAE,sBAAsB;IAC9B,SAAS,EAAE,6CAA6C;IACxD,GAAG,EAAE,uBAAuB;UACxB,wDAAwD;IAC5D,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IAC1C,MAAM,EAAE,+BAA+B;IACvC,SAAS,EAAE,gDAAgD;IAC3D,GAAG,EAAE,mCAAmC;UACpC,wEAAwE;IAC5E,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,+DAA+D;IAC/D,mEAAmE;IACnE,gEAAgE;IAChE,wDAAwD;IACxD,0DAA0D;IAC1D,gEAAgE;IAChE,oCAAoC;IACpC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IACnC,kBAAkB,EAChB,kEAAkE;UAChE,+DAA+D;UAC/D,qDAAqD;CAC5D,CAAC,CAAC;AAEH,oDAAoD;AAEpD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,cAAc,CAAC;IACtD,MAAM,EAAE,eAAe;IACvB,SAAS,EAAE,wBAAwB;IACnC,GAAG,EAAE,8BAA8B;UAC/B,6BAA6B;IACjC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,cAAc,CAAC;IACtD,MAAM,EAAE,eAAe;IACvB,SAAS,EAAE,wBAAwB;IACnC,GAAG,EAAE,8BAA8B;UAC/B,6BAA6B;IACjC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IAC1C,MAAM,EAAE,+BAA+B;IACvC,SAAS,EAAE,mBAAmB;IAC9B,GAAG,EAAE,0DAA0D;UAC3D,iEAAiE;UACjE,0DAA0D;IAC9D,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,cAAc,CAAC;IAC5C,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,0CAA0C;UAC3C,yBAAyB;IAC7B,0DAA0D;IAC1D,oDAAoD;IACpD,uDAAuD;IACvD,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,cAAc,CAAC;IAC5C,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,2BAA2B;IACtC,GAAG,EAAE,0CAA0C;UAC3C,uCAAuC;IAC3C,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH;;;kBAGkB;AAClB,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,cAAc,CAAC;IAC5C,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,0CAA0C;UAC3C,2BAA2B;IAC/B,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,cAAc,CAAC;IAC3C,MAAM,EAAE,cAAc;IACtB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,+DAA+D;IACpE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,iEAAiE;IACjE,iEAAiE;IACjE,8DAA8D;IAC9D,gEAAgE;IAChE,6DAA6D;IAC7D,8DAA8D;IAC9D,iEAAiE;IACjE,gEAAgE;IAChE,uBAAuB;IACvB,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IACnC,kBAAkB,EAChB,2DAA2D;UACzD,oDAAoD;CAC3D,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,cAAc,CAAC;IACxD,MAAM,EAAE,cAAc;IACtB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,gEAAgE;IACrE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH,oDAAoD;AACpD,EAAE;AACF,oEAAoE;AACpE,oEAAoE;AACpE,gEAAgE;AAEhE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,cAAc,CAAC;IAC9C,MAAM,EAAE,eAAe;IACvB,SAAS,EAAE,2CAA2C;IACtD,GAAG,EAAE,mDAAmD;UACpD,qDAAqD;IACzD,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;IAC7C,MAAM,EAAE,cAAc;IACtB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,+DAA+D;IACpE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;IAC7C,MAAM,EAAE,cAAc;IACtB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,+DAA+D;IACpE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH;;;uBAGuB;AACvB,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC;IAC7C,MAAM,EAAE,cAAc;IACtB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,8DAA8D;IACnE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,cAAc,CAAC;IACtD,MAAM,EAAE,cAAc;IACtB,SAAS,EAAE,kCAAkC;IAC7C,GAAG,EAAE,iEAAiE;IACtE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,cAAc,CAAC;IAC3C,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,0CAA0C;UAC3C,0CAA0C;IAC9C,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH;;;kEAGkE;AAClE,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,cAAc,CAAC;IAC3C,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,yBAAyB;IACpC,GAAG,EAAE,0CAA0C;UAC3C,+BAA+B;IACnC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,cAAc,CAAC;IAC9C,MAAM,EAAE,+BAA+B;IACvC,SAAS,EAAE,2BAA2B;IACtC,GAAG,EAAE,0DAA0D;UAC3D,2DAA2D;UAC3D,uEAAuE;IAC3E,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,mEAAmE;IACnE,mDAAmD;IACnD,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IACnC,kBAAkB,EAChB,gEAAgE;UAC9D,iBAAiB;CACxB,CAAC,CAAC;AAEH,qDAAqD;AAErD;4EAC4E;AAC5E,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,cAAc,CAAC;IACnD,MAAM,EAAE,0CAA0C;IAClD,SAAS,EAAE,wCAAwC;IACnD,GAAG,EAAE,qEAAqE;IAC1E,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH;;;yDAGyD;AACzD,MAAM,CAAC,MAAM,sBAAsB,GAAe;IAChD,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,uCAAuC;IAClD,GAAG,EAAE,yEAAyE;UAC1E,UAAU;IACd,SAAS,EAAE,OAAO,CAAC,YAAY,CAAC;CACjC,CAAC;AAEF;;8BAE8B;AAC9B,MAAM,CAAC,MAAM,qBAAqB,GAAe;IAC/C,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,qCAAqC;IAChD,GAAG,EAAE,oEAAoE;IACzE,SAAS,EAAE,OAAO,CAAC,YAAY,CAAC;CACjC,CAAC;AAEF;oEACoE;AACpE,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,cAAc,CAAC;IACxD,MAAM,EAAE,qCAAqC;IAC7C,SAAS,EAAE,kEAAkE;IAC7E,GAAG,EAAE,4EAA4E;UAC7E,mEAAmE;IACvE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC;AAEH;8BAC8B;AAC9B,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,cAAc,CAAC;IAChD,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,oDAAoD;IAC/D,GAAG,EAAE,uDAAuD;UACxD,oDAAoD;UACpD,0BAA0B;IAC9B,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAC7B,gEAAgE;IAChE,uBAAuB;IACvB,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;CACtC,CAAC,CAAC;AAEH,qDAAqD;AAErD;;;;;sDAKsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,cAAc,CAAC;IACrD,MAAM,EAAE,YAAY;IACpB,SAAS,EAAE,+CAA+C;IAC1D,GAAG,EAAE,yEAAyE;IAC9E,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;CAChC,CAAC,CAAC"}
|
package/dist/take-home.d.ts
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
* library only selects the basis.
|
|
21
21
|
*/
|
|
22
22
|
import { TakeHomePay } from '@casomoltd/paye-calc';
|
|
23
|
-
import type {
|
|
23
|
+
import type { 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
|
|
@@ -35,8 +35,9 @@ export interface NhsTakeHomeOptions {
|
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
37
|
* The take-home pay of an NHS post. Its `annualAllowance()` has no
|
|
38
|
-
* scheme pension input
|
|
39
|
-
* `
|
|
38
|
+
* scheme pension input: a year's input is a member's, read from
|
|
39
|
+
* `memberBenefits`' `pensionInputPeriod` through paye-calc's
|
|
40
|
+
* `definedBenefitInput`.
|
|
40
41
|
*
|
|
41
42
|
* @param salary Gross annual pay assessed for tax/NI (already
|
|
42
43
|
* FTE-adjusted and net of any salary sacrifice)
|
|
@@ -47,20 +48,3 @@ export interface NhsTakeHomeOptions {
|
|
|
47
48
|
* @param options Student loans / tax-code override
|
|
48
49
|
*/
|
|
49
50
|
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, estimated from
|
|
52
|
-
* this year's 2015 Section accrual alone. The scheme is defined benefit,
|
|
53
|
-
* so the pension input is paye-calc's DB multiple of the year's accrual,
|
|
54
|
-
* not the contribution paid; without it adjusted income omits the scheme
|
|
55
|
-
* and the taper never bites for high earners. An opted-out member (rate
|
|
56
|
-
* 0) has no input.
|
|
57
|
-
*
|
|
58
|
-
* It takes no member history, so the input is a floor for anyone with
|
|
59
|
-
* pension already built up: that pension's revaluation beyond the CPI
|
|
60
|
-
* uplift, and any legacy section's growth, are inputs too, and are not
|
|
61
|
-
* counted here.
|
|
62
|
-
*
|
|
63
|
-
* Source: HMRC PTM053301 (DB pension input amount), the citation
|
|
64
|
-
* paye-calc's `DB_PENSION_INPUT_MULTIPLIER` carries.
|
|
65
|
-
*/
|
|
66
|
-
export declare function nhsAnnualAllowance(salary: number, pensionRate: number, taxYear: TaxYear, taxRegion: TaxRegion): AnnualAllowance;
|
package/dist/take-home.js
CHANGED
|
@@ -20,14 +20,14 @@
|
|
|
20
20
|
* library only selects the basis.
|
|
21
21
|
*/
|
|
22
22
|
import { TakeHomePay, GrossAnnual, NO_PENSION, PensionBasis, PensionPercent, getTaxYearConfig, payAt, } from '@casomoltd/paye-calc';
|
|
23
|
-
import { yearlyAccrual } from './pension-projection.js';
|
|
24
23
|
import { invariant } from './errors.js';
|
|
25
24
|
/** A rate is a fraction here; paye-calc takes a pension per cent. */
|
|
26
25
|
const PER_CENT = 100;
|
|
27
26
|
/**
|
|
28
27
|
* The take-home pay of an NHS post. Its `annualAllowance()` has no
|
|
29
|
-
* scheme pension input
|
|
30
|
-
* `
|
|
28
|
+
* scheme pension input: a year's input is a member's, read from
|
|
29
|
+
* `memberBenefits`' `pensionInputPeriod` through paye-calc's
|
|
30
|
+
* `definedBenefitInput`.
|
|
31
31
|
*
|
|
32
32
|
* @param salary Gross annual pay assessed for tax/NI (already
|
|
33
33
|
* FTE-adjusted and net of any salary sacrifice)
|
|
@@ -78,24 +78,4 @@ export function nhsTakeHome(salary, pensionRate, taxYear, taxRegion, options = {
|
|
|
78
78
|
}
|
|
79
79
|
return thp;
|
|
80
80
|
}
|
|
81
|
-
/**
|
|
82
|
-
* The pension annual allowance an NHS member's year meets, estimated from
|
|
83
|
-
* this year's 2015 Section accrual alone. The scheme is defined benefit,
|
|
84
|
-
* so the pension input is paye-calc's DB multiple of the year's accrual,
|
|
85
|
-
* not the contribution paid; without it adjusted income omits the scheme
|
|
86
|
-
* and the taper never bites for high earners. An opted-out member (rate
|
|
87
|
-
* 0) has no input.
|
|
88
|
-
*
|
|
89
|
-
* It takes no member history, so the input is a floor for anyone with
|
|
90
|
-
* pension already built up: that pension's revaluation beyond the CPI
|
|
91
|
-
* uplift, and any legacy section's growth, are inputs too, and are not
|
|
92
|
-
* counted here.
|
|
93
|
-
*
|
|
94
|
-
* Source: HMRC PTM053301 (DB pension input amount), the citation
|
|
95
|
-
* paye-calc's `DB_PENSION_INPUT_MULTIPLIER` carries.
|
|
96
|
-
*/
|
|
97
|
-
export function nhsAnnualAllowance(salary, pensionRate, taxYear, taxRegion) {
|
|
98
|
-
const isMember = pensionRate > 0;
|
|
99
|
-
return nhsTakeHome(salary, pensionRate, taxYear, taxRegion).annualAllowance(isMember ? { dbAnnualAccrual: yearlyAccrual(salary) } : {});
|
|
100
|
-
}
|
|
101
81
|
//# sourceMappingURL=take-home.js.map
|
package/dist/take-home.js.map
CHANGED
|
@@ -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,UAAU,EACV,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,KAAK,GACN,MAAM,sBAAsB,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;AAO9B,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC,qEAAqE;AACrE,MAAM,QAAQ,GAAG,GAAG,CAAC;AAerB;;;;;;;;;;;;;GAaG;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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@casomoltd/nhs-pay",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.32.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.
|
|
70
|
+
"@casomoltd/paye-calc": ">=0.15.0"
|
|
71
71
|
},
|
|
72
72
|
"devDependencies": {
|
|
73
|
-
"@casomoltd/paye-calc": "^0.
|
|
73
|
+
"@casomoltd/paye-calc": "^0.15.0",
|
|
74
74
|
"@casomoltd/tooling": "^0.37.0",
|
|
75
75
|
"@commitlint/cli": "^20.0.0",
|
|
76
76
|
"@js-temporal/polyfill": "^0.5.1",
|