@casomoltd/nhs-pay 0.30.0 → 0.31.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 +69 -251
- 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 +16 -0
- package/dist/document-source.js +3 -1
- package/dist/document-source.js.map +1 -1
- package/dist/errors.d.ts +46 -11
- package/dist/errors.js +68 -28
- package/dist/errors.js.map +1 -1
- package/dist/factor-basis.d.ts +14 -0
- package/dist/factor-basis.js.map +1 -1
- package/dist/index.d.ts +13 -11
- package/dist/index.js +6 -5
- package/dist/index.js.map +1 -1
- package/dist/member/benefits.js +18 -11
- 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 +17 -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 +91 -56
- package/dist/pension/ledger.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 +13 -33
- package/dist/pension/uplift.js +11 -56
- 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 +34 -35
- package/dist/revaluation.js +41 -41
- 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 +13 -9
- package/dist/sections/final-salary.js.map +1 -1
- package/dist/sections/section-2015.d.ts +2 -1
- package/dist/sections/section-2015.js.map +1 -1
- package/dist/sources.d.ts +10 -0
- package/dist/sources.js +20 -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/errors.d.ts
CHANGED
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
* the library does not publish ({@link ScaleUnavailable} and
|
|
5
5
|
* siblings — never silently substitute another year's or nation's
|
|
6
6
|
* figures), a member it cannot build pay for
|
|
7
|
-
* ({@link PayPathUnavailable}),
|
|
7
|
+
* ({@link PayPathUnavailable}), service it does not model
|
|
8
8
|
* ({@link BenefitNotModelled}, keyed by a {@link NOT_MODELLED}
|
|
9
|
-
* code)
|
|
9
|
+
* code), and a read before a member's statement, where no balance
|
|
10
|
+
* exists ({@link BeforeStatement}).
|
|
10
11
|
* - RangeError, thrown where a caller's input cannot be true.
|
|
11
12
|
* - {@link invariant} — an internal consistency guard. Its failure
|
|
12
13
|
* is a library bug, not an input problem, so no caller catches it;
|
|
@@ -19,15 +20,6 @@ interface YearsMonths {
|
|
|
19
20
|
readonly years: number;
|
|
20
21
|
readonly months: number;
|
|
21
22
|
}
|
|
22
|
-
/**
|
|
23
|
-
* Assert a domain invariant that must ALWAYS hold. Throws a bare
|
|
24
|
-
* Error when `condition` is false. Unlike the absent-data errors
|
|
25
|
-
* below — which callers catch by type — an invariant failure signals
|
|
26
|
-
* an internal inconsistency (a regression), so it is deliberately a
|
|
27
|
-
* plain, uncatchable-by-type throw: better a loud stop in a test or
|
|
28
|
-
* page than a silently wrong figure.
|
|
29
|
-
*/
|
|
30
|
-
export declare function invariant(condition: unknown, message: string): asserts condition;
|
|
31
23
|
/**
|
|
32
24
|
* Thrown when no pay scale is published for a
|
|
33
25
|
* (nation, year), optionally narrowed to a grade and a
|
|
@@ -158,6 +150,40 @@ export declare class BenefitNotModelled extends Error {
|
|
|
158
150
|
readonly code: NotModelled;
|
|
159
151
|
constructor(code: NotModelled, detail: string);
|
|
160
152
|
}
|
|
153
|
+
/** What a {@link BeforeStatement} refused, as a closed set a consumer can
|
|
154
|
+
* branch on. */
|
|
155
|
+
export declare const STATEMENT_READS: {
|
|
156
|
+
/** A leaving, which a walk would never reach. */
|
|
157
|
+
readonly leaving: "leaving";
|
|
158
|
+
/** The balance held on a date. */
|
|
159
|
+
readonly balance: "balance";
|
|
160
|
+
/** The close of a scheme year. */
|
|
161
|
+
readonly yearClose: "year-close";
|
|
162
|
+
};
|
|
163
|
+
export type StatementRead = (typeof STATEMENT_READS)[keyof typeof STATEMENT_READS];
|
|
164
|
+
/**
|
|
165
|
+
* A read of a member's 2015 Section balance on a date before their
|
|
166
|
+
* statement's 31 March, or a leaving before it. Not a build to come: a
|
|
167
|
+
* statement gives a balance at its 31 March and nothing of the dates
|
|
168
|
+
* before it, so there is no figure to give, and answering with the
|
|
169
|
+
* statement's own balance would state one nobody holds. Data absence,
|
|
170
|
+
* like {@link ScaleUnavailable}.
|
|
171
|
+
*/
|
|
172
|
+
export declare class BeforeStatement extends Error {
|
|
173
|
+
/** What was refused. */
|
|
174
|
+
readonly read: StatementRead;
|
|
175
|
+
/** The date it was asked on. */
|
|
176
|
+
readonly on: Date;
|
|
177
|
+
/** The statement's 31 March. */
|
|
178
|
+
readonly statementDate: Date;
|
|
179
|
+
constructor(
|
|
180
|
+
/** What was refused. */
|
|
181
|
+
read: StatementRead,
|
|
182
|
+
/** The date it was asked on. */
|
|
183
|
+
on: Date,
|
|
184
|
+
/** The statement's 31 March. */
|
|
185
|
+
statementDate: Date);
|
|
186
|
+
}
|
|
161
187
|
/** Why an additional pension purchase is refused, as a closed set a
|
|
162
188
|
* consumer can branch on. */
|
|
163
189
|
export declare const ADDITIONAL_PENSION_REFUSALS: {
|
|
@@ -184,4 +210,13 @@ export declare class AdditionalPensionUnavailable extends Error {
|
|
|
184
210
|
readonly code: AdditionalPensionRefusal;
|
|
185
211
|
constructor(code: AdditionalPensionRefusal, detail: string);
|
|
186
212
|
}
|
|
213
|
+
/**
|
|
214
|
+
* Assert a domain invariant that must ALWAYS hold. Throws a bare
|
|
215
|
+
* Error when `condition` is false. Unlike the absent-data errors
|
|
216
|
+
* above — which callers catch by type — an invariant failure signals
|
|
217
|
+
* an internal inconsistency (a regression), so it is deliberately a
|
|
218
|
+
* plain, uncatchable-by-type throw: better a loud stop in a test or
|
|
219
|
+
* page than a silently wrong figure.
|
|
220
|
+
*/
|
|
221
|
+
export declare function invariant(condition: unknown, message: string): asserts condition;
|
|
187
222
|
export {};
|
package/dist/errors.js
CHANGED
|
@@ -4,27 +4,15 @@
|
|
|
4
4
|
* the library does not publish ({@link ScaleUnavailable} and
|
|
5
5
|
* siblings — never silently substitute another year's or nation's
|
|
6
6
|
* figures), a member it cannot build pay for
|
|
7
|
-
* ({@link PayPathUnavailable}),
|
|
7
|
+
* ({@link PayPathUnavailable}), service it does not model
|
|
8
8
|
* ({@link BenefitNotModelled}, keyed by a {@link NOT_MODELLED}
|
|
9
|
-
* code)
|
|
9
|
+
* code), and a read before a member's statement, where no balance
|
|
10
|
+
* exists ({@link BeforeStatement}).
|
|
10
11
|
* - RangeError, thrown where a caller's input cannot be true.
|
|
11
12
|
* - {@link invariant} — an internal consistency guard. Its failure
|
|
12
13
|
* is a library bug, not an input problem, so no caller catches it;
|
|
13
14
|
* it throws a bare Error to fail loud in tests and pages.
|
|
14
15
|
*/
|
|
15
|
-
/**
|
|
16
|
-
* Assert a domain invariant that must ALWAYS hold. Throws a bare
|
|
17
|
-
* Error when `condition` is false. Unlike the absent-data errors
|
|
18
|
-
* below — which callers catch by type — an invariant failure signals
|
|
19
|
-
* an internal inconsistency (a regression), so it is deliberately a
|
|
20
|
-
* plain, uncatchable-by-type throw: better a loud stop in a test or
|
|
21
|
-
* page than a silently wrong figure.
|
|
22
|
-
*/
|
|
23
|
-
export function invariant(condition, message) {
|
|
24
|
-
if (!condition) {
|
|
25
|
-
throw new Error(message);
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
16
|
/**
|
|
29
17
|
* Thrown when no pay scale is published for a
|
|
30
18
|
* (nation, year), optionally narrowed to a grade and a
|
|
@@ -128,17 +116,6 @@ export class AwardUnavailable extends Error {
|
|
|
128
116
|
this.name = 'AwardUnavailable';
|
|
129
117
|
}
|
|
130
118
|
}
|
|
131
|
-
function scaleMessage(nation, year, gradeId, pointLabel) {
|
|
132
|
-
if (pointLabel !== undefined) {
|
|
133
|
-
return `No scale point "${pointLabel}" for `
|
|
134
|
-
+ `${gradeId} in ${nation} ${year}`;
|
|
135
|
-
}
|
|
136
|
-
if (gradeId !== undefined) {
|
|
137
|
-
return `No published scale for ${gradeId} in `
|
|
138
|
-
+ `${nation} ${year}`;
|
|
139
|
-
}
|
|
140
|
-
return `No published pay scale for ${nation} ${year}`;
|
|
141
|
-
}
|
|
142
119
|
/**
|
|
143
120
|
* A pay-point label matched more than one point on a scale.
|
|
144
121
|
*
|
|
@@ -155,8 +132,8 @@ export class AmbiguousScalePoint extends Error {
|
|
|
155
132
|
matches;
|
|
156
133
|
constructor(grade, pointLabel, matches) {
|
|
157
134
|
super(`Pay point "${pointLabel}" matches ${matches} points on `
|
|
158
|
-
+ `${grade} — it does not identify one
|
|
159
|
-
+ '
|
|
135
|
+
+ `${grade} — it does not identify one; pass the point itself `
|
|
136
|
+
+ 'where the caller holds it.');
|
|
160
137
|
this.grade = grade;
|
|
161
138
|
this.pointLabel = pointLabel;
|
|
162
139
|
this.matches = matches;
|
|
@@ -210,6 +187,43 @@ export class BenefitNotModelled extends Error {
|
|
|
210
187
|
this.name = 'BenefitNotModelled';
|
|
211
188
|
}
|
|
212
189
|
}
|
|
190
|
+
/** What a {@link BeforeStatement} refused, as a closed set a consumer can
|
|
191
|
+
* branch on. */
|
|
192
|
+
export const STATEMENT_READS = {
|
|
193
|
+
/** A leaving, which a walk would never reach. */
|
|
194
|
+
leaving: 'leaving',
|
|
195
|
+
/** The balance held on a date. */
|
|
196
|
+
balance: 'balance',
|
|
197
|
+
/** The close of a scheme year. */
|
|
198
|
+
yearClose: 'year-close',
|
|
199
|
+
};
|
|
200
|
+
/**
|
|
201
|
+
* A read of a member's 2015 Section balance on a date before their
|
|
202
|
+
* statement's 31 March, or a leaving before it. Not a build to come: a
|
|
203
|
+
* statement gives a balance at its 31 March and nothing of the dates
|
|
204
|
+
* before it, so there is no figure to give, and answering with the
|
|
205
|
+
* statement's own balance would state one nobody holds. Data absence,
|
|
206
|
+
* like {@link ScaleUnavailable}.
|
|
207
|
+
*/
|
|
208
|
+
export class BeforeStatement extends Error {
|
|
209
|
+
read;
|
|
210
|
+
on;
|
|
211
|
+
statementDate;
|
|
212
|
+
constructor(
|
|
213
|
+
/** What was refused. */
|
|
214
|
+
read,
|
|
215
|
+
/** The date it was asked on. */
|
|
216
|
+
on,
|
|
217
|
+
/** The statement's 31 March. */
|
|
218
|
+
statementDate) {
|
|
219
|
+
super(`A ${read} on ${on.toDateString()}, before the statement's `
|
|
220
|
+
+ `balance at ${statementDate.toDateString()}`);
|
|
221
|
+
this.read = read;
|
|
222
|
+
this.on = on;
|
|
223
|
+
this.statementDate = statementDate;
|
|
224
|
+
this.name = 'BeforeStatement';
|
|
225
|
+
}
|
|
226
|
+
}
|
|
213
227
|
/** Why an additional pension purchase is refused, as a closed set a
|
|
214
228
|
* consumer can branch on. */
|
|
215
229
|
export const ADDITIONAL_PENSION_REFUSALS = {
|
|
@@ -239,4 +253,30 @@ export class AdditionalPensionUnavailable extends Error {
|
|
|
239
253
|
this.name = 'AdditionalPensionUnavailable';
|
|
240
254
|
}
|
|
241
255
|
}
|
|
256
|
+
/**
|
|
257
|
+
* Assert a domain invariant that must ALWAYS hold. Throws a bare
|
|
258
|
+
* Error when `condition` is false. Unlike the absent-data errors
|
|
259
|
+
* above — which callers catch by type — an invariant failure signals
|
|
260
|
+
* an internal inconsistency (a regression), so it is deliberately a
|
|
261
|
+
* plain, uncatchable-by-type throw: better a loud stop in a test or
|
|
262
|
+
* page than a silently wrong figure.
|
|
263
|
+
*/
|
|
264
|
+
export function invariant(condition, message) {
|
|
265
|
+
if (!condition) {
|
|
266
|
+
throw new Error(message);
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
/** The message a missing scale, grade or point gives, most specific
|
|
270
|
+
* first. */
|
|
271
|
+
function scaleMessage(nation, year, gradeId, pointLabel) {
|
|
272
|
+
if (pointLabel !== undefined) {
|
|
273
|
+
return `No scale point "${pointLabel}" for `
|
|
274
|
+
+ `${gradeId} in ${nation} ${year}`;
|
|
275
|
+
}
|
|
276
|
+
if (gradeId !== undefined) {
|
|
277
|
+
return `No published scale for ${gradeId} in `
|
|
278
|
+
+ `${nation} ${year}`;
|
|
279
|
+
}
|
|
280
|
+
return `No published pay scale for ${nation} ${year}`;
|
|
281
|
+
}
|
|
242
282
|
//# sourceMappingURL=errors.js.map
|
package/dist/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAeH;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAE9B;IAIA;IACA;IAEA;IARX,YACW,MAAc;IACvB;;8CAE0C;IACjC,IAAa,EACb,OAAgB;IACzB,6DAA6D;IACpD,UAAmB;QAE5B,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;QAT9C,WAAM,GAAN,MAAM,CAAQ;QAId,SAAI,GAAJ,IAAI,CAAS;QACb,YAAO,GAAP,OAAO,CAAS;QAEhB,eAAU,GAAV,UAAU,CAAS;QAG5B,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAErC;IACA;IAFX,YACW,IAAa,EACb,MAAc;QAEvB,KAAK,CACH,sCAAsC,MAAM,IAAI,IAAI,EAAE,CACvD,CAAC;QALO,SAAI,GAAJ,IAAI,CAAS;QACb,WAAM,GAAN,MAAM,CAAQ;QAKvB,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IACnD,wDAAwD;IAC/C,WAAW,CAAS;IAC7B;gCAC4B;IACnB,QAAQ,CAAS;IACjB,OAAO,CAAmB;IAC1B,KAAK,CAAS;IACd,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,SAAS,CAAS;IAE3B,YAAY,EAAC,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAMtC;QACC,MAAM,EAAC,QAAQ,EAAE,WAAW,EAAC,GAAG,UAAU,CAAC;QAC3C,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,QAAQ;YACzB,CAAC,CAAC,GAAG,QAAQ,KAAK,WAAW,mBAAmB,EAAE,CAAC,KAAK,KAAK;kBACzD,GAAG,EAAE,CAAC,MAAM,WAAW,GAAG,CAAC,KAAK,MAAM,GAAG,CAAC,MAAM,KAAK;YACzD,CAAC,CAAC,GAAG,QAAQ,KAAK,WAAW,UAAU,EAAE,CAAC,KAAK,MAAM,EAAE,CAAC,MAAM,KAAK;kBAC/D,cAAc,KAAK,CAAC,QAAQ,YAAY;kBACxC,GAAG,GAAG,CAAC,KAAK,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC;IAC9B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAG9B;IACA;IAHX;IACE,6CAA6C;IACpC,IAAa,EACb,MAAc;QAEvB,KAAK,CAAC,iCAAiC,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC;QAHhD,SAAI,GAAJ,IAAI,CAAS;QACb,WAAM,GAAN,MAAM,CAAQ;QAGvB,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAEjC;IACA;IACA;IAHX,YACW,KAAa,EACb,UAAkB,EAClB,OAAe;QAExB,KAAK,CACH,cAAc,UAAU,aAAa,OAAO,aAAa;cACvD,GAAG,KAAK,qDAAqD;cAC7D,4BAA4B,CAC/B,CAAC;QARO,UAAK,GAAL,KAAK,CAAQ;QACb,eAAU,GAAV,UAAU,CAAQ;QAClB,YAAO,GAAP,OAAO,CAAQ;QAOxB,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IACtB;IAArB,YAAqB,MAAc;QACjC,KAAK,CAAC,6BAA6B,MAAM,EAAE,CAAC,CAAC;QAD1B,WAAM,GAAN,MAAM,CAAQ;QAEjC,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED;;4CAE4C;AAC5C,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,iDAAiD;IACjD,cAAc,EAAE,kBAAkB;IAClC,iDAAiD;IACjD,kBAAkB,EAAE,sBAAsB;IAC1C,iDAAiD;IACjD,aAAa,EAAE,iBAAiB;IAChC,iDAAiD;IACjD,qBAAqB,EAAE,gCAAgC;IACvD,iDAAiD;IACjD,uBAAuB,EAAE,2BAA2B;IACpD,iDAAiD;IACjD,mBAAmB,EAAE,gCAAgC;IACrD,iDAAiD;IACjD,cAAc,EAAE,0BAA0B;CAClC,CAAC;AAIX;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IACtB;IAArB,YAAqB,IAAiB,EAAE,MAAc;QACpD,KAAK,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;QADd,SAAI,GAAJ,IAAI,CAAa;QAEpC,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED;iBACiB;AACjB,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,iDAAiD;IACjD,OAAO,EAAE,SAAS;IAClB,kCAAkC;IAClC,OAAO,EAAE,SAAS;IAClB,kCAAkC;IAClC,SAAS,EAAE,YAAY;CACf,CAAC;AAKX;;;;;;;GAOG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAG7B;IAEA;IAEA;IANX;IACE,wBAAwB;IACf,IAAmB;IAC5B,gCAAgC;IACvB,EAAQ;IACjB,gCAAgC;IACvB,aAAmB;QAE5B,KAAK,CAAC,KAAK,IAAI,OAAO,EAAE,CAAC,YAAY,EAAE,2BAA2B;cAC9D,cAAc,aAAa,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAPzC,SAAI,GAAJ,IAAI,CAAe;QAEnB,OAAE,GAAF,EAAE,CAAM;QAER,kBAAa,GAAb,aAAa,CAAM;QAI5B,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED;8BAC8B;AAC9B,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,wCAAwC;IACxC,OAAO,EAAE,UAAU;IACnB,4CAA4C;IAC5C,SAAS,EAAE,YAAY;IACvB,yDAAyD;IACzD,YAAY,EAAE,eAAe;IAC7B,uEAAuE;IACvE,YAAY,EAAE,eAAe;IAC7B;oBACgB;IAChB,iBAAiB,EAAE,qBAAqB;CAChC,CAAC;AAMX;;;;;GAKG;AACH,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IAChC;IAArB,YAAqB,IAA8B,EAAE,MAAc;QACjE,KAAK,CAAC,gCAAgC,MAAM,EAAE,CAAC,CAAC;QAD7B,SAAI,GAAJ,IAAI,CAA0B;QAEjD,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC;IAC7C,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CACvB,SAAkB,EAClB,OAAe;IAEf,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC;AAED;aACa;AACb,SAAS,YAAY,CACnB,MAAc,EACd,IAAa,EACb,OAAgB,EAChB,UAAmB;IAEnB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,mBAAmB,UAAU,QAAQ;cACxC,GAAG,OAAO,OAAO,MAAM,IAAI,IAAI,EAAE,CAAC;IACxC,CAAC;IACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,0BAA0B,OAAO,MAAM;cAC1C,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;IAC1B,CAAC;IACD,OAAO,8BAA8B,MAAM,IAAI,IAAI,EAAE,CAAC;AACxD,CAAC"}
|
package/dist/factor-basis.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { LEGACY_PENSION_AGES } from './pension/ages.js';
|
|
2
2
|
import { FactorTable } from './gad/factor-table.js';
|
|
3
|
+
import type { ProjectionMoney } from './pension/money.js';
|
|
3
4
|
import type { FactorProvenance, FactorTableKind } from './gad/factor-table.js';
|
|
4
5
|
/**
|
|
5
6
|
* The factor tables the library reads, named for what each is for. The
|
|
@@ -122,6 +123,19 @@ export type FactorOutcome = {
|
|
|
122
123
|
readonly source: typeof FACTOR_SOURCES.noLateUplift;
|
|
123
124
|
readonly factor: 1;
|
|
124
125
|
};
|
|
126
|
+
/**
|
|
127
|
+
* A figure before and after its early or late factor, and the factor.
|
|
128
|
+
* Read the figure before it from `beforeFactor`, never by dividing `after`
|
|
129
|
+
* by `factor`: a pension and its lump sum each have their own factor.
|
|
130
|
+
* `F` is `FactorOutcome | null` where the rules may apply no factor
|
|
131
|
+
* because they pay nothing.
|
|
132
|
+
*/
|
|
133
|
+
export interface Factored<F extends FactorOutcome | null = FactorOutcome> {
|
|
134
|
+
readonly beforeFactor: ProjectionMoney;
|
|
135
|
+
/** After the factor: what is paid. */
|
|
136
|
+
readonly after: ProjectionMoney;
|
|
137
|
+
readonly factor: F;
|
|
138
|
+
}
|
|
125
139
|
/**
|
|
126
140
|
* Read the factor for a drawing. The date decides the direction as well
|
|
127
141
|
* as the cell, so a basis whose direction the dates contradict is a bug
|
package/dist/factor-basis.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"factor-basis.js","sourceRoot":"","sources":["../src/factor-basis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAC,mBAAmB,EAAE,OAAO,EAAC,MAAM,YAAY,CAAC;AACxD,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,mBAAmB,EAAC,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAC,WAAW,EAAC,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"factor-basis.js","sourceRoot":"","sources":["../src/factor-basis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAC,mBAAmB,EAAE,OAAO,EAAC,MAAM,YAAY,CAAC;AACxD,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,mBAAmB,EAAC,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAC,WAAW,EAAC,MAAM,uBAAuB,CAAC;AAQlD,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,SAAS,EAAC,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAC,SAAS,EAAC,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAC,SAAS,EAAC,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAC,SAAS,EAAC,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAC,SAAS,EAAC,MAAM,+BAA+B,CAAC;AAExD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B;2CACuC;IACvC,SAAS,EAAE,OAAO;IAClB;iCAC6B;IAC7B,QAAQ,EAAE,OAAO;IACjB;sCACkC;IAClC,yBAAyB,EAAE,OAAO;IAClC,6CAA6C;IAC7C,gBAAgB,EAAE,OAAO;IACzB,wDAAwD;IACxD,gBAAgB,EAAE,OAAO;IACzB;oDACgD;IAChD,UAAU,EAAE,OAAO;IACnB,oCAAoC;IACpC,QAAQ,EAAE,OAAO;CACT,CAAC;AAEX,MAAM,MAAM,GAAG;IACb,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,IAAI,WAAW,CAAC,SAAS,CAAC;IACrD,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,WAAW,CAAC,SAAS,CAAC;IACpD,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAAE,IAAI,WAAW,CAAC,SAAS,CAAC;IACrE,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE,IAAI,WAAW,CAAC,SAAS,CAAC;IAC5D,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE,IAAI,WAAW,CAAC,SAAS,CAAC;IAC5D,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,IAAI,WAAW,CAAC,SAAS,CAAC;IACtD,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,WAAW,CAAC,SAAS,CAAC;CAC5C,CAAC;AAEX;qEACqE;AACrE,MAAM,UAAU,WAAW,CACzB,GAAM;IAEN,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED;;+DAE+D;AAC/D,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,UAAU;IACnB;oEACgE;IAChE,iBAAiB,EAAE,oBAAoB;CAC/B,CAAC;AASX,qDAAqD;AACrD,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKX,2EAA2E;AAC3E,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,CAAC;AAyBjC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,KAAK,EAAE,OAAO;IACd,YAAY,EAAE,uBAAuB;IACrC,YAAY,EAAE,+BAA+B;CACrC,CAAC;AAiCX,oDAAoD;AACpD,SAAS,QAAQ,CACf,KAAkB;IAElB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,KAAK,WAAW,CAAC;IAClD,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,KAAK,mBAAmB,CAAC,WAAW,CAAC;IACtE,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,KAAK,iBAAiB,CAAC,KAAK,CAAC;IAC1D,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,iBAAiB,GACrB,KAAK,CAAC,OAAO,KAAK,cAAc,CAAC,iBAAiB,CAAC;QACrD,IAAI,KAAK;YAAE,OAAO,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAClD,OAAO,iBAAiB;YACtB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,yBAAyB,CAAC;YACjD,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,KAAK,cAAc,CAAC,OAAO,CAAC;QACzD,OAAO,OAAO;YACZ,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC;YACxC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,KAAK;QACV,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC;QAClC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,GAAG,CACjB,KAAuD,EACvB,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC;AAE9D;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,KAAkB,EAClB,WAAiB,EACjB,KAAW;IAEX,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,KAAK,WAAW,CAAC;IAClD,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;IAC3D,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAC5C,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC;IAC3D,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO,EAAC,MAAM,EAAE,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC,EAAC,CAAC;IAC1D,CAAC;IACD,MAAM,UAAU,GAAG,KAAK,GAAG,EAAE,CAAC;IAC9B,SAAS,CACP,UAAU,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,iBAAiB,CAAC,KAAK,CAAC,EAC5D,qBAAqB,KAAK,CAAC,SAAS,oBAAoB;UACpD,GAAG,KAAK,CAAC,YAAY,EAAE,YAAY,EAAE,CAAC,YAAY,EAAE,EAAE,CAC3D,CAAC;IACF,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,qEAAqE;IACrE,oEAAoE;IACpE,sBAAsB;IACtB,MAAM,gBAAgB,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC3C,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO;YACL,MAAM,EAAE,cAAc,CAAC,KAAK;YAC5B,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,mBAAmB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAClE,SAAS,EAAE,KAAK,CAAC,IAAI;YACrB,UAAU,EAAE,KAAK,CAAC,UAAU;SAC7B,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,UAAU;QACvB,CAAC,CAAC,mBAAmB,CAAC,KAAK,EAAE,EAAE,CAAC;QAChC,CAAC,CAAC,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACnC,OAAO;QACL,MAAM,EAAE,cAAc,CAAC,KAAK;QAC5B,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC;QAC/B,SAAS,EAAE,KAAK,CAAC,IAAI;QACrB,UAAU,EAAE,KAAK,CAAC,UAAU;KAC7B,CAAC;AACJ,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ export { afcBand1 } from './afc-scales.js';
|
|
|
2
2
|
export type { AfcBand1, AfcBand1Published } from './afc-scales.js';
|
|
3
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
|
-
export type { ScalePoint } from './scale-point.js';
|
|
5
|
+
export type { PayLadder, ScalePoint } from './scale-point.js';
|
|
6
6
|
export { PensionTiers, getEmployerPensionRate, getPensionScheme, getPensionTiers, getPensionTiersVO, lookupPensionTier, pensionTierRate, } from './pension.js';
|
|
7
7
|
export type { EmployerPensionRate, NhsPensionScheme, PensionTier, } from './pension.js';
|
|
8
8
|
export type { SalaryRange } from './values.js';
|
|
@@ -19,13 +19,13 @@ export { ADDITIONAL_PENSION_LIMIT, ADDITIONAL_PENSION_PAYMENTS, ADDITIONAL_PENSI
|
|
|
19
19
|
export type { AdditionalPensionPayment, AdditionalPensionPurchase, } from './additional-pension.js';
|
|
20
20
|
export { ADDITIONAL_PENSION_COVERS } from './gad/additional-pension-table.js';
|
|
21
21
|
export type { AdditionalPensionCover, AdditionalPensionProvenance, } from './gad/additional-pension-table.js';
|
|
22
|
-
export { ADDITIONAL_PENSION_REFUSALS, AdditionalPensionUnavailable, AmbiguousScalePoint, AwardUnavailable, BenefitNotModelled, NOT_MODELLED, PayPathUnavailable, PensionTiersUnavailable, RetirementFactorOutOfRange, ScaleUnavailable, } from './errors.js';
|
|
23
|
-
export type { AdditionalPensionRefusal, NotModelled } from './errors.js';
|
|
22
|
+
export { ADDITIONAL_PENSION_REFUSALS, AdditionalPensionUnavailable, AmbiguousScalePoint, AwardUnavailable, BeforeStatement, BenefitNotModelled, NOT_MODELLED, PayPathUnavailable, PensionTiersUnavailable, RetirementFactorOutOfRange, ScaleUnavailable, STATEMENT_READS, } from './errors.js';
|
|
23
|
+
export type { AdditionalPensionRefusal, NotModelled, StatementRead, } from './errors.js';
|
|
24
24
|
export { DocumentSource } from './document-source.js';
|
|
25
25
|
export { isoDate, isoMonth, monthOf, firstOfMonth, monthToDate, isoToDate, isoDateOf, } from './iso-date.js';
|
|
26
26
|
export type { IsoDate, IsoMonth } from './iso-date.js';
|
|
27
|
-
export type { DocumentSourceFields, SourceCurrency, } from './document-source.js';
|
|
28
|
-
export { AFC_ENGLAND_SCALES_2025, AFC_ENGLAND_SCALES_2026, AFC_NI_2025, AFC_SCOTLAND, AFC_SCOTLAND_36_HOUR_WEEK, AFC_W_01_2026, AFC_W_02_2025, AFC_W_02_2026, AP_FACTSHEET_2026, DHSC_PETITION_779519, FA2004_SCH36_PARA_23ZB, SPPA_NHS_CIRCULAR_2025_09, HSC_TC8_05_2025, MD_W_01_2025, MD_W_01_2026, PC_MD_1_2026_R2, PCS_DD_2025_01, PCS_DD_2025_01_ADDENDUM, PCS_DD_2026_01, PCS_DD_2026_02, } from './sources.js';
|
|
27
|
+
export type { DocumentSourceFields, PageSource, SourceCurrency, } from './document-source.js';
|
|
28
|
+
export { AFC_ENGLAND_SCALES_2025, AFC_ENGLAND_SCALES_2026, AFC_NI_2025, AFC_SCOTLAND, AFC_SCOTLAND_36_HOUR_WEEK, AFC_W_01_2026, AFC_W_02_2025, AFC_W_02_2026, AP_FACTSHEET_2026, DHSC_PETITION_779519, FA2004_SCH36_PARA_23ZB, SPPA_NHS_CIRCULAR_2025_09, HSC_TC8_05_2025, MD_W_01_2025, MD_W_01_2026, NHSBSA_ESTIMATE_GUIDE, NHSBSA_STATEMENT_GUIDE, PC_MD_1_2026_R2, PCS_DD_2025_01, PCS_DD_2025_01_ADDENDUM, PCS_DD_2026_01, PCS_DD_2026_02, } from './sources.js';
|
|
29
29
|
export { AWARD_FAMILIES, afcAward, anyNationSettled, awardFamilyFor, awardsFor, changesFor, } from './award.js';
|
|
30
30
|
export type { AwardFamily, ForthcomingChange, PayAward, PayChange, PayScaleId, } from './award.js';
|
|
31
31
|
export { payRound } from './pay-round.js';
|
|
@@ -39,10 +39,10 @@ export type { PayBasis, PayPath, YearPay } from './pay-path.js';
|
|
|
39
39
|
export { ACCRUALS, memberBenefits, PAST_YEARS, PERIOD_KINDS, REMEDY, REMEDY_BASES, SECTION_OPENED, SECTIONS, } from './member/index.js';
|
|
40
40
|
export { PAY_MEASURES } from './sections/final-salary.js';
|
|
41
41
|
export type { PayMeasure } from './sections/final-salary.js';
|
|
42
|
-
export type { Assumptions, Award, DeclaredPeriod, Holdings, LegacyRules, LegacySectionId, Member, MemberBenefits, PastYears, Position, RemedyBasis, RemedyElection, RetirementChoices, SectionId, ServicePeriod, } from './member/index.js';
|
|
42
|
+
export type { Assumptions, Award, DeclaredPeriod, Holdings, LegacyRules, LegacySectionId, Member, MemberBenefits, PastYears, Position, RemedyBasis, RemedyElection, RetirementChoices, RulerLedgers, Section2015Walk, SectionId, ServicePeriod, StatementBalance, } from './member/index.js';
|
|
43
43
|
export type { DeclaredPay, MemberPay } from './pay-path.js';
|
|
44
44
|
export { FACTOR_APPLIES, FACTOR_SOURCES } from './factor-basis.js';
|
|
45
|
-
export type { Applies2015, FactorOutcome } from './factor-basis.js';
|
|
45
|
+
export type { Applies2015, Factored, FactorOutcome } from './factor-basis.js';
|
|
46
46
|
export { factor2015 } from './sections/section-2015.js';
|
|
47
47
|
export { CASH_CHOICES } from './commutation.js';
|
|
48
48
|
export type { CashChoice } from './commutation.js';
|
|
@@ -59,8 +59,10 @@ export { createPrices, createPublishedPrices, inflationFactor, TODAYS_MONEY_CPI,
|
|
|
59
59
|
export type { CpiEntry, CpiSource, Prices, } from './pension/prices.js';
|
|
60
60
|
export { activeRatePct, deferredRatePct, upliftsFor, } from './pension/uplift.js';
|
|
61
61
|
export type { AppliedUplift, MemberPhase, UpliftSource, } from './pension/uplift.js';
|
|
62
|
-
export { schemeYearClosedBy, schemeYearEndDate, schemeYearEndFor, schemeYearStartDate,
|
|
63
|
-
export type {
|
|
62
|
+
export { isSchemeYearEnd, schemeYearAfter, schemeYearBefore, schemeYearClosedBy, schemeYearEnd, schemeYearEndDate, schemeYearEndFor, schemeYearStartDate, } from './pension/scheme-year.js';
|
|
63
|
+
export type { SchemeYearEnd } from './pension/scheme-year.js';
|
|
64
|
+
export { SEED_BASES, seedFromJoinDate, seedFromStatement, } from './pension/seed.js';
|
|
65
|
+
export type { LedgerSeed, SeedBasis } from './pension/seed.js';
|
|
64
66
|
export { buildLedger } from './pension/ledger.js';
|
|
65
67
|
export type { AppliedDrawing, AppliedLeaverAdjustment, LedgerRequest, LedgerYear, MemberLedger, } from './pension/ledger.js';
|
|
66
68
|
export type { EstimatedHistory } from './pension/history.js';
|
|
@@ -70,9 +72,9 @@ export { getHcasPcts, getHcasZone, } from './hcas-pcts.js';
|
|
|
70
72
|
export type { HcasPct } from './hcas-pcts.js';
|
|
71
73
|
export { AFC_REGIONS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, isAfcRegionId, isNation, resolveRegion, } from './regions.js';
|
|
72
74
|
export type { AfcRegionId, ResolvedRegion, } from './regions.js';
|
|
73
|
-
export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
|
|
75
|
+
export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, afcPointOf, getAfcScales, } from './bands.js';
|
|
74
76
|
export type { AfcBandMeta, AfcScaleData, } from './bands.js';
|
|
75
|
-
export {
|
|
77
|
+
export { nhsTakeHome } from './take-home.js';
|
|
76
78
|
export { afcWeekInForce, afcWeeklyHours, hoursPerYear } from './working-week.js';
|
|
77
79
|
export type { NhsTakeHomeOptions } from './take-home.js';
|
|
78
80
|
export { fmtMoney, fmtPct, fmtSalary, formatGBP, formatGBPPrecise, formatPct, formatPctPrecise, yearLabel, } from './format.js';
|
package/dist/index.js
CHANGED
|
@@ -13,14 +13,14 @@ export { DENTAL_GRADES, DENTAL_GRADE_IDS, DENTAL_PAY_YEARS, getDentalScales, } f
|
|
|
13
13
|
export { ADDITIONAL_PENSION_LIMIT, ADDITIONAL_PENSION_PAYMENTS, ADDITIONAL_PENSION_UNIT, additionalPensionCost, additionalPensionToBuy, } from './additional-pension.js';
|
|
14
14
|
export { ADDITIONAL_PENSION_COVERS } from './gad/additional-pension-table.js';
|
|
15
15
|
// ── Errors ───────────────────────────────────────
|
|
16
|
-
export { ADDITIONAL_PENSION_REFUSALS, AdditionalPensionUnavailable, AmbiguousScalePoint, AwardUnavailable, BenefitNotModelled, NOT_MODELLED, PayPathUnavailable, PensionTiersUnavailable, RetirementFactorOutOfRange, ScaleUnavailable, } from './errors.js';
|
|
16
|
+
export { ADDITIONAL_PENSION_REFUSALS, AdditionalPensionUnavailable, AmbiguousScalePoint, AwardUnavailable, BeforeStatement, BenefitNotModelled, NOT_MODELLED, PayPathUnavailable, PensionTiersUnavailable, RetirementFactorOutOfRange, ScaleUnavailable, STATEMENT_READS, } from './errors.js';
|
|
17
17
|
// ── Cited documents ──────────────────────────────
|
|
18
18
|
// Every published document the library reads a figure from. A consumer
|
|
19
19
|
// citing "where these figures come from" reads the record rather than
|
|
20
20
|
// keeping its own copy of the url.
|
|
21
21
|
export { DocumentSource } from './document-source.js';
|
|
22
22
|
export { isoDate, isoMonth, monthOf, firstOfMonth, monthToDate, isoToDate, isoDateOf, } from './iso-date.js';
|
|
23
|
-
export { AFC_ENGLAND_SCALES_2025, AFC_ENGLAND_SCALES_2026, AFC_NI_2025, AFC_SCOTLAND, AFC_SCOTLAND_36_HOUR_WEEK, AFC_W_01_2026, AFC_W_02_2025, AFC_W_02_2026, AP_FACTSHEET_2026, DHSC_PETITION_779519, FA2004_SCH36_PARA_23ZB, SPPA_NHS_CIRCULAR_2025_09, HSC_TC8_05_2025, MD_W_01_2025, MD_W_01_2026, PC_MD_1_2026_R2, PCS_DD_2025_01, PCS_DD_2025_01_ADDENDUM, PCS_DD_2026_01, PCS_DD_2026_02, } from './sources.js';
|
|
23
|
+
export { AFC_ENGLAND_SCALES_2025, AFC_ENGLAND_SCALES_2026, AFC_NI_2025, AFC_SCOTLAND, AFC_SCOTLAND_36_HOUR_WEEK, AFC_W_01_2026, AFC_W_02_2025, AFC_W_02_2026, AP_FACTSHEET_2026, DHSC_PETITION_779519, FA2004_SCH36_PARA_23ZB, SPPA_NHS_CIRCULAR_2025_09, HSC_TC8_05_2025, MD_W_01_2025, MD_W_01_2026, NHSBSA_ESTIMATE_GUIDE, NHSBSA_STATEMENT_GUIDE, PC_MD_1_2026_R2, PCS_DD_2025_01, PCS_DD_2025_01_ADDENDUM, PCS_DD_2026_01, PCS_DD_2026_02, } from './sources.js';
|
|
24
24
|
// ── Pay awards ───────────────────────────────────
|
|
25
25
|
export { AWARD_FAMILIES, afcAward, anyNationSettled, awardFamilyFor, awardsFor, changesFor, } from './award.js';
|
|
26
26
|
// ── Pay rounds ───────────────────────────────────
|
|
@@ -63,7 +63,8 @@ export { firstJoinedOf, LEGACY_PENSION_AGES, mayDrawOn, memberMinimumPensionAge,
|
|
|
63
63
|
// A consumer reads the ledger only when it wants the workings.
|
|
64
64
|
export { createPrices, createPublishedPrices, inflationFactor, TODAYS_MONEY_CPI, } from './pension/prices.js';
|
|
65
65
|
export { activeRatePct, deferredRatePct, upliftsFor, } from './pension/uplift.js';
|
|
66
|
-
export { schemeYearClosedBy, schemeYearEndDate, schemeYearEndFor, schemeYearStartDate,
|
|
66
|
+
export { isSchemeYearEnd, schemeYearAfter, schemeYearBefore, schemeYearClosedBy, schemeYearEnd, schemeYearEndDate, schemeYearEndFor, schemeYearStartDate, } from './pension/scheme-year.js';
|
|
67
|
+
export { SEED_BASES, seedFromJoinDate, seedFromStatement, } from './pension/seed.js';
|
|
67
68
|
export { buildLedger } from './pension/ledger.js';
|
|
68
69
|
// ── HCAS ─────────────────────────────────────────
|
|
69
70
|
export { HCAS_ZONE_IDS, calculateHcasSupplement, grossSalary, isHcasZoneId, } from './hcas.js';
|
|
@@ -72,9 +73,9 @@ export { getHcasPcts, getHcasZone, } from './hcas-pcts.js';
|
|
|
72
73
|
// ── Regions ──────────────────────────────────────
|
|
73
74
|
export { AFC_REGIONS, ZONE_TO_REGION, afcRegionToHcasZone, afcRegionToNation, isAfcRegionId, isNation, resolveRegion, } from './regions.js';
|
|
74
75
|
// ── Bands ────────────────────────────────────────
|
|
75
|
-
export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, getAfcScales, } from './bands.js';
|
|
76
|
+
export { AFC_CURRENT_YEAR, AFC_PREVIOUS_YEAR, afcPointOf, getAfcScales, } from './bands.js';
|
|
76
77
|
// ── Take-home ────────────────────────────────────
|
|
77
|
-
export {
|
|
78
|
+
export { nhsTakeHome } from './take-home.js';
|
|
78
79
|
// ── Working week ──────────────────────────────
|
|
79
80
|
export { afcWeekInForce, afcWeeklyHours, hoursPerYear } from './working-week.js';
|
|
80
81
|
// ── Format ───────────────────────────────────────
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,OAAO,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,
|
|
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,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,gBAAgB,EAChB,eAAe,GAChB,MAAM,aAAa,CAAC;AAKrB,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;AAOvB,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,aAAa,EACb,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EACzB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,qBAAqB,EACrB,sBAAsB,EACtB,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,mBAAmB,CAAC;AAC3B,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AAuBxD,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,EACL,aAAa,EACb,mBAAmB,EACnB,SAAS,EACT,uBAAuB,EACvB,YAAY,EACZ,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAa3B,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,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,UAAU,EACV,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,UAAU,EACV,YAAY,GACb,MAAM,YAAY,CAAC;AAMpB,oDAAoD;AACpD,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,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/member/benefits.js
CHANGED
|
@@ -31,10 +31,14 @@ import { buildPayPath } from '../pay-path.js';
|
|
|
31
31
|
import { npaDate } from '../dates.js';
|
|
32
32
|
import { sumMoney } from '../pension/money.js';
|
|
33
33
|
import { createPrices, createPublishedPrices, TODAYS_MONEY_CPI, } from '../pension/prices.js';
|
|
34
|
-
import {
|
|
34
|
+
import { schemeYearEndDate } from '../pension/scheme-year.js';
|
|
35
|
+
import { answersFrom } from '../pension/seed.js';
|
|
36
|
+
import { electionsFor, periodsOf, refuseElectionMismatch, REMEDY, servicePeriods, } from './service.js';
|
|
35
37
|
import { careerAward, finalSalaryValued, holdings, legacyAward, refuseLeavingAfterDeclared, RULES, section2015, seed2015, walksWindow, windowSeed, } from './valuation.js';
|
|
36
38
|
import { inputPeriods } from './input-period.js';
|
|
37
39
|
import { PAST_YEARS, SECTIONS } from './types.js';
|
|
40
|
+
/** The call every refusal of `at()`'s choices names. */
|
|
41
|
+
const ASKED = 'at';
|
|
38
42
|
/** The price series each reading of the past is priced on. Total over
|
|
39
43
|
* `PastYears`, so a new reading fails the build until it has one. */
|
|
40
44
|
const CASH_SERIES = {
|
|
@@ -76,8 +80,10 @@ export function memberBenefits(member, assumptions, today) {
|
|
|
76
80
|
return {
|
|
77
81
|
periods: periodsOf(held),
|
|
78
82
|
remedy,
|
|
83
|
+
elections: electionsFor(remedy),
|
|
79
84
|
legacy: legacy === null ? null : legacyOf(legacy.section),
|
|
80
85
|
payPath: built.payPath,
|
|
86
|
+
statementAnswersFrom: answersFrom(seed2015(built)),
|
|
81
87
|
minimumPensionAgeOn: (drawing) => memberMinimumPensionAge(history, drawing),
|
|
82
88
|
mayDrawOn: (drawing) => mayDrawOn(history, drawing),
|
|
83
89
|
now: () => holdings(built),
|
|
@@ -95,18 +101,18 @@ function position(b, choices) {
|
|
|
95
101
|
const own = careerAward(b, {
|
|
96
102
|
section: SECTIONS.s2015,
|
|
97
103
|
window: b.ordinary2015,
|
|
98
|
-
|
|
104
|
+
seed: seed2015(b),
|
|
99
105
|
}, dates);
|
|
100
106
|
awards.push(own.award);
|
|
101
|
-
const pension = sumMoney(awards.map((a) => a.pension), dates.drawing);
|
|
102
|
-
const automaticLumpSum = sumMoney(awards.map((a) => a.automaticLumpSum), dates.drawing);
|
|
107
|
+
const pension = sumMoney(awards.map((a) => a.pension.after), dates.drawing);
|
|
108
|
+
const automaticLumpSum = sumMoney(awards.map((a) => a.automaticLumpSum.after), dates.drawing);
|
|
103
109
|
return {
|
|
104
110
|
choices,
|
|
105
111
|
awards,
|
|
106
112
|
crystallised: { pension, automaticLumpSum },
|
|
107
113
|
cash: cashAt(pension, automaticLumpSum, choices.cash, nhsCommutationLimits(b.cashPrices)),
|
|
108
114
|
prices: b.cashPrices,
|
|
109
|
-
|
|
115
|
+
section2015: section2015(b, own, dates),
|
|
110
116
|
};
|
|
111
117
|
}
|
|
112
118
|
/** The legacy section's awards: on the legacy basis every legacy period
|
|
@@ -123,7 +129,7 @@ function legacyAwards(b, legacy, choices, dates) {
|
|
|
123
129
|
return [
|
|
124
130
|
finalSalary,
|
|
125
131
|
careerAward(b, {
|
|
126
|
-
section: legacy.section, window,
|
|
132
|
+
section: legacy.section, window, seed: windowSeed(window),
|
|
127
133
|
}, dates).award,
|
|
128
134
|
];
|
|
129
135
|
}
|
|
@@ -132,7 +138,8 @@ function refuseUnmodelled(member, remedy, legacy) {
|
|
|
132
138
|
// Deferred until the split of a pre-rollback balance is read:
|
|
133
139
|
// https://github.com/casomoltd/nhs-pay/issues/20
|
|
134
140
|
if (remedy && member.statement !== null
|
|
135
|
-
&&
|
|
141
|
+
&& schemeYearEndDate(member.statement.yearEnd)
|
|
142
|
+
< isoToDate(REMEDY.rollback)) {
|
|
136
143
|
throw new BenefitNotModelled(NOT_MODELLED.statementBeforeRollback, 'a statement from before rollback on 1 October 2023, which '
|
|
137
144
|
+ 'counts the remedy years in the 2015 Section');
|
|
138
145
|
}
|
|
@@ -159,15 +166,15 @@ function checked(b, choices) {
|
|
|
159
166
|
const leaving = isoToDate(choices.leaving);
|
|
160
167
|
const drawing = isoToDate(choices.drawing);
|
|
161
168
|
if (drawing < leaving) {
|
|
162
|
-
throw new RangeError(
|
|
169
|
+
throw new RangeError(`${ASKED}: drawn before leaving`);
|
|
163
170
|
}
|
|
164
|
-
refuseLeavingAfterDeclared(
|
|
165
|
-
refuseElectionMismatch(
|
|
171
|
+
refuseLeavingAfterDeclared(ASKED, b, leaving);
|
|
172
|
+
refuseElectionMismatch(ASKED, b.remedy, choices.remedy.kind);
|
|
166
173
|
// The scheme pays nothing before the minimum pension age outside ill
|
|
167
174
|
// health, so a figure there would be one no member could draw.
|
|
168
175
|
const { mayDraw, minimumAge } = drawingTest(b.history, choices.drawing);
|
|
169
176
|
if (!mayDraw) {
|
|
170
|
-
throw new RangeError(
|
|
177
|
+
throw new RangeError(`${ASKED}: drawn before the minimum pension age, ${minimumAge}`);
|
|
171
178
|
}
|
|
172
179
|
return { leaving, drawing };
|
|
173
180
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefits.js","sourceRoot":"","sources":["../../src/member/benefits.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,EAAC,MAAM,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAC,kBAAkB,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AAEzE,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,EACL,WAAW,EAAE,aAAa,EAAE,SAAS,EAAE,uBAAuB,EAC9D,gBAAgB,GACjB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAC,OAAO,EAAC,MAAM,aAAa,CAAC;AACpC,OAAO,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,YAAY,EAAE,qBAAqB,EAAE,gBAAgB,GACtD,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,SAAS,EAAE,sBAAsB,EAAE,MAAM,EAAE,cAAc,
|
|
1
|
+
{"version":3,"file":"benefits.js","sourceRoot":"","sources":["../../src/member/benefits.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,EAAC,MAAM,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAC,kBAAkB,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AAEzE,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,EACL,WAAW,EAAE,aAAa,EAAE,SAAS,EAAE,uBAAuB,EAC9D,gBAAgB,GACjB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAC,OAAO,EAAC,MAAM,aAAa,CAAC;AACpC,OAAO,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,YAAY,EAAE,qBAAqB,EAAE,gBAAgB,GACtD,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EACL,YAAY,EAAE,SAAS,EAAE,sBAAsB,EAAE,MAAM,EAAE,cAAc,GACxE,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,WAAW,EACrD,0BAA0B,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EACrE,UAAU,GACX,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAC;AAMhD,wDAAwD;AACxD,MAAM,KAAK,GAAG,IAAmC,CAAC;AAElD;sEACsE;AACtE,MAAM,WAAW,GAA2D;IAC1E,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,YAAY;IAClC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,qBAAqB;CAC9C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAc,EACd,WAAwB,EACxB,KAAW;IAEX,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,EAAC,MAAM,EAAE,YAAY,EAAC,GAAG,IAAI,CAAC;IACpC,MAAM,MAAM,GAAG,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC;IACzD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAmB;QAC9B,IAAI,EAAE,MAAM,CAAC,WAAW,EAAE,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC;KAC7D,CAAC;IACF,MAAM,YAAY,GAAG,CAAC,GAAW,EAAU,EAAE,CAC3C,WAAW,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjD,MAAM,KAAK,GAAU;QACnB,MAAM;QACN,OAAO;QACP,KAAK;QACL,IAAI;QACJ,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC;QACrD,MAAM;QACN,MAAM;QACN,YAAY;QACZ,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,UAAU,CAAC;QAChD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,CAAC;KACpD,CAAC;IACF,OAAO;QACL,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC;QACxB,MAAM;QACN,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC;QAC/B,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;QACzD,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,oBAAoB,EAAE,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClD,mBAAmB,EAAE,CAAC,OAAgB,EAAE,EAAE,CACxC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC;QAC3C,SAAS,EAAE,CAAC,OAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;QAC5D,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC1B,EAAE,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;QACzC,kBAAkB,EAAE,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC;KACtD,CAAC;AACJ,CAAC;AAED;wBACwB;AACxB,SAAS,QAAQ,CAAC,CAAQ,EAAE,OAA0B;IACpD,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,KAAK,IAAI;QAC9B,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE;QACzB,OAAO,EAAE,QAAQ,CAAC,KAAK;QACvB,MAAM,EAAE,CAAC,CAAC,YAAY;QACtB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;KAClB,EAAE,KAAK,CAAC,CAAC;IACV,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5E,MAAM,gBAAgB,GAAG,QAAQ,CAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAC3D,CAAC;IACF,OAAO;QACL,OAAO;QACP,MAAM;QACN,YAAY,EAAE,EAAC,OAAO,EAAE,gBAAgB,EAAC;QACzC,IAAI,EAAE,MAAM,CACV,OAAO,EAAE,gBAAgB,EAAE,OAAO,CAAC,IAAI,EACvC,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,CACnC;QACD,MAAM,EAAE,CAAC,CAAC,UAAU;QACpB,WAAW,EAAE,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC;KACxC,CAAC;AACJ,CAAC;AAED;;yDAEyD;AACzD,SAAS,YAAY,CACnB,CAAQ,EAAE,MAAqB,EAAE,OAA0B,EAC3D,KAAc;IAEd,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,CAAC;IACxB,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IAClC,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,EAAE,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5E,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9C,8DAA8D;IAC9D,SAAS,CAAC,MAAM,KAAK,IAAI,EAAE,2CAA2C,CAAC,CAAC;IACxE,OAAO;QACL,WAAW;QACX,WAAW,CAAC,CAAC,EAAE;YACb,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC;SAC1D,EAAE,KAAK,CAAC,CAAC,KAAK;KAChB,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,SAAS,gBAAgB,CACvB,MAAc,EAAE,MAAe,EAAE,MAA4B;IAE7D,8DAA8D;IAC9D,iDAAiD;IACjD,IAAI,MAAM,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI;WAClC,iBAAiB,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;cAC1C,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,kBAAkB,CAC1B,YAAY,CAAC,uBAAuB,EACpC,4DAA4D;cACxD,6CAA6C,CAClD,CAAC;IACJ,CAAC;IACD,gEAAgE;IAChE,iDAAiD;IACjD,IAAI,MAAM,CAAC,GAAG,CAAC,QAAQ,KAAK,IAAI,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,IAAI,kBAAkB,CAC1B,YAAY,CAAC,cAAc,EAC3B,gEAAgE;cAC5D,uDAAuD,CAC5D,CAAC;IACJ,CAAC;AACH,CAAC;AAED,wEAAwE;AACxE,SAAS,QAAQ,CAAC,OAAwB;IACxC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,OAAO;QACL,OAAO;QACP,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,EAAE,QAAQ,IAAI,IAAI;QAC1D,UAAU,EAAE,KAAK,CAAC,UAAU;KAC7B,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,SAAS,OAAO,CAAC,CAAQ,EAAE,OAA0B;IACnD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAI,OAAO,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,IAAI,UAAU,CAAC,GAAG,KAAK,wBAAwB,CAAC,CAAC;IACzD,CAAC;IACD,0BAA0B,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9C,sBAAsB,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7D,qEAAqE;IACrE,+DAA+D;IAC/D,MAAM,EAAC,OAAO,EAAE,UAAU,EAAC,GAAG,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACtE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,UAAU,CAClB,GAAG,KAAK,2CAA2C,UAAU,EAAE,CAChE,CAAC;IACJ,CAAC;IACD,OAAO,EAAC,OAAO,EAAE,OAAO,EAAC,CAAC;AAC5B,CAAC"}
|
package/dist/member/index.d.ts
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
*/
|
|
6
6
|
export { memberBenefits } from './benefits.js';
|
|
7
7
|
export { ACCRUALS, PAST_YEARS, PERIOD_KINDS, REMEDY_BASES, SECTIONS, } from './types.js';
|
|
8
|
-
export type { Assumptions, Award, DeclaredPeriod, Holdings, LegacyRules, LegacySectionId, Member, MemberBenefits, PastYears, Position, RemedyBasis, RemedyElection, RetirementChoices, SectionId, ServicePeriod, } from './types.js';
|
|
8
|
+
export type { Assumptions, Award, DeclaredPeriod, Holdings, LegacyRules, LegacySectionId, Member, MemberBenefits, PastYears, Position, RemedyBasis, RemedyElection, RetirementChoices, RulerLedgers, Section2015Walk, SectionId, ServicePeriod, StatementBalance, } from './types.js';
|
|
9
9
|
export { REMEDY, SECTION_OPENED } from './service.js';
|
|
@@ -11,10 +11,10 @@ import type { Built } from './valuation.js';
|
|
|
11
11
|
* first period from its start to the next 5 April
|
|
12
12
|
* (https://www.legislation.gov.uk/ukpga/2004/12/section/238ZB). It holds
|
|
13
13
|
* nothing at its start, so it reads as its tax year opening at nil, which
|
|
14
|
-
* `potAt` gives where the walk starts on the day the member joined.
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* (docs/how-it-works.md#
|
|
14
|
+
* `potAt` gives where the walk starts on the day the member joined. A
|
|
15
|
+
* member's statement is as at 31 March, and a year opening before it, or a
|
|
16
|
+
* leaving before it, throws `BeforeStatement`: the statement gives no
|
|
17
|
+
* balance there (docs/how-it-works.md#where-the-2015-sections-ledger-starts).
|
|
18
18
|
*
|
|
19
19
|
* - **An arrangement per section paid from:** the legacy section, with its
|
|
20
20
|
* remedy window on either basis, since both are paid from it; and the
|
|
@@ -10,13 +10,12 @@ import { refuseBeforePensionInputPeriods, taxYearEndDate, taxYearEndFor, taxYear
|
|
|
10
10
|
import { dayBefore } from '../dates.js';
|
|
11
11
|
import { invariant } from '../errors.js';
|
|
12
12
|
import { isoToDate } from '../iso-date.js';
|
|
13
|
-
import {
|
|
13
|
+
import { pointsToDecimal } from '../pension/prices.js';
|
|
14
|
+
import { schemeYearClosedBy, schemeYearEndFor } from '../pension/scheme-year.js';
|
|
14
15
|
import { refuseElectionMismatch } from './service.js';
|
|
15
16
|
import { accruedLedger, finalSalaryHeldOn, finalSalaryValued, refuseLeavingAfterDeclared, seed2015, walkDates, walksWindow, windowSeed, } from './valuation.js';
|
|
16
17
|
/** The call a refusal names. */
|
|
17
18
|
const ASKED = 'pensionInputPeriod';
|
|
18
|
-
/** A `CpiEntry` is in percentage points; paye-calc's `cpi` a decimal. */
|
|
19
|
-
const POINTS_PER_UNIT = 100;
|
|
20
19
|
/**
|
|
21
20
|
* Each tax year's pension input period for the member leaving on the date
|
|
22
21
|
* asked, in the cash of the price series `seriesAt` gives for an assumed
|
|
@@ -27,10 +26,10 @@ const POINTS_PER_UNIT = 100;
|
|
|
27
26
|
* first period from its start to the next 5 April
|
|
28
27
|
* (https://www.legislation.gov.uk/ukpga/2004/12/section/238ZB). It holds
|
|
29
28
|
* nothing at its start, so it reads as its tax year opening at nil, which
|
|
30
|
-
* `potAt` gives where the walk starts on the day the member joined.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* (docs/how-it-works.md#
|
|
29
|
+
* `potAt` gives where the walk starts on the day the member joined. A
|
|
30
|
+
* member's statement is as at 31 March, and a year opening before it, or a
|
|
31
|
+
* leaving before it, throws `BeforeStatement`: the statement gives no
|
|
32
|
+
* balance there (docs/how-it-works.md#where-the-2015-sections-ledger-starts).
|
|
34
33
|
*
|
|
35
34
|
* - **An arrangement per section paid from:** the legacy section, with its
|
|
36
35
|
* remedy window on either basis, since both are paid from it; and the
|
|
@@ -71,6 +70,7 @@ export function inputPeriods(b, seriesAt) {
|
|
|
71
70
|
: walksTo(b, seriesAt(assumedCpi), leaving, closes);
|
|
72
71
|
kept.set(key, walks);
|
|
73
72
|
return periodRead(b, basis, {
|
|
73
|
+
taxYearEnd: end,
|
|
74
74
|
// The close of the day before the year opens, 5 April.
|
|
75
75
|
opens: dayBefore(taxYearStartDate(end)),
|
|
76
76
|
closes,
|
|
@@ -96,7 +96,7 @@ function walksTo(b, prices, leaving, closes) {
|
|
|
96
96
|
reaches,
|
|
97
97
|
own: {
|
|
98
98
|
ledger: accruedLedger(b, {
|
|
99
|
-
window: b.ordinary2015, seed: seed2015(b
|
|
99
|
+
window: b.ordinary2015, seed: seed2015(b), prices,
|
|
100
100
|
}, dates, through),
|
|
101
101
|
period: b.ordinary2015,
|
|
102
102
|
},
|
|
@@ -125,7 +125,9 @@ function periodRead(b, basis, r) {
|
|
|
125
125
|
// An Order is labelled by the scheme year that has just closed when it
|
|
126
126
|
// is applied, and its figure is the September CPI before the tax year.
|
|
127
127
|
const order = r.walks.prices.cpiFor(schemeYearClosedBy(r.opens));
|
|
128
|
-
return {
|
|
128
|
+
return {
|
|
129
|
+
taxYearEnd: r.taxYearEnd, arrangements, cpi: pointsToDecimal(order.cpi),
|
|
130
|
+
};
|
|
129
131
|
}
|
|
130
132
|
/** The legacy section: its final-salary service, and on the 2015 basis
|
|
131
133
|
* the remedy window's career average pot beside it. */
|