loanshub-shared 1.3.5 → 1.3.6

package/lib/app/documents.d.ts

@@ -0,0 +1,4 @@
+/** The file types that can be attached to an application or to a message (lower case, without the dot). One list for the web app and the backend. */
+export declare const DOCUMENT_ALLOWED_EXTENSIONS: readonly string[];
+/** The largest file that can be attached, in bytes. */
+export declare const DOCUMENT_MAX_BYTES: number;

package/lib/app/documents.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCUMENT_MAX_BYTES = exports.DOCUMENT_ALLOWED_EXTENSIONS = void 0;
+/** The file types that can be attached to an application or to a message (lower case, without the dot). One list for the web app and the backend. */
+exports.DOCUMENT_ALLOWED_EXTENSIONS = ["pdf", "doc", "docx", "rtf", "odt", "ppt", "pptx", "xls", "xlsx", "csv", "txt", "png", "jpg", "jpeg", "gif", "bmp"];
+/** The largest file that can be attached, in bytes. */
+exports.DOCUMENT_MAX_BYTES = 10 * 1024 * 1024;
+//# sourceMappingURL=documents.js.map

package/lib/app/documents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/app/documents.ts"],"names":[],"mappings":";;;AAAA,qJAAqJ;AACxI,QAAA,2BAA2B,GAAsB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAEnL,uDAAuD;AAC1C,QAAA,kBAAkB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC"}

package/lib/app/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./options";
 export * from "./stages";
+export * from "./rateCapture";
+export * from "./documents";
 export type SemanticColors = "red" | "orange" | "yellow" | "olive" | "green" | "teal" | "blue" | "violet" | "purple" | "pink" | "brown" | "grey" | "black";

package/lib/app/index.js

@@ -16,4 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./options"), exports);
 __exportStar(require("./stages"), exports);
+__exportStar(require("./rateCapture"), exports);
+__exportStar(require("./documents"), exports);
 //# sourceMappingURL=index.js.map

package/lib/app/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB;AACzB,gDAA8B;AAC9B,8CAA4B"}

package/lib/app/rateCapture.d.ts

@@ -0,0 +1,23 @@
+import { RateReviewLifecycleStatus as Status } from "../typings/loanshub/rateReview";
+/** The positions an application can be filtered by in the rate capture chain. Each is one or more stored lifecycle statuses. */
+export type RateCaptureStepId = "notInvited" | "inviteSent" | "formOpened" | "formSubmitted" | "reviewInvited" | "reviewSubmitted" | "ineligible" | "refinanceEligible" | "refinanceInvited" | "refinanceApplied" | "refinanced" | "stopped";
+export interface RateCaptureStep {
+    id: RateCaptureStepId;
+    text: string;
+    statuses: readonly Status[];
+}
+/** The steps in chain order. Every lifecycle status belongs to exactly one step. */
+export declare const RATE_CAPTURE_STEPS: readonly RateCaptureStep[];
+/** Whether a stored value is one of the lifecycle statuses. */
+export declare const isRateReviewStatus: (value: unknown) => value is Status;
+/** The step a lifecycle status belongs to. */
+export declare const rateCaptureStepOf: (status: Status) => RateCaptureStepId;
+/** The milestones the headline figures count: everyone who has reached the step, whether or not they are still on it. */
+export type RateCaptureMilestoneId = "sent" | "opened" | "submitted" | "refinanceEligible" | "refinanceApplied" | "refinanced";
+/** How far along the chain each milestone is. An application's progress is the furthest one it has evidence of. */
+export declare const RATE_CAPTURE_MILESTONE_PROGRESS: Readonly<Record<RateCaptureMilestoneId, number>>;
+/** The milestones in chain order. */
+export declare const RATE_CAPTURE_MILESTONES: readonly RateCaptureMilestoneId[];
+export declare const progressOfStatus: (status: Status) => number | undefined;
+/** The financial year ("FY25" is 1 July 2024 to 30 June 2025) a date falls in, by the date in Brisbane. */
+export declare function financialYearOf(date: Date): string;

