@lendi/integrations-transform 1.3.8 → 1.4.1

package/lib/schemas/public-applicant-event.json

@@ -63,6 +63,34 @@
       "enum": ["EMPLOYEE", "SELF_EMPLOYED", "UNKNOWN"],
       "description": "applicant's employment type"
     },
+    "guarantorRelationshipToBorrowerApplicantId": {
+      "$ref": "#/definitions/id",
+      "description": "Applicant Id of borrower that has relationship with guarantor."
+    },
+    "guarantorRelationshipToBorrowerType": {
+      "enum": ["Father", "Mother", "Spouse", "Brother", "Sister", "Son", "Daughter", "Other Relative", "Other"],
+      "description": "The relationship between borrower and guarantor."
+    },
+    "guarantorRelationshipToBorrowerTypeOther": {
+      "type": "string",
+      "description": "Description of relationship between borrower and guarantor when other."
+    },
+    "guarantorRelationshipToBorrowerDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "applicantId": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerApplicantId"
+        },
+        "type": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerType"
+        },
+        "typeOther": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerTypeOther"
+        }
+      },
+      "required": ["applicantId", "type"]
+    },
     "isPrimaryApplicant": {
       "type": "boolean"
     },
@@ -568,6 +596,9 @@
         "employmentType": {
           "$ref": "#/definitions/employmentType"
         },
+        "guarantorRelationshipToBorrower": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerDefinition"
+        },
         "isPrimaryApplicant": {
           "$ref": "#/definitions/isPrimaryApplicant"
         },

package/lib/transform-events/transform-asset.js

