@lendi/integrations-transform 1.5.7 → 1.5.10

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

@@ -1,61 +1,55 @@
-"use strict";
-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");
-var lodash_1 = require("lodash");
-var enum_mappings_1 = require("../types/enum-mappings/");
-var public_expense_1 = require("../types/events/public-expense");
-exports.otherCommitmentExpenseTypes = [
-    public_expense_1.ExpenseType.Board,
-    public_expense_1.ExpenseType.ChildAndSpousalMaintenance,
-    public_expense_1.ExpenseType.Rent,
+import { paths } from '@lendi/integrations-protocol/lib/utils/application-paths';
+import { get, set, sumBy } from 'lodash';
+import { frequencyMapping, livingExpenseMapping } from '../types/enum-mappings/';
+import { ExpenseType, Frequency } from '../types/events/public-expense';
+export const otherCommitmentExpenseTypes = [
+    ExpenseType.Board,
+    ExpenseType.ChildAndSpousalMaintenance,
+    ExpenseType.Rent,
 ];
-var propertyExpenseCategories = [
-    public_expense_1.ExpenseType.InvestmentPropertyRunningCosts,
-    public_expense_1.ExpenseType.BodyCorporateFeesStrataFeesAndLandTax,
-    public_expense_1.ExpenseType.SecondaryResidenceRunningCosts,
-    public_expense_1.ExpenseType.PrimaryResidenceRunningCosts,
+const propertyExpenseCategories = [
+    ExpenseType.InvestmentPropertyRunningCosts,
+    ExpenseType.BodyCorporateFeesStrataFeesAndLandTax,
+    ExpenseType.SecondaryResidenceRunningCosts,
+    ExpenseType.PrimaryResidenceRunningCosts,
 ];
 /**
  * @description Transforms expense items on the application from the event.
  * @returns {PartialApplication} A PartialApplication returned by transforming the expense event.
  * @param expense
  */
-function transformExpenses(expense) {
-    var partialApplication = {};
-    var applicantId = expense.applicantId, applicationId = expense.applicationId, _a = expense.expenses, expenses = _a === void 0 ? [] : _a, id = expense.id;
-    if (expenses.every(function (expense) { return expense.amount === undefined || expense.amount === null; })) {
+export function transformExpenses(expense) {
+    const partialApplication = {};
+    const { applicantId, applicationId, expenses = [], id } = expense;
+    if (expenses.every((expense) => expense.amount === undefined || expense.amount === null)) {
         return partialApplication;
     }
-    var normalisedExpenses = expenses.map(normaliseExpenseAmount);
-    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;
+    const normalisedExpenses = expenses.map(normaliseExpenseAmount);
+    const filteredLivingExpensesWithAmount = normalisedExpenses.filter((expense) => expense.amount || !propertyExpenseCategories.includes(expense.type));
+    const livingExpenseEstimate = filteredLivingExpensesWithAmount.find(isLivingExpenseEstimate);
+    const otherCommitments = filteredLivingExpensesWithAmount.filter(isOtherCommitment);
+    const expenseBreakdown = filteredLivingExpensesWithAmount.filter((item) => !(isOtherCommitment(item) || isLivingExpenseEstimate(item)));
+    const livingExpenseEstimateExists = get(livingExpenseEstimate || {}, 'amount', 0) > 0;
+    const expenseBreakdownAmountSum = sumBy(expenseBreakdown, 'amount');
+    let 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);
+        const estimate = transformExpense(livingExpenseEstimate, applicantId, 0, id);
         lixiLivingExpenses = [estimate];
     }
     else {
-        lixiLivingExpenses = expenseBreakdown.map(function (expense, index) {
-            return transformExpense(expense, applicantId, index, id);
-        });
+        lixiLivingExpenses = expenseBreakdown.map((expense, index) => transformExpense(expense, applicantId, index, id));
     }
-    var lixiCommitmentExpenses = otherCommitments.map(function (expense, index) { return transformExpense(expense, applicantId, index, id); });
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
-    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.Household, ".@UniqueID"), "".concat(applicationId, "-household"));
-    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.PersonApplicant, ".@UniqueID"), applicantId);
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.OtherCommitments, lixiCommitmentExpenses);
+    const lixiCommitmentExpenses = otherCommitments.map((expense, index) => transformExpense(expense, applicantId, index, id));
+    set(partialApplication, paths.ApplicationId, applicationId);
+    set(partialApplication, `${paths.Household}.@UniqueID`, `${applicationId}-household`);
+    set(partialApplication, `${paths.PersonApplicant}.@UniqueID`, applicantId);
+    set(partialApplication, paths.OtherCommitments, lixiCommitmentExpenses);
     if (lixiLivingExpenses.length > 0) {
-        (0, lodash_1.set)(partialApplication, application_paths_1.paths.LivingExpenses, lixiLivingExpenses);
+        set(partialApplication, paths.LivingExpenses, lixiLivingExpenses);
     }
     return partialApplication;
 }