package/lib/app/rateCapture.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.progressOfStatus = exports.RATE_CAPTURE_MILESTONES = exports.RATE_CAPTURE_MILESTONE_PROGRESS = exports.rateCaptureStepOf = exports.isRateReviewStatus = exports.RATE_CAPTURE_STEPS = void 0;
+exports.financialYearOf = financialYearOf;
+const rateReview_1 = require("../typings/loanshub/rateReview");
+/** The steps in chain order. Every lifecycle status belongs to exactly one step. */
+exports.RATE_CAPTURE_STEPS = [
+    { id: "notInvited", text: "Not invited", statuses: [rateReview_1.RateReviewLifecycleStatus.ReadyForRateCapture] },
+    { id: "inviteSent", text: "Invite sent", statuses: [rateReview_1.RateReviewLifecycleStatus.RateCaptureFormSent] },
+    { id: "formOpened", text: "Form opened", statuses: [rateReview_1.RateReviewLifecycleStatus.RateCaptureFormOpened] },
+    { id: "formSubmitted", text: "Form submitted", statuses: [rateReview_1.RateReviewLifecycleStatus.RateCaptureSubmitted, rateReview_1.RateReviewLifecycleStatus.WaitingForRateReview, rateReview_1.RateReviewLifecycleStatus.RateReviewDue] },
+    { id: "reviewInvited", text: "Rate review invited", statuses: [rateReview_1.RateReviewLifecycleStatus.RateReviewFormSent, rateReview_1.RateReviewLifecycleStatus.RateReviewFormOpened] },
+    { id: "reviewSubmitted", text: "Rate review submitted", statuses: [rateReview_1.RateReviewLifecycleStatus.RateReviewSubmitted, rateReview_1.RateReviewLifecycleStatus.PendingEligibilityCheck] },
+    { id: "ineligible", text: "Ineligible, closed", statuses: [rateReview_1.RateReviewLifecycleStatus.NotEligibleClosed] },
+    { id: "refinanceEligible", text: "Refinance eligible", statuses: [rateReview_1.RateReviewLifecycleStatus.RefinanceEligible] },
+    { id: "refinanceInvited", text: "Refinance invited", statuses: [rateReview_1.RateReviewLifecycleStatus.RefinanceInviteSent] },
+    { id: "refinanceApplied", text: "Refinance applied", statuses: [rateReview_1.RateReviewLifecycleStatus.RefinanceApplicationCreated, rateReview_1.RateReviewLifecycleStatus.RefinanceApplicationSubmitted] },
+    { id: "refinanced", text: "Refinanced", statuses: [rateReview_1.RateReviewLifecycleStatus.RefinanceSettled] },
+    {
+        id: "stopped",
+        text: "Stopped",
+        statuses: [rateReview_1.RateReviewLifecycleStatus.RateCaptureExpired, rateReview_1.RateReviewLifecycleStatus.RateReviewExpired, rateReview_1.RateReviewLifecycleStatus.EmailDeliveryFailed, rateReview_1.RateReviewLifecycleStatus.CustomerOptedOut, rateReview_1.RateReviewLifecycleStatus.LoanNoLongerActive, rateReview_1.RateReviewLifecycleStatus.FlowCancelled],
+    },
+];
+const stepByStatus = new Map(exports.RATE_CAPTURE_STEPS.flatMap((step) => step.statuses.map((status) => [status, step.id])));
+/** Whether a stored value is one of the lifecycle statuses. */
+const isRateReviewStatus = (value) => typeof value === "string" && stepByStatus.has(value);
+exports.isRateReviewStatus = isRateReviewStatus;
+/** The step a lifecycle status belongs to. */
+const rateCaptureStepOf = (status) => { var _a; return (_a = stepByStatus.get(status)) !== null && _a !== void 0 ? _a : "notInvited"; };
+exports.rateCaptureStepOf = rateCaptureStepOf;
+/** How far along the chain each milestone is. An application's progress is the furthest one it has evidence of. */
+exports.RATE_CAPTURE_MILESTONE_PROGRESS = {
+    sent: 1,
+    opened: 2,
+    submitted: 3,
+    refinanceEligible: 6,
+    refinanceApplied: 7,
+    refinanced: 8,
+};
+/** The milestones in chain order. */
+exports.RATE_CAPTURE_MILESTONES = ["sent", "opened", "submitted", "refinanceEligible", "refinanceApplied", "refinanced"];
+/** How far along the chain a status shows an application to be; 0 before any invite. `undefined` for a status that ends the chain early (it says nothing about how far it got). */
+const PROGRESS_BY_STATUS = {
+    [rateReview_1.RateReviewLifecycleStatus.ReadyForRateCapture]: 0,
+    [rateReview_1.RateReviewLifecycleStatus.RateCaptureFormSent]: 1,
+    [rateReview_1.RateReviewLifecycleStatus.RateCaptureFormOpened]: 2,
+    [rateReview_1.RateReviewLifecycleStatus.RateCaptureSubmitted]: 3,
+    [rateReview_1.RateReviewLifecycleStatus.WaitingForRateReview]: 3,
+    [rateReview_1.RateReviewLifecycleStatus.RateReviewDue]: 3,
+    [rateReview_1.RateReviewLifecycleStatus.RateReviewFormSent]: 4,
+    [rateReview_1.RateReviewLifecycleStatus.RateReviewFormOpened]: 4,
+    [rateReview_1.RateReviewLifecycleStatus.RateReviewSubmitted]: 5,
+    [rateReview_1.RateReviewLifecycleStatus.PendingEligibilityCheck]: 5,
+    [rateReview_1.RateReviewLifecycleStatus.NotEligibleClosed]: 5,
+    [rateReview_1.RateReviewLifecycleStatus.RefinanceEligible]: 6,
+    [rateReview_1.RateReviewLifecycleStatus.RefinanceInviteSent]: 6,
+    [rateReview_1.RateReviewLifecycleStatus.RefinanceApplicationCreated]: 7,
+    [rateReview_1.RateReviewLifecycleStatus.RefinanceApplicationSubmitted]: 7,
+    [rateReview_1.RateReviewLifecycleStatus.RefinanceSettled]: 8,
+};
+const progressOfStatus = (status) => PROGRESS_BY_STATUS[status];
+exports.progressOfStatus = progressOfStatus;
+/** The Brisbane business time zone has no daylight saving, so a fixed offset is exact. */
+const BRISBANE_OFFSET_MS = 10 * 60 * 60 * 1000;
+/** The financial year ("FY25" is 1 July 2024 to 30 June 2025) a date falls in, by the date in Brisbane. */
+function financialYearOf(date) {
+    const local = new Date(date.getTime() + BRISBANE_OFFSET_MS);
+    const endYear = local.getUTCMonth() >= 6 ? local.getUTCFullYear() + 1 : local.getUTCFullYear();
+    return `FY${String(endYear).slice(-2)}`;
+}
+//# sourceMappingURL=rateCapture.js.map

package/lib/app/rateCapture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateCapture.js","sourceRoot":"","sources":["../../src/app/rateCapture.ts"],"names":[],"mappings":";;;AA6FA,0CAIC;AAjGD,+DAAqF;AAuBrF,oFAAoF;AACvE,QAAA,kBAAkB,GAA+B;IAC5D,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,mBAAmB,CAAC,EAAE;IACjF,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,mBAAmB,CAAC,EAAE;IACjF,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,qBAAqB,CAAC,EAAE;IACnF,EAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,oBAAoB,EAAE,sCAAM,CAAC,oBAAoB,EAAE,sCAAM,CAAC,aAAa,CAAC,EAAE;IAC3I,EAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,kBAAkB,EAAE,sCAAM,CAAC,oBAAoB,CAAC,EAAE;IACxH,EAAE,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,uBAAuB,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,mBAAmB,EAAE,sCAAM,CAAC,uBAAuB,CAAC,EAAE;IAChI,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,iBAAiB,CAAC,EAAE;IACtF,EAAE,EAAE,EAAE,mBAAmB,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,iBAAiB,CAAC,EAAE;IAC7F,EAAE,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,mBAAmB,CAAC,EAAE;IAC7F,EAAE,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,2BAA2B,EAAE,sCAAM,CAAC,6BAA6B,CAAC,EAAE;IAC3I,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,sCAAM,CAAC,gBAAgB,CAAC,EAAE;IAC7E;QACE,EAAE,EAAE,SAAS;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,CAAC,sCAAM,CAAC,kBAAkB,EAAE,sCAAM,CAAC,iBAAiB,EAAE,sCAAM,CAAC,mBAAmB,EAAE,sCAAM,CAAC,gBAAgB,EAAE,sCAAM,CAAC,kBAAkB,EAAE,sCAAM,CAAC,aAAa,CAAC;KACtK;CACF,CAAC;AAEF,MAAM,YAAY,GAA2C,IAAI,GAAG,CAAC,0BAAkB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAA+B,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1L,+DAA+D;AACxD,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,YAAY,CAAC,GAAG,CAAC,KAAe,CAAC,CAAC;AAAzH,QAAA,kBAAkB,sBAAuG;AAEtI,8CAA8C;AACvC,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAqB,EAAE,WAAC,OAAA,MAAA,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,mCAAI,YAAY,CAAA,EAAA,CAAC;AAApG,QAAA,iBAAiB,qBAAmF;AAKjH,mHAAmH;AACtG,QAAA,+BAA+B,GAAqD;IAC/F,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,SAAS,EAAE,CAAC;IACZ,iBAAiB,EAAE,CAAC;IACpB,gBAAgB,EAAE,CAAC;IACnB,UAAU,EAAE,CAAC;CACd,CAAC;AAEF,qCAAqC;AACxB,QAAA,uBAAuB,GAAsC,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC;AAEjK,mLAAmL;AACnL,MAAM,kBAAkB,GAA8C;IACpE,CAAC,sCAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAC/B,CAAC,sCAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAC/B,CAAC,sCAAM,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACjC,CAAC,sCAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC;IAChC,CAAC,sCAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC;IAChC,CAAC,sCAAM,CAAC,aAAa,CAAC,EAAE,CAAC;IACzB,CAAC,sCAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAC9B,CAAC,sCAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC;IAChC,CAAC,sCAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAC/B,CAAC,sCAAM,CAAC,uBAAuB,CAAC,EAAE,CAAC;IACnC,CAAC,sCAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;IAC7B,CAAC,sCAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;IAC7B,CAAC,sCAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAC/B,CAAC,sCAAM,CAAC,2BAA2B,CAAC,EAAE,CAAC;IACvC,CAAC,sCAAM,CAAC,6BAA6B,CAAC,EAAE,CAAC;IACzC,CAAC,sCAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;CAC7B,CAAC;AAEK,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAsB,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;AAAtF,QAAA,gBAAgB,oBAAsE;AAEnG,0FAA0F;AAC1F,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE/C,2GAA2G;AAC3G,SAAgB,eAAe,CAAC,IAAU;IACxC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,kBAAkB,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;IAC/F,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1C,CAAC"}