@@ -148,6 +148,9 @@ function transformAsset(_a) {
                 case 'address':
                     (0, lodash_1.set)(partialApplication, assetMapping[key], (0, transform_asset_address_1.transformAddress)(value, addressId));
                     break;
+                case 'isConstruction':
+                    (0, lodash_1.set)(partialApplication, assetMapping[key], (0, __1.booleanMapping)(value));
+                    break;
                 case 'percentOwned':
                     var percentOwned = (0, transform_percent_owned_1.transformPercentOwned)(value);
                     if (percentOwned) {

package/lib/transform-events/transform-expenses.js

@@ -1,15 +1,4 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 exports.__esModule = true;
 exports.isLivingExpenseEstimate = exports.isOtherCommitment = exports.normaliseExpenseAmount = exports.transformExpense = exports.transformExpenses = exports.otherCommitmentExpenseTypes = void 0;
 var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
@@ -21,6 +10,12 @@ exports.otherCommitmentExpenseTypes = [
     public_expense_1.ExpenseType.ChildAndSpousalMaintenance,
     public_expense_1.ExpenseType.Rent,
 ];
+var propertyExpenseCategories = [
+    public_expense_1.ExpenseType.InvestmentPropertyRunningCosts,
+    public_expense_1.ExpenseType.BodyCorporateFeesStrataFeesAndLandTax,
+    public_expense_1.ExpenseType.SecondaryResidenceRunningCosts,
+    public_expense_1.ExpenseType.PrimaryResidenceRunningCosts,
+];
 /**
  * @description Transforms expense items on the application from the event.
  * @returns {PartialApplication} A PartialApplication returned by transforming the expense event.
@@ -33,12 +28,13 @@ function transformExpenses(expense) {
         return partialApplication;
     }
     var normalisedExpenses = expenses.map(normaliseExpenseAmount);
-    var livingExpenseEstimate = normalisedExpenses.find(isLivingExpenseEstimate);
-    var otherCommitments = normalisedExpenses.filter(isOtherCommitment);
-    var expenseBreakdown = normalisedExpenses.filter(function (item) { return !(isOtherCommitment(item) || isLivingExpenseEstimate(item)); });
+    var filteredLivingExpensesWithAmount = normalisedExpenses.filter(function (expense) { return expense.amount || !propertyExpenseCategories.includes(expense.type); });
+    var livingExpenseEstimate = filteredLivingExpensesWithAmount.find(isLivingExpenseEstimate);
+    var otherCommitments = filteredLivingExpensesWithAmount.filter(isOtherCommitment);
+    var expenseBreakdown = filteredLivingExpensesWithAmount.filter(function (item) { return !(isOtherCommitment(item) || isLivingExpenseEstimate(item)); });
     var livingExpenseEstimateExists = (0, lodash_1.get)(livingExpenseEstimate || {}, 'amount', 0) > 0;
     var expenseBreakdownAmountSum = (0, lodash_1.sumBy)(expenseBreakdown, 'amount');
-    var lixiLivingExpenses = [];
+    var lixiLivingExpenses;
     // unless all individual expenses have a value of 0 and a living estimate exists, transform them without question.
     if (expenseBreakdownAmountSum === 0 && livingExpenseEstimateExists) {
         var estimate = transformExpense(livingExpenseEstimate, applicantId, 0, id);
@@ -92,12 +88,15 @@ exports.transformExpense = transformExpense;
  * @returns {Expense} An normalised expense.
  */
 function normaliseExpenseAmount(expense) {
-    var _a = (0, lodash_1.pick)(expense, 'amount', 'frequency'), _b = _a.amount, amount = _b === void 0 ? 0 : _b, _c = _a.frequency, frequency = _c === void 0 ? public_expense_1.Frequency.Yearly : _c;
+    var amount = expense.amount, _a = expense.frequency, frequency = _a === void 0 ? public_expense_1.Frequency.Yearly : _a, expenseType = expense.type;
     if (frequency === public_expense_1.Frequency.Quarterly) {
-        frequency = public_expense_1.Frequency.Yearly;
-        amount = amount * 4;
+        expense.frequency = public_expense_1.Frequency.Yearly;
+        expense.amount *= 4;
+    }
+    if (!amount && !propertyExpenseCategories.includes(expenseType)) {
+        expense.amount = 0;
     }
-    return __assign(__assign({}, expense), { amount: amount, frequency: frequency });
+    return expense;
 }
 exports.normaliseExpenseAmount = normaliseExpenseAmount;
 /**

package/lib/types/events/public-applicant.d.ts

@@ -36,6 +36,7 @@ export interface Payload {
     entity?: Entity;
     firstName?: string;
     gender?: Gender;
+    guarantorRelationshipToBorrower?: GuarantorRelationshipToBorrowerDefinition;
     hasSelfEmploymentProof?: boolean;
     /**
      * uuid of applicant
@@ -429,6 +430,25 @@ export declare enum Gender {
     Undisclosed = "UNDISCLOSED",
     Unknown = "UNKNOWN"
 }
+export interface GuarantorRelationshipToBorrowerDefinition {
+    applicantId: string;
+    type: GuarantorRelationshipToBorrowerType;
+    typeOther?: string;
+}
+/**
+ * The relationship between borrower and guarantor.
+ */
+export declare enum GuarantorRelationshipToBorrowerType {
+    Brother = "Brother",
+    Daughter = "Daughter",
+    Father = "Father",
+    Mother = "Mother",
+    Other = "Other",
+    OtherRelative = "Other Relative",
+    Sister = "Sister",
+    Son = "Son",
+    Spouse = "Spouse"
+}
 /**
  * different invitation statuses an applicant can have
  */

package/lib/types/events/public-applicant.js

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.Type = exports.Title = exports.ResidencyStatus = exports.ActionedByRole = exports.MaritalStatus = exports.InvitationStatus = exports.Gender = exports.Entity = exports.EmploymentType = exports.CreditStatus = exports.HousingStatusList = exports.Countries = exports.ApplicantType = void 0;
+exports.Type = exports.Title = exports.ResidencyStatus = exports.ActionedByRole = exports.MaritalStatus = exports.InvitationStatus = exports.GuarantorRelationshipToBorrowerType = exports.Gender = exports.Entity = exports.EmploymentType = exports.CreditStatus = exports.HousingStatusList = exports.Countries = exports.ApplicantType = void 0;
 var ApplicantType;
 (function (ApplicantType) {
     ApplicantType["Borrower"] = "BORROWER";
@@ -294,6 +294,21 @@ var Gender;
     Gender["Undisclosed"] = "UNDISCLOSED";
     Gender["Unknown"] = "UNKNOWN";
 })(Gender = exports.Gender || (exports.Gender = {}));
+/**
+ * The relationship between borrower and guarantor.
+ */
+var GuarantorRelationshipToBorrowerType;
+(function (GuarantorRelationshipToBorrowerType) {
+    GuarantorRelationshipToBorrowerType["Brother"] = "Brother";
+    GuarantorRelationshipToBorrowerType["Daughter"] = "Daughter";
+    GuarantorRelationshipToBorrowerType["Father"] = "Father";
+    GuarantorRelationshipToBorrowerType["Mother"] = "Mother";
+    GuarantorRelationshipToBorrowerType["Other"] = "Other";
+    GuarantorRelationshipToBorrowerType["OtherRelative"] = "Other Relative";
+    GuarantorRelationshipToBorrowerType["Sister"] = "Sister";
+    GuarantorRelationshipToBorrowerType["Son"] = "Son";
+    GuarantorRelationshipToBorrowerType["Spouse"] = "Spouse";
+})(GuarantorRelationshipToBorrowerType = exports.GuarantorRelationshipToBorrowerType || (exports.GuarantorRelationshipToBorrowerType = {}));
 /**
  * different invitation statuses an applicant can have
  */

package/lib/update-application/update-primary-applicant.d.ts

@@ -0,0 +1,30 @@
+import { PersonApplicant } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { PartialApplication } from '../types/partial-application';
+import { Payload } from '../types/events/public-applicant';
+/**
+ * Checks if there are more than one person applicants with applicant type borrower
+ *
+ * @param {PersonApplicants[]} personApplicants - Person applicants on the deep merged application
+ *
+ * @returns {boolean} - Whether or not there are more than one applicant with applicant type borrower
+ */
+export declare const isMultiplePersonApplicantBorrowers: (personApplicants: PersonApplicant[]) => boolean;
+/**
+ * Updates the primary applicant of the application based on the new primary applicant id
+ *
+ * @param {String} newPrimaryApplicantId - New primary applicant id
+ * @param {PersonApplicant[]} personApplicants - Person applicants from the updated application after deep merge
+ *
+ * @returns {PersonApplicant[]} - Updated person applicants
+ */
+export declare const updatePrimaryApplicant: (newPrimaryApplicantId: string, personApplicants: PersonApplicant[]) => PersonApplicant[];
+/**
+ * Updates the primary applicant on the application based on the data in the guarantor applicant event
+ *
+ * @param {PartialApplication} application - Application after deep merge
+ * @param {Payload} applicantPayload - Public applicant event payload
+ *
+ * @returns {PartialApplication} - Updated application
+ */
+declare const updatePrimaryApplicantUsingGuarantor: (application: PartialApplication, applicantPayload: Payload) => PartialApplication;
+export default updatePrimaryApplicantUsingGuarantor;

package/lib/update-application/update-primary-applicant.js

@@ -0,0 +1,63 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+exports.__esModule = true;
+exports.updatePrimaryApplicant = exports.isMultiplePersonApplicantBorrowers = void 0;
+var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
+var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+var lodash_1 = require("lodash");
+var public_applicant_1 = require("../types/events/public-applicant");
+/**
+ * Checks if there are more than one person applicants with applicant type borrower
+ *
+ * @param {PersonApplicants[]} personApplicants - Person applicants on the deep merged application
+ *
+ * @returns {boolean} - Whether or not there are more than one applicant with applicant type borrower
+ */
+var isMultiplePersonApplicantBorrowers = function (personApplicants) {
+    var totalBorrowerApplicants = personApplicants.filter(function (applicant) { return applicant['@ApplicantType'] === lixi_internal_request_1.ApplicantTypeList.Borrower; }).length;
+    return totalBorrowerApplicants > 1;
+};
+exports.isMultiplePersonApplicantBorrowers = isMultiplePersonApplicantBorrowers;
+/**
+ * Updates the primary applicant of the application based on the new primary applicant id
+ *
+ * @param {String} newPrimaryApplicantId - New primary applicant id
+ * @param {PersonApplicant[]} personApplicants - Person applicants from the updated application after deep merge
+ *
+ * @returns {PersonApplicant[]} - Updated person applicants
+ */
+var updatePrimaryApplicant = function (newPrimaryApplicantId, personApplicants) {
+    return personApplicants.map(function (applicant) {
+        var _a;
+        return (__assign(__assign({}, applicant), (_a = {}, _a['@PrimaryApplicant'] = applicant['@UniqueID'] === newPrimaryApplicantId ? lixi_internal_request_1.YesNoList.Yes : lixi_internal_request_1.YesNoList.No, _a)));
+    });
+};
+exports.updatePrimaryApplicant = updatePrimaryApplicant;
+/**
+ * Updates the primary applicant on the application based on the data in the guarantor applicant event
+ *
+ * @param {PartialApplication} application - Application after deep merge
+ * @param {Payload} applicantPayload - Public applicant event payload
+ *
+ * @returns {PartialApplication} - Updated application
+ */
+var updatePrimaryApplicantUsingGuarantor = function (application, applicantPayload) {
+    var updatedApplication = application, personApplicants = (0, lodash_1.get)(application, application_paths_1.paths.PersonApplicants, []);
+    // Checks if there are more than one borrower in the application and that the applicant type of the applicant event being processed is GUARANTOR
+    if ((0, exports.isMultiplePersonApplicantBorrowers)(personApplicants) &&
+        applicantPayload.applicantType === public_applicant_1.ApplicantType.Guarantor) {
+        (0, lodash_1.set)(updatedApplication, application_paths_1.paths.PersonApplicants, (0, exports.updatePrimaryApplicant)(applicantPayload.guarantorRelationshipToBorrower.applicantId, personApplicants));
+    }
+    return updatedApplication;
+};
+exports["default"] = updatePrimaryApplicantUsingGuarantor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.3.8",
+  "version": "1.4.1",
   "description": "Library for kafka event data transforming",
   "author": "Integrations <integrations@lendi.com.au>",
   "homepage": "https://bitbucket.org/lendi-dev/integrations-shared-packages#readme",