-exports.transformExpenses = transformExpenses;
 /**
  * transforms the living expense from the expense array on the event.
  *
@@ -63,34 +57,37 @@ exports.transformExpenses = transformExpenses;
  * @param applicantId: Event applicantId.
  * @param index: Index of the map.
  * @param id: Id of the event.
+ * @param expense
+ * @param applicantId
+ * @param index
+ * @param id
  */
-function transformExpense(expense, applicantId, index, id) {
+export function transformExpense(expense, applicantId, index, id) {
     return {
         '@Amount': expense.amount,
-        '@Category': enum_mappings_1.livingExpenseMapping[expense.type],
+        '@Category': livingExpenseMapping[expense.type],
         '@Description': expense.type,
-        '@UniqueID': isOtherCommitment(expense) ? "".concat(id, "-commitment-").concat(index) : "".concat(id, "-living-expense-").concat(index),
-        '@Frequency': enum_mappings_1.frequencyMapping[expense.frequency],
+        '@UniqueID': isOtherCommitment(expense) ? `${id}-commitment-${index}` : `${id}-living-expense-${index}`,
+        '@Frequency': frequencyMapping[expense.frequency],
         PercentResponsible: {
             Owner: [
                 {
                     '@Percent': 100,
-                    '@x_Party': applicantId
+                    '@x_Party': applicantId,
                 },
-            ]
-        }
+            ],
+        },
     };
 }
-exports.transformExpense = transformExpense;
 /**
  * @description Normalises expense by amount to 0 if not provided and scales quarterly spending up to yearly.
  * @param {Expense} expense An expense
  * @returns {Expense} An normalised expense.
  */