package/lib/app/rateCapture.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/app/rateCapture.test.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rateReview_1 = require("../typings/loanshub/rateReview");
+const rateCapture_1 = require("./rateCapture");
+describe("rate capture steps", () => {
+    test("every lifecycle status is in exactly one step", () => {
+        const listed = rateCapture_1.RATE_CAPTURE_STEPS.flatMap((step) => step.statuses);
+        const all = Object.values(rateReview_1.RateReviewLifecycleStatus);
+        expect([...listed].sort()).toEqual([...all].sort());
+    });
+    test("a status finds its step", () => {
+        expect((0, rateCapture_1.rateCaptureStepOf)(rateReview_1.RateReviewLifecycleStatus.RateReviewDue)).toBe("formSubmitted");
+        expect((0, rateCapture_1.rateCaptureStepOf)(rateReview_1.RateReviewLifecycleStatus.RefinanceSettled)).toBe("refinanced");
+        expect((0, rateCapture_1.rateCaptureStepOf)(rateReview_1.RateReviewLifecycleStatus.CustomerOptedOut)).toBe("stopped");
+    });
+    test("progress follows the chain and is unknown for an early end", () => {
+        expect((0, rateCapture_1.progressOfStatus)(rateReview_1.RateReviewLifecycleStatus.RateCaptureFormOpened)).toBe(rateCapture_1.RATE_CAPTURE_MILESTONE_PROGRESS.opened);
+        expect((0, rateCapture_1.progressOfStatus)(rateReview_1.RateReviewLifecycleStatus.RefinanceSettled)).toBe(rateCapture_1.RATE_CAPTURE_MILESTONE_PROGRESS.refinanced);
+        expect((0, rateCapture_1.progressOfStatus)(rateReview_1.RateReviewLifecycleStatus.RateCaptureExpired)).toBeUndefined();
+    });
+});
+describe("financialYearOf", () => {
+    test("July in Brisbane starts the next financial year", () => {
+        expect((0, rateCapture_1.financialYearOf)(new Date("2024-06-30T13:59:59Z"))).toBe("FY24");
+        expect((0, rateCapture_1.financialYearOf)(new Date("2024-06-30T14:00:00Z"))).toBe("FY25");
+        expect((0, rateCapture_1.financialYearOf)(new Date("2025-01-15T00:00:00Z"))).toBe("FY25");
+    });
+});
+//# sourceMappingURL=rateCapture.test.js.map

package/lib/app/rateCapture.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateCapture.test.js","sourceRoot":"","sources":["../../src/app/rateCapture.test.ts"],"names":[],"mappings":";;AAAA,+DAA2E;AAC3E,+CAA0I;AAE1I,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACzD,MAAM,MAAM,GAAG,gCAAkB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnE,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,sCAAyB,CAAC,CAAC;QACrD,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACnC,MAAM,CAAC,IAAA,+BAAiB,EAAC,sCAAyB,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACzF,MAAM,CAAC,IAAA,+BAAiB,EAAC,sCAAyB,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzF,MAAM,CAAC,IAAA,+BAAiB,EAAC,sCAAyB,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,IAAA,8BAAgB,EAAC,sCAAyB,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,6CAA+B,CAAC,MAAM,CAAC,CAAC;QACvH,MAAM,CAAC,IAAA,8BAAgB,EAAC,sCAAyB,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,6CAA+B,CAAC,UAAU,CAAC,CAAC;QACtH,MAAM,CAAC,IAAA,8BAAgB,EAAC,sCAAyB,CAAC,kBAAkB,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACzF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;QAC3D,MAAM,CAAC,IAAA,6BAAe,EAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvE,MAAM,CAAC,IAAA,6BAAe,EAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvE,MAAM,CAAC,IAAA,6BAAe,EAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/app/stages.d.ts

@@ -13,3 +13,25 @@ export interface IPortalStageOptions extends OptionItem<PortalStages> {
     color: SemanticColors;
 }
 export declare const PortalStageOptions: IPortalStageOptions[];
+/** The stages an admin can list applications by (`Submitted` is only a moment while an application is sent to Salestrekker). */
+export type ListedStage = PortalStages.Draft | PortalStages.InProgress | PortalStages.Settled | PortalStages.Lost;
+/** The stage order everywhere: tabs, filters, and which stage wins if rules ever overlap. */
+export declare const LISTED_STAGES: readonly ListedStage[];
+/** The date an application is listed and ordered by within a stage. An application without it is not in the stage. */
+export type StageDateField = "created" | "submitted" | "settlementDate";
+export interface StageRule {
+    /** Stored flags that must all equal these values. */
+    where: Readonly<Record<string, boolean>>;
+    /** The date field the stage is ordered by, newest first. A stored application must have it to be in the stage. */
+    orderBy: StageDateField;
+}
+/**
+ * The one definition of each stage, as stored flags. Firestore queries use it as `where` clauses and an `orderBy`
+ * (an ordered field must exist, so it also confirms the date); `isInStage` applies the same rule in memory.
+ * The stages exclude each other.
+ */
+export declare const PORTAL_STAGE_RULES: Readonly<Record<ListedStage, StageRule>>;
+/** Whether a stored application is in the stage: every flag matches and the ordering date is there. */
+export declare const isInStage: (application: Readonly<Record<string, unknown>>, stage: ListedStage) => boolean;
+/** The stage a stored application is in, or `undefined` when its flags or dates fit none. */
+export declare const stageOf: (application: Readonly<Record<string, unknown>>) => ListedStage | undefined;

