loanshub-shared 1.3.2 → 1.3.4

package/lib/index.d.ts

@@ -4,3 +4,4 @@ export * from "./typings/salestrekker";
 export * from "./typings/firebase";
 export * from "./utils";
 export * from "./nominatimAddress";
+export * from "./assetPropertyAddress";

package/lib/index.js

@@ -20,4 +20,5 @@ __exportStar(require("./typings/salestrekker"), exports);
 __exportStar(require("./typings/firebase"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./nominatimAddress"), exports);
+__exportStar(require("./assetPropertyAddress"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,qDAAmC;AACnC,yDAAuC;AACvC,qDAAmC;AACnC,0CAAwB;AACxB,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,qDAAmC;AACnC,yDAAuC;AACvC,qDAAmC;AACnC,0CAAwB;AACxB,qDAAmC;AACnC,yDAAuC"}

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

@@ -1,6 +1,7 @@
 import { LoanTypes, AppApplicant, AppAsset, AppLiability, AppAddress, YesNoValues } from ".";
 import { ContactNextOfKinRelationshipEnumerator, PaymentFrequencyEnumerator } from "../salestrekker";
 import { AppAttachment } from "./attachment";
+import { RateReviewFlowType, RateReviewLifecycleStatus } from "./rateReview";
 export interface AppApplication<Timestamp> {
     title?: string;
     loanType: LoanTypes;
@@ -66,6 +67,11 @@ export interface AppApplication<Timestamp> {
     lenderAppId?: string;
     rateReviewEnabled?: boolean;
     nextRateReviewDate?: Timestamp;
+    /** Current step in the post-settlement rate capture and refinance flow. */
+    rateReviewStatus?: RateReviewLifecycleStatus;
+    rateReviewFlowType?: RateReviewFlowType;
+    /** Refinance application created from this rate-review flow. */
+    rateReviewRefinanceApplicationId?: string;
     /** 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":";;;AAoHA,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":";;;AA0HA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,iDAAgC,CAAA;IAChC,0CAAyB,CAAA;AAC3B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}

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

@@ -1,8 +1,10 @@
 import { AssetTypeEnumerator } from "../salestrekker";
+import type { AppAssetPropertyAddress } from "../../assetPropertyAddress";
 export interface AppAsset {
     type: AssetTypeEnumerator;
     value: number;
-    address: string;
+    /** Property assets: structured Australian address (legacy string is normalized on load). */
+    address?: AppAssetPropertyAddress | string;
     isSecurity: boolean;
     monthlyRentalIncome?: number;
     description: string;

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

@@ -2,3 +2,33 @@ export interface RateReviewRecord<T> {
     sentDate: T;
     body: string;
 }
+export declare enum RateReviewFlowType {
+    Regular = "REGULAR",
+    Legacy = "LEGACY"
+}
+/** The application's current position in the complete rate-review journey. */
+export declare enum RateReviewLifecycleStatus {
+    ReadyForRateCapture = "READY_FOR_RATE_CAPTURE",
+    RateCaptureFormSent = "RATE_CAPTURE_FORM_SENT",
+    RateCaptureFormOpened = "RATE_CAPTURE_FORM_OPENED",
+    RateCaptureSubmitted = "RATE_CAPTURE_SUBMITTED",
+    WaitingForRateReview = "WAITING_FOR_RATE_REVIEW",
+    RateReviewDue = "RATE_REVIEW_DUE",
+    RateReviewFormSent = "RATE_REVIEW_FORM_SENT",
+    RateReviewFormOpened = "RATE_REVIEW_FORM_OPENED",
+    RateReviewSubmitted = "RATE_REVIEW_SUBMITTED",
+    PendingEligibilityCheck = "PENDING_ELIGIBILITY_CHECK",
+    NotEligibleClosed = "NOT_ELIGIBLE_CLOSED",
+    RefinanceEligible = "REFINANCE_ELIGIBLE",
+    RefinanceInviteSent = "REFINANCE_INVITE_SENT",
+    RefinanceApplicationCreated = "REFINANCE_APPLICATION_CREATED",
+    RefinanceApplicationSubmitted = "REFINANCE_APPLICATION_SUBMITTED",
+    RefinanceSettled = "REFINANCE_SETTLED",
+    RateCaptureExpired = "RATE_CAPTURE_EXPIRED",
+    RateReviewExpired = "RATE_REVIEW_EXPIRED",
+    EmailDeliveryFailed = "EMAIL_DELIVERY_FAILED",
+    CustomerOptedOut = "CUSTOMER_OPTED_OUT",
+    LoanNoLongerActive = "LOAN_NO_LONGER_ACTIVE",
+    FlowCancelled = "FLOW_CANCELLED"
+}
+export declare const RateReviewLifecycleStatusLabels: Record<RateReviewLifecycleStatus, string>;

package/lib/typings/loanshub/rateReview.js

@@ -1,3 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateReviewLifecycleStatusLabels = exports.RateReviewLifecycleStatus = exports.RateReviewFlowType = void 0;
+var RateReviewFlowType;
+(function (RateReviewFlowType) {
+    RateReviewFlowType["Regular"] = "REGULAR";
+    RateReviewFlowType["Legacy"] = "LEGACY";
+})(RateReviewFlowType || (exports.RateReviewFlowType = RateReviewFlowType = {}));
+/** The application's current position in the complete rate-review journey. */
+var RateReviewLifecycleStatus;
+(function (RateReviewLifecycleStatus) {
+    RateReviewLifecycleStatus["ReadyForRateCapture"] = "READY_FOR_RATE_CAPTURE";
+    RateReviewLifecycleStatus["RateCaptureFormSent"] = "RATE_CAPTURE_FORM_SENT";
+    RateReviewLifecycleStatus["RateCaptureFormOpened"] = "RATE_CAPTURE_FORM_OPENED";
+    RateReviewLifecycleStatus["RateCaptureSubmitted"] = "RATE_CAPTURE_SUBMITTED";
+    RateReviewLifecycleStatus["WaitingForRateReview"] = "WAITING_FOR_RATE_REVIEW";
+    RateReviewLifecycleStatus["RateReviewDue"] = "RATE_REVIEW_DUE";
+    RateReviewLifecycleStatus["RateReviewFormSent"] = "RATE_REVIEW_FORM_SENT";
+    RateReviewLifecycleStatus["RateReviewFormOpened"] = "RATE_REVIEW_FORM_OPENED";
+    RateReviewLifecycleStatus["RateReviewSubmitted"] = "RATE_REVIEW_SUBMITTED";
+    RateReviewLifecycleStatus["PendingEligibilityCheck"] = "PENDING_ELIGIBILITY_CHECK";
+    RateReviewLifecycleStatus["NotEligibleClosed"] = "NOT_ELIGIBLE_CLOSED";
+    RateReviewLifecycleStatus["RefinanceEligible"] = "REFINANCE_ELIGIBLE";
+    RateReviewLifecycleStatus["RefinanceInviteSent"] = "REFINANCE_INVITE_SENT";
+    RateReviewLifecycleStatus["RefinanceApplicationCreated"] = "REFINANCE_APPLICATION_CREATED";
+    RateReviewLifecycleStatus["RefinanceApplicationSubmitted"] = "REFINANCE_APPLICATION_SUBMITTED";
+    RateReviewLifecycleStatus["RefinanceSettled"] = "REFINANCE_SETTLED";
+    RateReviewLifecycleStatus["RateCaptureExpired"] = "RATE_CAPTURE_EXPIRED";
+    RateReviewLifecycleStatus["RateReviewExpired"] = "RATE_REVIEW_EXPIRED";
+    RateReviewLifecycleStatus["EmailDeliveryFailed"] = "EMAIL_DELIVERY_FAILED";
+    RateReviewLifecycleStatus["CustomerOptedOut"] = "CUSTOMER_OPTED_OUT";
+    RateReviewLifecycleStatus["LoanNoLongerActive"] = "LOAN_NO_LONGER_ACTIVE";
+    RateReviewLifecycleStatus["FlowCancelled"] = "FLOW_CANCELLED";
+})(RateReviewLifecycleStatus || (exports.RateReviewLifecycleStatus = RateReviewLifecycleStatus = {}));
+exports.RateReviewLifecycleStatusLabels = {
+    [RateReviewLifecycleStatus.ReadyForRateCapture]: "Ready for rate capture",
+    [RateReviewLifecycleStatus.RateCaptureFormSent]: "Rate capture form sent",
+    [RateReviewLifecycleStatus.RateCaptureFormOpened]: "Rate capture form opened",
+    [RateReviewLifecycleStatus.RateCaptureSubmitted]: "Rate capture submitted",
+    [RateReviewLifecycleStatus.WaitingForRateReview]: "Waiting for rate review",
+    [RateReviewLifecycleStatus.RateReviewDue]: "Rate review due",
+    [RateReviewLifecycleStatus.RateReviewFormSent]: "Rate review form sent",
+    [RateReviewLifecycleStatus.RateReviewFormOpened]: "Rate review form opened",
+    [RateReviewLifecycleStatus.RateReviewSubmitted]: "Rate review submitted",
+    [RateReviewLifecycleStatus.PendingEligibilityCheck]: "Checking eligibility",
+    [RateReviewLifecycleStatus.NotEligibleClosed]: "Not eligible — closed",
+    [RateReviewLifecycleStatus.RefinanceEligible]: "Refinance eligible",
+    [RateReviewLifecycleStatus.RefinanceInviteSent]: "Refinance invite sent",
+    [RateReviewLifecycleStatus.RefinanceApplicationCreated]: "Refinance application created",
+    [RateReviewLifecycleStatus.RefinanceApplicationSubmitted]: "Refinance application submitted",
+    [RateReviewLifecycleStatus.RefinanceSettled]: "Refinance settled",
+    [RateReviewLifecycleStatus.RateCaptureExpired]: "Rate capture expired",
+    [RateReviewLifecycleStatus.RateReviewExpired]: "Rate review expired",
+    [RateReviewLifecycleStatus.EmailDeliveryFailed]: "Email delivery failed",
+    [RateReviewLifecycleStatus.CustomerOptedOut]: "Customer opted out",
+    [RateReviewLifecycleStatus.LoanNoLongerActive]: "Loan no longer active",
+    [RateReviewLifecycleStatus.FlowCancelled]: "Flow cancelled",
+};
 //# sourceMappingURL=rateReview.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"rateReview.js","sourceRoot":"","sources":["../../../src/typings/loanshub/rateReview.ts"],"names":[],"mappings":""}
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loanshub-shared",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "description": "shared package for loanshub",
   "main": "lib/index.js",
   "scripts": {
@@ -15,6 +15,7 @@
     "@types/jest": "^29.5.13",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
-    "typescript": "^5.6.3"
+    "typescript": "^5.6.3",
+    "undici-types": "^8.10.0"
   }
 }