-function normaliseExpenseAmount(expense) {
-    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) {
-        expense.frequency = public_expense_1.Frequency.Yearly;
+export function normaliseExpenseAmount(expense) {
+    const { amount, frequency = Frequency.Yearly, type: expenseType } = expense;
+    if (frequency === Frequency.Quarterly) {
+        expense.frequency = Frequency.Yearly;
         expense.amount *= 4;
     }
     if (!amount && !propertyExpenseCategories.includes(expenseType)) {
@@ -98,22 +95,19 @@ function normaliseExpenseAmount(expense) {
     }
     return expense;
 }
-exports.normaliseExpenseAmount = normaliseExpenseAmount;
 /**
  * @description Verify if expense is an OtherCommitment.
  * @param {Expense} expense Any Expense item.
  * @returns {boolean} Returns true if an expense type is one of other commitment expenses.
  */
-function isOtherCommitment(expense) {
-    return exports.otherCommitmentExpenseTypes.includes(expense.type);
+export function isOtherCommitment(expense) {
+    return otherCommitmentExpenseTypes.includes(expense.type);
 }
-exports.isOtherCommitment = isOtherCommitment;
 /**
  * @description Check if expense type is LivingExpenseEstimate.
  * @param {Expense} expense An Expense item.
  * @returns {boolean} Returns true if an expense type is LivingExpenseEstimate
  */
-function isLivingExpenseEstimate(expense) {
-    return expense.type === public_expense_1.ExpenseType.LivingExpensesEstimate;
+export function isLivingExpenseEstimate(expense) {
+    return expense.type === ExpenseType.LivingExpensesEstimate;
 }
-exports.isLivingExpenseEstimate = isLivingExpenseEstimate;

package/lib/transform-events/transform-funding-position.d.ts

@@ -6,7 +6,7 @@ import { PartialApplication } from '../types/partial-application';
  *
  * @param fundingPosition a partialFundingPosition.
  * @param uniqueIdSuffix
- * @return partialApplication with fees, grants and borrowers contributions added.
+ * @returns partialApplication with fees, grants and borrowers contributions added.
  */
 export declare function transformFundingPosition(fundingPosition: FundingPositionPayload, uniqueIdSuffix?: string): PartialApplication;
 /**
@@ -16,6 +16,6 @@ export declare function transformFundingPosition(fundingPosition: FundingPositio
  * @param lmi
  * @param lmiIncluded
  * @param id
- * @return Array of fees
+ * @returns Array of fees
  */
 export declare function getFees(fundsRequiredBreakDown: FundsRequiredBreakdown, lmi: number, lmiIncluded: boolean, id: string): Fee[];

package/lib/transform-events/transform-funding-position.js

@@ -1,63 +1,57 @@
-"use strict";
-exports.__esModule = true;
-exports.getFees = exports.transformFundingPosition = void 0;
-var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
-var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-var lodash_1 = require("lodash");
-var enum_mappings_1 = require("../types/enum-mappings");
+import { YesNoList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
+import { paths } from '@lendi/integrations-protocol/lib/utils/application-paths';
+import { set, omit } from 'lodash';
+import { categoryMapping, typeMapping, descriptionMapping, contributionMapping } from '../types/enum-mappings';
 /**
  * GenerateFundingPosition
  *
  * @param fundingPosition a partialFundingPosition.
  * @param uniqueIdSuffix
- * @return partialApplication with fees, grants and borrowers contributions added.
+ * @returns partialApplication with fees, grants and borrowers contributions added.
  */
-function transformFundingPosition(fundingPosition, uniqueIdSuffix) {
-    if (uniqueIdSuffix === void 0) { uniqueIdSuffix = 'loanDetails'; }
-    var partialApplication = {};
-    var contributionFunds = [];
-    var applicationId = fundingPosition.applicationId, id = fundingPosition.id, _a = fundingPosition.lmi, lmi = _a === void 0 ? 0 : _a, _b = fundingPosition.lmiIncluded, lmiIncluded = _b === void 0 ? false : _b;
-    var fundingPositionMapping = {
-        applicationId: application_paths_1.paths.ApplicationId,
-        fundsRequested: "".concat(application_paths_1.paths.RolledUpAmounts, ".@TotalNewFunds"),
-        lvr: "".concat(application_paths_1.paths.Summary, ".LoanToValuationRatio.@ApplicationLVR"),
-        totalGovernmentContributions: application_paths_1.paths.ContributionFunds,
-        totalDeposit: application_paths_1.paths.ContributionFunds,
-        totalCashOut: "".concat(application_paths_1.paths.EquityRelease, ".Amount.@LumpSum"),
-        fundsRequiredBreakdown: application_paths_1.paths.SummaryFee
+export function transformFundingPosition(fundingPosition, uniqueIdSuffix = 'loanDetails') {
+    const partialApplication = {};
+    const contributionFunds = [];
+    const { applicationId, id, lmi = 0, lmiIncluded = false } = fundingPosition;
+    const fundingPositionMapping = {
+        applicationId: paths.ApplicationId,
+        fundsRequested: `${paths.RolledUpAmounts}.@TotalNewFunds`,
+        lvr: `${paths.Summary}.LoanToValuationRatio.@ApplicationLVR`,
+        totalGovernmentContributions: paths.ContributionFunds,
+        totalDeposit: paths.ContributionFunds,
+        totalCashOut: `${paths.EquityRelease}.Amount.@LumpSum`,
+        fundsRequiredBreakdown: paths.SummaryFee,
     };
-    for (var _i = 0, _c = Object.entries(fundingPosition); _i < _c.length; _i++) {
-        var _d = _c[_i], key = _d[0], value = _d[1];
+    for (const [key, value] of Object.entries(fundingPosition)) {
         if (fundingPositionMapping[key]) {
             switch (key) {
                 case 'totalGovernmentContributions':
                 case 'totalDeposit':
                     contributionFunds.push({
                         '@Amount': value,
-                        '@Type': enum_mappings_1.contributionMapping[key],
-                        '@UniqueID': "".concat(id, "-").concat(key)
+                        '@Type': contributionMapping[key],
+                        '@UniqueID': `${id}-${key}`,
                     });
                     break;
                 case 'fundsRequiredBreakdown':
-                    (0, lodash_1.set)(partialApplication, application_paths_1.paths.SummaryFee, getFees(value, lmi, lmiIncluded, id));
+                    set(partialApplication, paths.SummaryFee, getFees(value, lmi, lmiIncluded, id));
                     break;
                 case 'totalCashOut':
-                    (0, lodash_1.set)(partialApplication, fundingPositionMapping[key], value);
-                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.LoanDetail, ".@UniqueID"), "".concat(applicationId, "-").concat(uniqueIdSuffix));
+                    set(partialApplication, fundingPositionMapping[key], value);
+                    set(partialApplication, `${paths.LoanDetail}.@UniqueID`, `${applicationId}-${uniqueIdSuffix}`);
                     break;
                 case 'fundsRequested':
-                    (0, lodash_1.set)(partialApplication, fundingPositionMapping[key], Math.round(value));
+                    set(partialApplication, fundingPositionMapping[key], Math.round(value));
                     break;
                 default:
-                    (0, lodash_1.set)(partialApplication, fundingPositionMapping[key], value);
+                    set(partialApplication, fundingPositionMapping[key], value);
                     break;
             }
         }
     }
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ContributionFunds, contributionFunds);
+    set(partialApplication, paths.ContributionFunds, contributionFunds);
     return partialApplication;
 }
-exports.transformFundingPosition = transformFundingPosition;
 /**
  * getFee
  *
@@ -65,33 +59,31 @@ exports.transformFundingPosition = transformFundingPosition;
  * @param lmi
  * @param lmiIncluded
  * @param id
- * @return Array of fees
+ * @returns Array of fees
  */
-function getFees(fundsRequiredBreakDown, lmi, lmiIncluded, id) {
+export function getFees(fundsRequiredBreakDown, lmi, lmiIncluded, id) {
     // Adding lmi to fees to be transformed.
-    (0, lodash_1.set)(fundsRequiredBreakDown, 'lmi', lmi);
+    set(fundsRequiredBreakDown, 'lmi', lmi);
     // Omitting constructionCosts as they don't belong in fees.
-    return Object.entries((0, lodash_1.omit)(fundsRequiredBreakDown, 'constructionCosts')).map(function (_a) {
-        var key = _a[0], value = _a[1];
-        var descriptionList = ['accruedInterest', 'otherSundries'];
-        var fee = {
+    return Object.entries(omit(fundsRequiredBreakDown, 'constructionCosts')).map(([key, value]) => {
+        const descriptionList = ['accruedInterest', 'otherSundries'];
+        const fee = {
             '@Amount': value,
-            '@Category': enum_mappings_1.categoryMapping[key],
-            '@Type': enum_mappings_1.typeMapping[key],
-            '@UniqueID': "".concat(id, "-").concat(key)
+            '@Category': categoryMapping[key],
+            '@Type': typeMapping[key],
+            '@UniqueID': `${id}-${key}`,
         };
         if (descriptionList.includes(key)) {
-            fee['@Description'] = enum_mappings_1.descriptionMapping[key];
+            fee['@Description'] = descriptionMapping[key];
         }
         if (key === 'lmi') {
             if (lmiIncluded)
-                fee['@CapitaliseFee'] = lixi_internal_request_1.YesNoList.Yes;
+                fee['@CapitaliseFee'] = YesNoList.Yes;
             // If lmiIncluded is undefined we do not want to set '@CapitaliseFee'
             // only if it is false as this will affect how we handle migration.
             if (lmiIncluded === false)
-                fee['@CapitaliseFee'] = lixi_internal_request_1.YesNoList.No;
+                fee['@CapitaliseFee'] = YesNoList.No;
         }
         return fee;
     });
 }
-exports.getFees = getFees;

package/lib/transform-events/transform-income.d.ts

@@ -7,17 +7,22 @@ export interface AmountFrequency {
     frequency?: string;
 }
 export declare const EmploymentIncomeTypeMapping: Record<string, AmountFrequency>;
+/**
+ *
+ * @param incomeType
+ */
 export declare function getIncomeMapping(incomeType: IncomeType): Record<string, string>;
 /**
  * Generates an partial application from a partial income event.
  *
  * @param payload a partial income event.
  * @param applicantId PersonApplicant uniqueId on the application.
- * @return partialApplication an incomplete application.
+ * @returns partialApplication an incomplete application.
  */
 export declare function transformIncome(payload: IncomePayload, applicantId?: string): PartialApplication;
 /**
  * Creates Rental Income array.
+ *
  * @param amount Amount
  * @param frequency Frequency
  * @param ownership Owners.
@@ -37,5 +42,7 @@ export interface SelfEmploymentIncomeMapping {
 export declare function generateIncomeBusinessDetails(data: IncomeBusinessDetails): IncomeElement;
 /**
  * Generates the BAS array from the bas definition on the event.
+ *
+ * @param bas
  */
 export declare function generateBAS(bas: BASDefinition[]): IncomeBusinessActivityStatement[];