package/lib/app/stages.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalStageOptions = exports.PortalStages = void 0;
+exports.stageOf = exports.isInStage = exports.PORTAL_STAGE_RULES = exports.LISTED_STAGES = exports.PortalStageOptions = exports.PortalStages = void 0;
 var PortalStages;
 (function (PortalStages) {
     PortalStages["Draft"] = "Draft";
@@ -33,4 +33,26 @@ exports.PortalStageOptions = [
         text: "Lost",
     },
 ];
+/** The stage order everywhere: tabs, filters, and which stage wins if rules ever overlap. */
+exports.LISTED_STAGES = [PortalStages.InProgress, PortalStages.Settled, PortalStages.Lost, PortalStages.Draft];
+/**
+ * The one definition of each stage, as stored flags. Firestore queries use it as `where` clauses and an `orderBy`
+ * (an ordered field must exist, so it also confirms the date); `isInStage` applies the same rule in memory.
+ * The stages exclude each other.
+ */
+exports.PORTAL_STAGE_RULES = {
+    [PortalStages.InProgress]: { where: { isSubmitted: true, isLost: false, isSettled: false }, orderBy: "submitted" },
+    [PortalStages.Settled]: { where: { isSettled: true, isLost: false }, orderBy: "settlementDate" },
+    [PortalStages.Lost]: { where: { isLost: true, isSettled: false }, orderBy: "submitted" },
+    [PortalStages.Draft]: { where: { isSubmitted: false, isLost: false, isSettled: false }, orderBy: "created" },
+};
+/** Whether a stored application is in the stage: every flag matches and the ordering date is there. */
+const isInStage = (application, stage) => {
+    const rule = exports.PORTAL_STAGE_RULES[stage];
+    return Object.keys(rule.where).every((field) => application[field] === rule.where[field]) && application[rule.orderBy] != null;
+};
+exports.isInStage = isInStage;
+/** The stage a stored application is in, or `undefined` when its flags or dates fit none. */
+const stageOf = (application) => exports.LISTED_STAGES.find((stage) => (0, exports.isInStage)(application, stage));
+exports.stageOf = stageOf;
 //# sourceMappingURL=stages.js.map

package/lib/app/stages.js.map

@@ -1 +1 @@
-{"version":3,"file":"stages.js","sourceRoot":"","sources":["../../src/app/stages.ts"],"names":[],"mappings":";;;AAGA,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,+BAAe,CAAA;IACf,wDAAwD;IACxD,uCAAuB,CAAA;IACvB,gCAAgC;IAChC,yCAAyB,CAAA;IACzB,mCAAmB,CAAA;IACnB,6BAAa,CAAA;AACf,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB;AAMY,QAAA,kBAAkB,GAA0B;IACvD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,YAAY,CAAC,KAAK;QACzB,KAAK,EAAE,MAAM;KACd;IACD;QACE,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,YAAY,CAAC,UAAU;QAC9B,KAAK,EAAE,OAAO;KACf;IACD;QACE,KAAK,EAAE,YAAY,CAAC,OAAO;QAC3B,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,SAAS;KAChB;IACD;QACE,KAAK,EAAE,YAAY,CAAC,IAAI;QACxB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,MAAM;KACb;CACF,CAAC"}
+{"version":3,"file":"stages.js","sourceRoot":"","sources":["../../src/app/stages.ts"],"names":[],"mappings":";;;AAGA,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,+BAAe,CAAA;IACf,wDAAwD;IACxD,uCAAuB,CAAA;IACvB,gCAAgC;IAChC,yCAAyB,CAAA;IACzB,mCAAmB,CAAA;IACnB,6BAAa,CAAA;AACf,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB;AAMY,QAAA,kBAAkB,GAA0B;IACvD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,YAAY,CAAC,KAAK;QACzB,KAAK,EAAE,MAAM;KACd;IACD;QACE,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,YAAY,CAAC,UAAU;QAC9B,KAAK,EAAE,OAAO;KACf;IACD;QACE,KAAK,EAAE,YAAY,CAAC,OAAO;QAC3B,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,SAAS;KAChB;IACD;QACE,KAAK,EAAE,YAAY,CAAC,IAAI;QACxB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,MAAM;KACb;CACF,CAAC;AAKF,6FAA6F;AAChF,QAAA,aAAa,GAA2B,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;AAY5I;;;;GAIG;AACU,QAAA,kBAAkB,GAA6C;IAC1E,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE;IAClH,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;IAChG,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE;IACxF,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;CAC7G,CAAC;AAEF,uGAAuG;AAChG,MAAM,SAAS,GAAG,CAAC,WAA8C,EAAE,KAAkB,EAAW,EAAE;IACvG,MAAM,IAAI,GAAG,0BAAkB,CAAC,KAAK,CAAC,CAAC;IACvC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC;AACjI,CAAC,CAAC;AAHW,QAAA,SAAS,aAGpB;AAEF,6FAA6F;AACtF,MAAM,OAAO,GAAG,CAAC,WAA8C,EAA2B,EAAE,CACjG,qBAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,iBAAS,EAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;AADlD,QAAA,OAAO,WAC2C"}

package/lib/app/stages.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/app/stages.test.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const stages_1 = require("./stages");
+const date = { seconds: 1 };
+describe("stages", () => {
+    test("a submitted, open application is in progress", () => {
+        const app = { isSubmitted: true, isLost: false, isSettled: false, submitted: date };
+        expect((0, stages_1.stageOf)(app)).toBe(stages_1.PortalStages.InProgress);
+    });
+    test("settled needs the flag and a settlement date", () => {
+        expect((0, stages_1.stageOf)({ isSubmitted: true, isLost: false, isSettled: true, submitted: date, settlementDate: date })).toBe(stages_1.PortalStages.Settled);
+        expect((0, stages_1.stageOf)({ isSubmitted: true, isLost: false, isSettled: true, submitted: date })).toBeUndefined();
+    });
+    test("lost and draft", () => {
+        expect((0, stages_1.stageOf)({ isSubmitted: true, isLost: true, isSettled: false, submitted: date })).toBe(stages_1.PortalStages.Lost);
+        expect((0, stages_1.stageOf)({ isSubmitted: false, isLost: false, isSettled: false, created: date })).toBe(stages_1.PortalStages.Draft);
+    });
+    test("an application is in at most one stage", () => {
+        const apps = [
+            { isSubmitted: true, isLost: true, isSettled: true, submitted: date, settlementDate: date },
+            { isSubmitted: true, isLost: false, isSettled: true, submitted: date, settlementDate: date },
+            { isSubmitted: false, isLost: false, isSettled: false, created: date, submitted: date },
+        ];
+        apps.forEach((app) => expect(stages_1.LISTED_STAGES.filter((stage) => (0, stages_1.isInStage)(app, stage)).length).toBeLessThanOrEqual(1));
+    });
+});
+//# sourceMappingURL=stages.test.js.map

package/lib/app/stages.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stages.test.js","sourceRoot":"","sources":["../../src/app/stages.test.ts"],"names":[],"mappings":";;AAAA,qCAA2E;AAE3E,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;AAE5B,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,IAAI,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACxD,MAAM,GAAG,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QACpF,MAAM,CAAC,IAAA,gBAAO,EAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAY,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,IAAA,gBAAO,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAY,CAAC,OAAO,CAAC,CAAC;QACzI,MAAM,CAAC,IAAA,gBAAO,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC1G,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC1B,MAAM,CAAC,IAAA,gBAAO,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAY,CAAC,IAAI,CAAC,CAAC;QAChH,MAAM,CAAC,IAAA,gBAAO,EAAC,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAY,CAAC,KAAK,CAAC,CAAC;IACnH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,MAAM,IAAI,GAAG;YACX,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE;YAC3F,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE;YAC5F,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;SACxF,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,sBAAa,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,kBAAS,EAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IACtH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/typings/loanshub/application.d.ts

@@ -1,7 +1,7 @@
 import { LoanTypes, AppApplicant, AppAsset, AppLiability, AppAddress, YesNoValues } from ".";
 import { ContactNextOfKinRelationshipEnumerator, PaymentFrequencyEnumerator } from "../salestrekker";
 import { AppAttachment } from "./attachment";
-import { RateReviewFlowType, RateReviewLifecycleStatus } from "./rateReview";
+import { RateReviewFlowType, RateReviewLifecycleStatus, RefinanceEligibility } from "./rateReview";
 export interface AppApplication<Timestamp> {
     title?: string;
     loanType: LoanTypes;
@@ -72,10 +72,11 @@ export interface AppApplication<Timestamp> {
     rateReviewFlowType?: RateReviewFlowType;
     /** Refinance application created from this rate-review flow. */
     rateReviewRefinanceApplicationId?: string;
-    /** Original settled application whose rate-review invite created this refinance application. */
-    rateReviewSourceApplicationId?: string;
-    /** Identifies a copied application as part of the rate-review refinance journey. */
-    isRateReviewRefinance?: boolean;
+    /** The application has previously been copied. */
+    isDuplicated?: boolean;
+    /** A rate-review refinance invitation has been sent for this application. */
+    hasRateReviewRefinanceInvite?: boolean;
+    refinanceEligibility?: RefinanceEligibility<Timestamp>;
     /** When the application was created in Firebase */
     created: Timestamp;
     /** when the application was submitted to Firebase, (and it left `Draft` status and was sent to Salestrekker) */

package/lib/typings/loanshub/application.js.map

@@ -1 +1 @@
-{"version":3,"file":"application.js","sourceRoot":"","sources":["../../../src/typings/loanshub/application.ts"],"names":[],"mappings":";;;AA8HA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,iDAAgC,CAAA;IAChC,0CAAyB,CAAA;AAC3B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../../../src/typings/loanshub/application.ts"],"names":[],"mappings":";;;AA+HA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,iDAAgC,CAAA;IAChC,0CAAyB,CAAA;AAC3B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}

package/lib/typings/loanshub/rateReview.d.ts

@@ -2,6 +2,24 @@ export interface RateReviewRecord<T> {
     sentDate: T;
     body: string;
 }
+export interface RbaCashRate<Timestamp = unknown> {
+    effectiveDate: Timestamp;
+    rate: number;
+    source: string;
+}
+export interface RefinanceEligibility<Timestamp = unknown> {
+    approvalRate: number;
+    approvalRbaRate: number;
+    approvalDate: Timestamp | string;
+    currentRate: number;
+    currentRbaRate: number;
+    submittedAt: Timestamp | string;
+    marginBefore: number;
+    marginNow: number;
+    difference: number;
+    eligible: boolean;
+    decidedAt: Timestamp;
+}
 export declare enum RateReviewFlowType {
     Regular = "REGULAR",
     Legacy = "LEGACY"

package/lib/typings/loanshub/rateReview.js.map

@@ -1 +1 @@
-{"version":3,"file":"rateReview.js","sourceRoot":"","sources":["../../../src/typings/loanshub/rateReview.ts"],"names":[],"mappings":";;;AAKA,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;AACnB,CAAC,EAHW,kBAAkB,kCAAlB,kBAAkB,QAG7B;AAED,8EAA8E;AAC9E,IAAY,yBAuBX;AAvBD,WAAY,yBAAyB;IACnC,2EAA8C,CAAA;IAC9C,2EAA8C,CAAA;IAC9C,+EAAkD,CAAA;IAClD,4EAA+C,CAAA;IAC/C,6EAAgD,CAAA;IAChD,8DAAiC,CAAA;IACjC,yEAA4C,CAAA;IAC5C,6EAAgD,CAAA;IAChD,0EAA6C,CAAA;IAC7C,kFAAqD,CAAA;IACrD,sEAAyC,CAAA;IACzC,qEAAwC,CAAA;IACxC,0EAA6C,CAAA;IAC7C,0FAA6D,CAAA;IAC7D,8FAAiE,CAAA;IACjE,mEAAsC,CAAA;IACtC,wEAA2C,CAAA;IAC3C,sEAAyC,CAAA;IACzC,0EAA6C,CAAA;IAC7C,oEAAuC,CAAA;IACvC,yEAA4C,CAAA;IAC5C,6DAAgC,CAAA;AAClC,CAAC,EAvBW,yBAAyB,yCAAzB,yBAAyB,QAuBpC;AAEY,QAAA,+BAA+B,GAA8C;IACxF,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,wBAAwB;IACzE,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,wBAAwB;IACzE,CAAC,yBAAyB,CAAC,qBAAqB,CAAC,EAAE,0BAA0B;IAC7E,CAAC,yBAAyB,CAAC,oBAAoB,CAAC,EAAE,wBAAwB;IAC1E,CAAC,yBAAyB,CAAC,oBAAoB,CAAC,EAAE,yBAAyB;IAC3E,CAAC,yBAAyB,CAAC,aAAa,CAAC,EAAE,iBAAiB;IAC5D,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,EAAE,uBAAuB;IACvE,CAAC,yBAAyB,CAAC,oBAAoB,CAAC,EAAE,yBAAyB;IAC3E,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,uBAAuB;IACxE,CAAC,yBAAyB,CAAC,uBAAuB,CAAC,EAAE,sBAAsB;IAC3E,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,EAAE,uBAAuB;IACtE,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,EAAE,oBAAoB;IACnE,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,uBAAuB;IACxE,CAAC,yBAAyB,CAAC,2BAA2B,CAAC,EAAE,+BAA+B;IACxF,CAAC,yBAAyB,CAAC,6BAA6B,CAAC,EAAE,iCAAiC;IAC5F,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,mBAAmB;IACjE,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,EAAE,sBAAsB;IACtE,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,EAAE,qBAAqB;IACpE,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,uBAAuB;IACxE,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,oBAAoB;IAClE,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,EAAE,uBAAuB;IACvE,CAAC,yBAAyB,CAAC,aAAa,CAAC,EAAE,gBAAgB;CAC5D,CAAC"}
+{"version":3,"file":"rateReview.js","sourceRoot":"","sources":["../../../src/typings/loanshub/rateReview.ts"],"names":[],"mappings":";;;AAyBA,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;AACnB,CAAC,EAHW,kBAAkB,kCAAlB,kBAAkB,QAG7B;AAED,8EAA8E;AAC9E,IAAY,yBAuBX;AAvBD,WAAY,yBAAyB;IACnC,2EAA8C,CAAA;IAC9C,2EAA8C,CAAA;IAC9C,+EAAkD,CAAA;IAClD,4EAA+C,CAAA;IAC/C,6EAAgD,CAAA;IAChD,8DAAiC,CAAA;IACjC,yEAA4C,CAAA;IAC5C,6EAAgD,CAAA;IAChD,0EAA6C,CAAA;IAC7C,kFAAqD,CAAA;IACrD,sEAAyC,CAAA;IACzC,qEAAwC,CAAA;IACxC,0EAA6C,CAAA;IAC7C,0FAA6D,CAAA;IAC7D,8FAAiE,CAAA;IACjE,mEAAsC,CAAA;IACtC,wEAA2C,CAAA;IAC3C,sEAAyC,CAAA;IACzC,0EAA6C,CAAA;IAC7C,oEAAuC,CAAA;IACvC,yEAA4C,CAAA;IAC5C,6DAAgC,CAAA;AAClC,CAAC,EAvBW,yBAAyB,yCAAzB,yBAAyB,QAuBpC;AAEY,QAAA,+BAA+B,GAA8C;IACxF,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,wBAAwB;IACzE,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,wBAAwB;IACzE,CAAC,yBAAyB,CAAC,qBAAqB,CAAC,EAAE,0BAA0B;IAC7E,CAAC,yBAAyB,CAAC,oBAAoB,CAAC,EAAE,wBAAwB;IAC1E,CAAC,yBAAyB,CAAC,oBAAoB,CAAC,EAAE,yBAAyB;IAC3E,CAAC,yBAAyB,CAAC,aAAa,CAAC,EAAE,iBAAiB;IAC5D,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,EAAE,uBAAuB;IACvE,CAAC,yBAAyB,CAAC,oBAAoB,CAAC,EAAE,yBAAyB;IAC3E,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,uBAAuB;IACxE,CAAC,yBAAyB,CAAC,uBAAuB,CAAC,EAAE,sBAAsB;IAC3E,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,EAAE,uBAAuB;IACtE,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,EAAE,oBAAoB;IACnE,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,uBAAuB;IACxE,CAAC,yBAAyB,CAAC,2BAA2B,CAAC,EAAE,+BAA+B;IACxF,CAAC,yBAAyB,CAAC,6BAA6B,CAAC,EAAE,iCAAiC;IAC5F,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,mBAAmB;IACjE,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,EAAE,sBAAsB;IACtE,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,EAAE,qBAAqB;IACpE,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,EAAE,uBAAuB;IACxE,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,oBAAoB;IAClE,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,EAAE,uBAAuB;IACvE,CAAC,yBAAyB,CAAC,aAAa,CAAC,EAAE,gBAAgB;CAC5D,CAAC"}

package/lib/typings/salestrekker/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./generated";
+export * from "./v2";
 export declare enum salestrekkerWebHooks {
     dealCreated = "dealCreated",
     dealChangesStage = "dealChangesStage",

package/lib/typings/salestrekker/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.salestrekkerWebHooks = void 0;
 __exportStar(require("./generated"), exports);
+__exportStar(require("./v2"), exports);
 var salestrekkerWebHooks;
 (function (salestrekkerWebHooks) {
     salestrekkerWebHooks["dealCreated"] = "dealCreated";

package/lib/typings/salestrekker/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/typings/salestrekker/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA4B;AAE5B,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,mDAA2B,CAAA;IAC3B,6DAAqC,CAAA;IACrC,+DAAuC,CAAA;AACzC,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/typings/salestrekker/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,uCAAqB;AAErB,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,mDAA2B,CAAA;IAC3B,6DAAqC,CAAA;IACrC,+DAAuC,CAAA;AACzC,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B"}

package/lib/typings/salestrekker/v2/address.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Salestrekker 2.0 address structure, as sent to and returned by the API.
+ * Sits inside a person's `address` list.
+ */
+/** Which of a person's addresses this is. */
+export type StAddressType = "current" | "mailing" | "post_settlement";
+export interface StAddress {
+    id: string;
+    /** "standard" for street addresses. */
+    addressType: string;
+    /** "AU"; empty for a blank address. */
+    countryCode: string;
+    country: string;
+    /** Lower case, e.g. "vic". */
+    state: string;
+    unitSuiteNumber: string;
+    streetNumber: string;
+    street: string;
+    streetType: string;
+    suburb: string;
+    city: string;
+    postCode: string;
+    formatted: string;
+    longitude: number;
+    latitude: number;
+    level: string;
+    buildingName: string;
+    addressLine1: string;
+    addressLine2: string;
+    poBoxType: string;
+    poBoxNumber: string;
+    exchange: string;
+    /** True when typed in rather than picked from an address search. */
+    isManual: boolean;
+    type: StAddressType;
+    addressFormat: string;
+}

package/lib/typings/salestrekker/v2/address.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 address structure, as sent to and returned by the API.
+ * Sits inside a person's `address` list.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=address.js.map

package/lib/typings/salestrekker/v2/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/address.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/asset.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Salestrekker 2.0 asset structure, as sent to and returned by the API.
+ * Sits inside a client profile's `asset` list.
+ */
+/** One person's share of an asset. */
+export interface StAssetOwnership {
+    idPerson: string;
+    percent: number;
+}
+/** Address of a property asset. */
+export interface StAssetAddress {
+    addressFormat: string;
+    country: string;
+    countryCode: string;
+    isManual: boolean;
+    formatted: string;
+    streetNumber: string;
+    street: string;
+    streetType: string;
+    suburb: string;
+    /** Lower case, e.g. "vic". */
+    state: string;
+    postCode: string;
+}
+export interface StAsset {
+    /**
+     * "vehicles_make_and_model", "bank_account", "superfund_institutions", "home_content",
+     * "owner_occupied_properties", "investment_property_address", "secondary_residence_properties" or "other".
+     */
+    type: string;
+    value: number;
+    /** Sort order within the client profile. */
+    weight: number;
+    ownership: StAssetOwnership[];
+    name: string;
+    vehicle?: string;
+    vehicleModel?: string;
+    bankName?: string;
+    bankAccountType?: string;
+    membershipNumber?: string;
+    address?: StAssetAddress;
+    zoning?: string;
+    property?: string;
+    valuation?: string;
+    postSettlementStatus?: string;
+    rentalIncome?: number;
+    rentalIncomeFrequency?: string;
+}

package/lib/typings/salestrekker/v2/asset.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 asset structure, as sent to and returned by the API.
+ * Sits inside a client profile's `asset` list.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=asset.js.map

package/lib/typings/salestrekker/v2/asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/asset.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/employment.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Salestrekker 2.0 employment structure, as sent to and returned by the API.
+ * Sits inside a person's `employment` list.
+ */
+/** Where the employer operates from. */
+export interface StEmploymentAddress {
+    addressFormat: string;
+    /** e.g. "principal_place_of_business". */
+    type: string;
+    countryCode: string;
+    country: string;
+    formatted: string;
+    isManual: boolean;
+}
+export interface StEmployment {
+    /** "current" for the job the applicant has now. */
+    status: string;
+    /** "salaried_employee" or "self_employed". */
+    type: string;
+    /** "primary" for the main job. */
+    priority: string;
+    /** Unix seconds. */
+    startDate: number;
+    /** e.g. "full_time", "sole_trader", "in_a_company". */
+    basis: string;
+    occupation: string;
+    isOnProbation: boolean;
+    /** Unix seconds; 0 when not on probation. */
+    probationExpiryDate: number;
+    /** Employer name. */
+    name: string;
+    employerType: string;
+    address: StEmploymentAddress;
+}

package/lib/typings/salestrekker/v2/employment.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 employment structure, as sent to and returned by the API.
+ * Sits inside a person's `employment` list.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=employment.js.map

package/lib/typings/salestrekker/v2/employment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"employment.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/employment.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/expense.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Salestrekker 2.0 expense structure, as sent to and returned by the API.
+ * Sits inside a client profile's `expense` list.
+ */
+/** One person's (or company's) share of an expense. */
+export interface StExpenseOwnership {
+    /** Set by Salestrekker on read; omitted when sending. */
+    id?: string;
+    idPerson: string;
+    idCompany: string;
+    percent: number;
+}
+/** A household expense line, e.g. groceries. */
+export interface StHouseholdExpense {
+    /** An `ExpenseOptions` value, e.g. "groceries". */
+    type: string;
+    /** A payment frequency, e.g. "monthly". */
+    frequency: string;
+    value: number;
+    comment: string;
+    ownership: StExpenseOwnership[];
+}
+/** An entry of a client profile's `expense` list. */
+export interface StExpenseGroup {
+    idPerson?: string[];
+    household?: StHouseholdExpense[];
+}

package/lib/typings/salestrekker/v2/expense.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 expense structure, as sent to and returned by the API.
+ * Sits inside a client profile's `expense` list.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=expense.js.map

package/lib/typings/salestrekker/v2/expense.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expense.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/expense.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/income.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Salestrekker 2.0 income structure, as sent to and returned by the API.
+ * Sits inside a client profile's `income` list.
+ */
+export type StIncomeType = "payg_income" | "business_income" | "other_taxable_income" | "non_taxable_income";
+/** Salary income from an employer. Every amount has its own frequency. */
+export interface StPaygIncome {
+    type: "payg_income";
+    grossSalary: number;
+    grossSalaryFrequency: string;
+    bonus: number;
+    bonusFrequency: string;
+    overtimeEssential: number;
+    overtimeEssentialFrequency: string;
+    overtimeNonEssential: number;
+    overtimeNonEssentialFrequency: string;
+    commission: number;
+    commissionFrequency: string;
+    allowance: number;
+    allowanceFrequency: string;
+    idPerson: string;
+    idEmployer: string | null;
+    /** Sort order within the client profile. */
+    weight: number;
+}
+export interface StBusinessTaxYear {
+    profitBeforeTax: number;
+    taxYear: number;
+}
+/** Income from a business the person owns. */
+export interface StBusinessIncome {
+    type: "business_income";
+    grossIncome: number;
+    grossIncomeFrequency: string;
+    lastTaxYear?: StBusinessTaxYear;
+    previousTaxYear?: StBusinessTaxYear;
+    idPerson: string;
+    idCompany: string | null;
+    weight: number;
+}
+/** Any other income with just an amount and a description. */
+export interface StOtherIncome {
+    type: "other_taxable_income" | "non_taxable_income";
+    grossIncome: number;
+    grossIncomeFrequency: string;
+    description?: string;
+    idPerson: string;
+    idCompany: string | null;
+    weight: number;
+}
+export type StIncome = StPaygIncome | StBusinessIncome | StOtherIncome;

package/lib/typings/salestrekker/v2/income.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 income structure, as sent to and returned by the API.
+ * Sits inside a client profile's `income` list.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=income.js.map

package/lib/typings/salestrekker/v2/income.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"income.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/income.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./address";
+export * from "./asset";
+export * from "./employment";
+export * from "./expense";
+export * from "./income";
+export * from "./liability";
+export * from "./needsAndObjectives";
+export * from "./nextOfKin";
+export * from "./person";
+export * from "./productRequirements";
+export * from "./ticket";

package/lib/typings/salestrekker/v2/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./address"), exports);
+__exportStar(require("./asset"), exports);
+__exportStar(require("./employment"), exports);
+__exportStar(require("./expense"), exports);
+__exportStar(require("./income"), exports);
+__exportStar(require("./liability"), exports);
+__exportStar(require("./needsAndObjectives"), exports);
+__exportStar(require("./nextOfKin"), exports);
+__exportStar(require("./person"), exports);
+__exportStar(require("./productRequirements"), exports);
+__exportStar(require("./ticket"), exports);
+//# sourceMappingURL=index.js.map

package/lib/typings/salestrekker/v2/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,+CAA6B;AAC7B,4CAA0B;AAC1B,2CAAyB;AACzB,8CAA4B;AAC5B,uDAAqC;AACrC,8CAA4B;AAC5B,2CAAyB;AACzB,wDAAsC;AACtC,2CAAyB"}

package/lib/typings/salestrekker/v2/liability.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Salestrekker 2.0 liability structure, as sent to and returned by the API.
+ * Sits inside a client profile's `liability` list.
+ */
+/** One person's share of a liability. */
+export interface StLiabilityOwnership {
+    idPerson: string;
+    percent: number;
+}
+export interface StLiability {
+    /** A liability type, e.g. "mortgage_loan", "credit_card", "buy_now_pay_later". */
+    type: string;
+    balance: number;
+    limit: number;
+    /** Lender name; "Lender" when none was captured. */
+    name: string;
+    lenderOtherName: string;
+    ownership: StLiabilityOwnership[];
+    postSettlementStatus: string;
+    repayment: number;
+    repaymentFrequency: string;
+    interestRate: number;
+    /** Sort order within the client profile. */
+    weight: number;
+    creditCardNumber?: string;
+    creditCardType?: string;
+    isReducedLimit?: boolean;
+    reducedLimit?: number;
+    accountNumber?: string;
+    bsb?: string;
+    /** Unix seconds; 0 when unset. */
+    endDate?: number;
+    idAsset?: string | null;
+    fixedExpiryDate?: number;
+    interestOnlyExpiryDate?: number;
+    mortgageType?: string;
+    rateType?: string;
+    repaymentType?: string;
+    asAtDate?: number;
+}

package/lib/typings/salestrekker/v2/liability.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 liability structure, as sent to and returned by the API.
+ * Sits inside a client profile's `liability` list.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=liability.js.map

package/lib/typings/salestrekker/v2/liability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liability.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/liability.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/needsAndObjectives.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Salestrekker 2.0 home loan "needs and objectives" structure, as sent to and returned by the API.
+ * Sits inside the ticket's home loan tool.
+ */
+export interface StCreditHistory {
+    applicantHadProblems: string;
+    applicantBeenOfficerOrShareholder: string;
+    applicantHaveUnsatisfiedJudgements: string;
+    applicantSubmittedApplicationToOtherCreditProviders: string;
+    bankruptcy: string;
+}
+export interface StExitStrategy {
+    planningToRetire: number;
+    /** Salestrekker repayment values, e.g. "savings". */
+    applicantProposeToRepayLoan: string[];
+}
+export interface StFinancialSecurity {
+    howImportantIsLoanFlexibilityToYou: string;
+    levelOfFinancialExperience: string;
+    concernedAboutMovementsInInterestRates: string;
+    concernedAboutYourCurrentJobSecurity: string;
+    concernedAboutYourCurrentJobSecurityComments: string;
+    concernedAboutNegativePropertyValue: string;
+    concernedAboutNegativePropertyValueComments: string;
+    haveAnEmergencyFund: string;
+    ableToMaintainYourCommitmentsAndLifestyle: string;
+    haveAdequateInsurance: string;
+    haveWill: string;
+    awareOfAnyCircumstances: string;
+}
+export interface StFinancialChanges {
+    planChangesToTheirFinancialCircumstances: string;
+}
+/** The answers of one applicant. */
+export interface StNeedsIndividual {
+    idPerson: string;
+    actingAsGuarantor: Record<string, never>;
+    creditHistory: StCreditHistory;
+    exitStrategy: StExitStrategy;
+    financialSecurity: StFinancialSecurity;
+    possibleAdverseChangesToFinancialSituation: StFinancialChanges;
+    possibleBeneficialChangesToFinancialSituation: StFinancialChanges;
+}
+export interface StNeedsNotes {
+    reasonForSeekingCredit: string;
+    immediateNeedsAndObjectives: string;
+    longerTerm: string;
+}
+/** What the loan is for: the property type and the loan purpose with its amount. */
+export interface StRequirementsAndObjectives {
+    /** "owner_occupied" and/or "investment". */
+    type: string[];
+    purposeDetails: Array<{
+        type: string;
+        amount: number;
+    }>;
+}
+export interface StNeedsAndObjectives {
+    individuals: StNeedsIndividual[];
+    notes: StNeedsNotes;
+    requirementsAndObjectives?: StRequirementsAndObjectives;
+}

package/lib/typings/salestrekker/v2/needsAndObjectives.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 home loan "needs and objectives" structure, as sent to and returned by the API.
+ * Sits inside the ticket's home loan tool.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=needsAndObjectives.js.map

package/lib/typings/salestrekker/v2/needsAndObjectives.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"needsAndObjectives.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/needsAndObjectives.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/nextOfKin.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Salestrekker 2.0 next of kin structure, as sent to and returned by the API.
+ * Sits inside a person's `nextOfKin` list.
+ */
+import { StAddress } from "./address";
+import { StContact } from "./person";
+export interface StNextOfKin {
+    /** Lower case, e.g. "mr". */
+    title: string;
+    firstName: string;
+    lastName: string;
+    /** The relationship, e.g. "mother"; "other" when unknown. */
+    type: string;
+    contact: StContact[];
+    address: StAddress[];
+}

package/lib/typings/salestrekker/v2/nextOfKin.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=nextOfKin.js.map

package/lib/typings/salestrekker/v2/nextOfKin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nextOfKin.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/nextOfKin.ts"],"names":[],"mappings":""}

package/lib/typings/salestrekker/v2/person.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Salestrekker 2.0 person structure (name, contact and personal details),
+ * as sent to and returned by the API.
+ * Addresses, employment and next of kin are separate sections.
+ */
+/** A contact method of a person, e.g. an email address or a mobile number. */
+export interface StContact {
+    /** "email_personal" or "phone_mobile". */
+    type: string;
+    value: string;
+    /** Country prefix for phone numbers, e.g. "61"; empty for email. */
+    prefix: string;
+}
+/** The personal details part of a person, as sent when creating a ticket. */
+export interface StPersonDetails {
+    name: string;
+    isActive: boolean;
+    contact: StContact[];
+    /** Lower case, e.g. "mr". */
+    title: string;
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    preferredName: string;
+    gender: string;
+    /** Unix seconds. */
+    dateOfBirth: number;
+    countryOfResidency: string;
+    countryOfTaxResidence: string;
+    citizenshipOf: string;
+    countryOfBirth: string;
+    numberOfDependents: number;
+    /** Lower case, e.g. "single". */
+    maritalStatus: string;
+    labelId: string;
+    weight: number;
+}
+/** A person as returned by Salestrekker: the details above, as far as we read them. */
+export interface StPerson extends Partial<Omit<StPersonDetails, "contact">> {
+    id?: string;
+    contact?: StContact[];
+    residencyStatus?: string;
+}

package/lib/typings/salestrekker/v2/person.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Salestrekker 2.0 person structure (name, contact and personal details),
+ * as sent to and returned by the API.
+ * Addresses, employment and next of kin are separate sections.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=person.js.map

package/lib/typings/salestrekker/v2/person.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"person.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/person.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/lib/typings/salestrekker/v2/productRequirements.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Salestrekker 2.0 home loan "product requirements" structure, as sent to and returned by the API.
+ * Sits inside the ticket's home loan tool.
+ */
+/** How important a product feature is to the applicant, with the reasons behind it. */
+export interface StProductChoice {
+    /** "important", "not_important", ... */
+    type: string;
+    preferredDuration?: string;
+    preferredRepaymentFrequency?: string;
+    /** Salestrekker reason values, e.g. "for_tax_purposes". */
+    reason?: string[];
+    otherReason?: string;
+    additionalReason?: string;
+    /** Line of credit only. */
+    planForPayingLineOfCredit?: string;
+}
+export interface StWhatIsImportant {
+    lowestOverallLoanCost?: string;
+    lowestOverallLoanCostComments?: string;
+    loanApprovedQuickly?: string;
+    loanApprovedQuicklyComments?: string;
+    specificLoanFeatures?: string;
+    lenderPolicy?: string;
+    goToBranch?: string;
+    useInternetBanking?: string;
+}
+export interface StTermOfCredit {
+    years?: number;
+    months?: number;
+    notLenders?: string;
+    preferredLenders?: string;
+}
+export interface StProductRequirements {
+    rateType: {
+        fixed: StProductChoice;
+        variable: StProductChoice;
+        fixedAndVariable: StProductChoice;
+    };
+    repaymentType: {
+        principalAndInterest: StProductChoice;
+        interestOnly: StProductChoice;
+        interestInAdvance: StProductChoice;
+        lineOfCredit: StProductChoice;
+    };
+    productType: {
+        offsetAccount: StProductChoice;
+        redraw: StProductChoice;
+    };
+    whatIsImportantForYou: StWhatIsImportant;
+    termOfCreditSought: StTermOfCredit;
+}

package/lib/typings/salestrekker/v2/productRequirements.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Salestrekker 2.0 home loan "product requirements" structure, as sent to and returned by the API.
+ * Sits inside the ticket's home loan tool.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=productRequirements.js.map

package/lib/typings/salestrekker/v2/productRequirements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"productRequirements.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/productRequirements.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/typings/salestrekker/v2/ticket.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Salestrekker 2.0 ticket (deal) structure, as sent to and returned by the API.
+ */
+/** The loan summary on the ticket itself: its value and the generated description. */
+export interface StTicketSummary {
+    value: {
+        total: number;
+    };
+    /** e.g. "Ann has applied for a Purchase loan of $500000 for a ownerOccupier property." */
+    description: string;
+}

package/lib/typings/salestrekker/v2/ticket.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Salestrekker 2.0 ticket (deal) structure, as sent to and returned by the API.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ticket.js.map

package/lib/typings/salestrekker/v2/ticket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ticket.js","sourceRoot":"","sources":["../../../../src/typings/salestrekker/v2/ticket.ts"],"names":[],"mappings":";AAAA;;GAEG"}

package/package.json

@@ -1,21 +1,21 @@
-{
-  "name": "loanshub-shared",
-  "version": "1.3.5",
-  "description": "shared package for loanshub",
-  "main": "lib/index.js",
-  "scripts": {
-    "build": "tsc --build",
-    "test": "npx jest"
-  },
-  "author": "Ricky Kenny",
-  "files": [
-    "lib/*"
-  ],
-  "devDependencies": {
-    "@types/jest": "^29.5.13",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.6.3",
-    "undici-types": "^8.10.0"
-  }
-}
+{
+  "name": "loanshub-shared",
+  "version": "1.3.6",
+  "description": "shared package for loanshub",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "tsc --build",
+    "test": "npx jest"
+  },
+  "author": "Ricky Kenny",
+  "files": [
+    "lib/*"
+  ],
+  "devDependencies": {
+    "@types/jest": "^29.5.13",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3",
+    "undici-types": "^8.10.0"
+  }
+}