@lendi/integrations-transform 1.3.9 → 1.4.0

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

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/enum-mappings/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/package.json

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

package/lib/transform-events/generate-application.d.ts

@@ -1,8 +0,0 @@
-import { Payload as ApplicationPayload } from '../types/events/public-application';
-/**
- * Generates a partial internal request from a partial opportunity event.
- *
- * @param opportunity: Partial opportunity event.
- * @return  partialApplication: A partial internal request.
- */
-export declare function generateApplication(opportunity: ApplicationPayload): {};

package/lib/transform-events/generate-application.js

@@ -1,49 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.generateApplication = void 0;
-var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-var lodash_1 = require("lodash");
-var preferred_repayment_1 = require("../types/enum-mappings/preferred-repayment");
-var transaction_type_1 = require("../types/enum-mappings/transaction-type");
-/**
- * Generates a partial internal request from a partial opportunity event.
- *
- * @param opportunity: Partial opportunity event.
- * @return  partialApplication: A partial internal request.
- */
-function generateApplication(opportunity) {
-    var partialApplication = {};
-    var opportunityMapping = {
-        brand: application_paths_1.paths.BusinessName,
-        id: application_paths_1.paths.ApplicationId,
-        paymentType: application_paths_1.paths.LoanTerm + ".@PaymentType",
-        preliminary: 'preliminary',
-        primaryPurpose: application_paths_1.paths.PurposeOfApplication
-    };
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.LoanDetail + ".@UniqueID", opportunity.id + "-loanDetails");
-    for (var _i = 0, _a = Object.entries(opportunity); _i < _a.length; _i++) {
-        var _b = _a[_i], opportunityKey = _b[0], opportunityValue = _b[1];
-        if (opportunityMapping[opportunityKey]) {
-            if (opportunityKey === 'preliminary') {
-                for (var _c = 0, _d = Object.entries(opportunityValue); _c < _d.length; _c++) {
-                    var _e = _d[_c], key = _e[0], value = _e[1];
-                    if (opportunityMapping[key]) {
-                        switch (key) {
-                            case 'paymentType':
-                                (0, lodash_1.set)(partialApplication, opportunityMapping[key], preferred_repayment_1.preferredRepaymentMapping[value]);
-                                break;
-                            case 'primaryPurpose':
-                                (0, lodash_1.set)(partialApplication, opportunityMapping[key], transaction_type_1.transactionTypeMapping[value]);
-                                break;
-                        }
-                    }
-                }
-            }
-            else {
-                (0, lodash_1.set)(partialApplication, opportunityMapping[opportunityKey], opportunityValue);
-            }
-        }
-    }
-    return partialApplication;
-}
-exports.generateApplication = generateApplication;

package/lib/transform-events/generate-asset.d.ts

@@ -1,17 +0,0 @@
-import { Asset, AssetDefinition as Payload } from '../types/events/public-asset';
-export declare const residentialTypeList: string[];
-export declare const propertyTypeNameList: string[];
-/**
- * Generates a partial internal request from a partial public asset event.
- *
- * @param asset: A partial public asset.
- * @param applicationId: Id of application.
- * @param id: Id of asset entity.
- * @return A partial InternalRequest.
- */
-export declare function generateAsset({ asset, applicationId, id }: Payload): {};
-/**
- * Checks if the asset is of financial type.
- * @param asset asset payload
- */
-export declare function isFinancialAsset(asset: Asset): boolean;

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

@@ -1,178 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.isFinancialAsset = exports.generateAsset = exports.propertyTypeNameList = exports.residentialTypeList = 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 logger_1 = require("../logger");
-var public_financial_asset_1 = require("../types/enum-mappings/public-financial-asset");
-var public_primary_purpose_1 = require("../types/enum-mappings/public-primary-purpose");
-var public_property_status_1 = require("../types/enum-mappings/public-property-status");
-var public_property_type_1 = require("../types/enum-mappings/public-property-type");
-var public_asset_1 = require("../types/events/public-asset");
-var generate_address_1 = require("../utils/generate-address");
-var get_financial_institution_1 = require("../utils/get-financial-institution");
-var generate_lixi_percentowned_1 = require("./generate-lixi-percentowned");
-var toBeUsedAsSecurityMapping = {
-    "true": lixi_internal_request_1.YesNoList.Yes,
-    "false": lixi_internal_request_1.YesNoList.No
-};
-var toBePurchasedMapping = {
-    "true": lixi_internal_request_1.AssetTransactionList.Purchasing,
-    "false": lixi_internal_request_1.AssetTransactionList.Owns
-};
-var assetMapping = {
-    make: application_paths_1.paths.NonRealEstateAsset + ".MotorVehicle.@Make",
-    year: application_paths_1.paths.NonRealEstateAsset + ".MotorVehicle.@Year",
-    model: application_paths_1.paths.NonRealEstateAsset + ".MotorVehicle.@Model",
-    estimatedValue: application_paths_1.paths.NonRealEstateAsset + ".EstimatedValue.@Value",
-    zoneType: application_paths_1.paths.RealEstateAsset + ".Zoning.@Type",
-    toBeUsedAsSecurity: application_paths_1.paths.RealEstateAsset + ".@ToBeUsedAsSecurity",
-    toBePurchased: application_paths_1.paths.RealEstateAsset + ".@Transaction",
-    primaryPurpose: application_paths_1.paths.RealEstateAsset + ".@PrimaryPurpose",
-    propertyStatus: application_paths_1.paths.RealEstateAsset + ".@Status",
-    financialInstitution: application_paths_1.paths.NonRealEstateAsset + ".FinancialAsset.AccountNumber.@FinancialInstitution",
-    propertyType: application_paths_1.paths.RealEstateAsset + ".Residential.@Type",
-    address: application_paths_1.paths.Address
-};
-exports.residentialTypeList = Object.values(lixi_internal_request_1.ResidentialTypeList);
-exports.propertyTypeNameList = Object.values(lixi_internal_request_1.Custom3PropertyTypeNameList);
-/**
- * Generates a partial internal request from a partial public asset event.
- *
- * @param asset: A partial public asset.
- * @param applicationId: Id of application.
- * @param id: Id of asset entity.
- * @return A partial InternalRequest.
- */
-function generateAsset(_a) {
-    var asset = _a.asset, applicationId = _a.applicationId, id = _a.id;
-    var partialApplication = {};
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
-    var isPropertyAsset = asset.type === public_asset_1.AssetType.Property;
-    switch (asset.type) {
-        case public_asset_1.AssetType.Vehicle:
-            (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".@Type", lixi_internal_request_1.NonRealEstateAssetTypeList.MotorVehicleAndTransport);
-            break;
-        case public_asset_1.AssetType.Property:
-            (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".@MultipleDwellings", lixi_internal_request_1.YesNoList.No);
-            break;
-        case public_asset_1.AssetType.HomeContents:
-            (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".@Type", lixi_internal_request_1.NonRealEstateAssetTypeList.Other);
-            (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".OtherAsset.@Type", lixi_internal_request_1.OtherAssetTypeList.HomeContents);
-            break;
-        case public_asset_1.AssetType.Gifts:
-        case public_asset_1.AssetType.OtherAsset:
-            (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".@Type", lixi_internal_request_1.NonRealEstateAssetTypeList.Other);
-            if (asset.description)
-                (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".OtherAsset.@Description", asset.description);
-            break;
-        case public_asset_1.AssetType.Shares:
-        case public_asset_1.AssetType.Superannuation:
-        case public_asset_1.AssetType.TermDeposit:
-        case public_asset_1.AssetType.SavingCheckAccount:
-        case public_asset_1.AssetType.ManagedFunds:
-            (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".@Type", lixi_internal_request_1.NonRealEstateAssetTypeList.FinancialAsset);
-            (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".FinancialAsset.@Type", public_financial_asset_1.financialAssetMapping[asset.type]);
-            break;
-        default:
-            logger_1.logger.warn({ message: "Unhandled asset type: " + asset.type, applicationId: applicationId });
-            return;
-    }
-    if (isPropertyAsset) {
-        (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".@UniqueID", id);
-        assetMapping.percentOwned = application_paths_1.paths.RealEstateAsset + ".PercentOwned";
-    }
-    else {
-        (0, lodash_1.set)(partialApplication, application_paths_1.paths.NonRealEstateAsset + ".@UniqueID", id);
-        assetMapping.percentOwned = application_paths_1.paths.NonRealEstateAsset + ".PercentOwned";
-    }
-    for (var _i = 0, _b = Object.entries(asset); _i < _b.length; _i++) {
-        var _c = _b[_i], key = _c[0], value = _c[1];
-        if (assetMapping[key]) {
-            switch (key) {
-                case 'primaryPurpose':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], public_primary_purpose_1.primaryPurposeMapping[value]);
-                    break;
-                case 'toBePurchased':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], toBePurchasedMapping[value]);
-                    break;
-                case 'propertyStatus':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], public_property_status_1.propertyStatusMapping[value]);
-                    break;
-                case 'toBeUsedAsSecurity':
-                    if (isPropertyAsset)
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], toBeUsedAsSecurityMapping[value]);
-                    break;
-                case 'estimatedValue':
-                    if (isPropertyAsset) {
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".EstimatedValue.@Value", value);
-                    }
-                    else {
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], value);
-                    }
-                    break;
-                case 'propertyType':
-                    var mappedValue = public_property_type_1.propertyTypeMapping[value];
-                    if (exports.residentialTypeList.includes(mappedValue)) {
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".Residential.@Type", mappedValue);
-                    }
-                    else if (exports.propertyTypeNameList.includes(mappedValue)) {
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".PropertyType.@PropertyTypeName", mappedValue);
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".PropertyType.@CategoryTypeName", lixi_internal_request_1.Custom2CategoryTypeNameList.Residential);
-                    }
-                    else {
-                        logger_1.logger.warn({ message: "Unknown propertyType " + value + " for asset " + id, applicationId: applicationId });
-                    }
-                    break;
-                case 'zoneType':
-                    if (asset.zoneType === public_asset_1.ZoneType.Commercial) {
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".Commercial.@Type", lixi_internal_request_1.OtherAssetTypeList.Other);
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], lixi_internal_request_1.Custom4TypeList.Commercial);
-                    }
-                    else {
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], lixi_internal_request_1.Custom4TypeList.Residential);
-                    }
-                    break;
-                case 'financialInstitution':
-                    if (isFinancialAsset(asset)) {
-                        var financialInstitution = (0, get_financial_institution_1.getFinancialInstitution)(value.toString());
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], financialInstitution);
-                    }
-                    break;
-                case 'year':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], value.toString());
-                    break;
-                case 'address':
-                    var addressId = id + "-address";
-                    (0, lodash_1.set)(partialApplication, application_paths_1.paths.RealEstateAsset + ".@x_Address", addressId);
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], (0, generate_address_1.generateAddress)(value, addressId));
-                    break;
-                case 'percentOwned':
-                    var percentOwned = (0, generate_lixi_percentowned_1.generateLIXIPercentOwned)(value);
-                    if (percentOwned) {
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], percentOwned);
-                    }
-                    break;
-                default:
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], value);
-            }
-        }
-    }
-    return partialApplication;
-}
-exports.generateAsset = generateAsset;
-/**
- * Checks if the asset is of financial type.
- * @param asset asset payload
- */
-function isFinancialAsset(asset) {
-    return [
-        public_asset_1.AssetType.Shares,
-        public_asset_1.AssetType.Superannuation,
-        public_asset_1.AssetType.TermDeposit,
-        public_asset_1.AssetType.SavingCheckAccount,
-        public_asset_1.AssetType.ManagedFunds,
-    ].includes(asset.type);
-}
-exports.isFinancialAsset = isFinancialAsset;

package/lib/transform-events/generate-expenses.d.ts

@@ -1,28 +0,0 @@
-import { LivingExpense, OtherCommitment } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-import { Expense, Payload as ExpensePayload } from '../types/events/public-expense';
-/**
- *  Generates expense items on the application from the event.
- * @param expense event payload.
- */
-export declare function generateExpenses(expense: ExpensePayload): {};
-/**
- * Generates the living expense from the expense array on the event.
- *
- * @param expense: Array of expenses on the event.
- * @param applicantId: Event applicantId.
- * @param index: Index of the map.
- * @param id: Id of the event.
- */
-export declare function generateExpense(
-  expense: Expense,
-  applicantId: string,
-  index: number,
-  id: string
-): LivingExpense | OtherCommitment;
-/**
- * Should change any expense with frequency as quarterly value to yearly and change the amount also set amount to 0
- * if not available, also remove the type living_expenses_estimate.
- *
- * @param expenses: expenses array from the event.
- */
-export declare function normaliseExpenseAmount(expenses: Expense[]): Expense[];

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

@@ -1,94 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.normaliseExpenseAmount = exports.generateExpense = exports.generateExpenses = void 0;
-var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-var lodash_1 = require("lodash");
-var expense_frequency_1 = require("../types/enum-mappings/expense-frequency");
-var living_expense_1 = require("../types/enum-mappings/living-expense");
-var public_expense_1 = require("../types/events/public-expense");
-var otherCommitmentExpenseTypes = [public_expense_1.ExpenseType.Board, public_expense_1.ExpenseType.ChildAndSpousalMaintenance, public_expense_1.ExpenseType.Rent];
-/**
- *  Generates expense items on the application from the event.
- * @param expense event payload.
- */
-function generateExpenses(expense) {
-    var partialApplication = {};
-    var applicantId = expense.applicantId, applicationId = expense.applicationId, expenses = expense.expenses, id = expense.id;
-    var normalizedExpenses = normaliseExpenseAmount(expenses);
-    var otherCommitmentExpenses = normalizedExpenses.filter(function (expense) {
-        return otherCommitmentExpenseTypes.includes(expense.type);
-    });
-    var livingExpenses = normalizedExpenses.filter(function (expense) { return !otherCommitmentExpenseTypes.includes(expense.type); });
-    var lixiLivingExpenses = [];
-    var lixiCommitmentExpenses = otherCommitmentExpenses.map(function (expense, index) {
-        return generateExpense(expense, applicantId, index, id);
-    });
-    var expenseEstimate = expenses.find(function (expense) { return expense.type === public_expense_1.ExpenseType.LivingExpensesEstimate; });
-    var livingExpenseEstimateExists = expenseEstimate && expenseEstimate.amount && expenseEstimate.amount > 0;
-    var expensesWithoutEstimate = livingExpenses.filter(function (expense) { return expense.type !== public_expense_1.ExpenseType.LivingExpensesEstimate; });
-    var expensesAmountSum = (0, lodash_1.sumBy)(expensesWithoutEstimate, 'amount');
-    if (expensesAmountSum === 0 && livingExpenseEstimateExists) {
-        lixiLivingExpenses = [generateExpense(expenseEstimate, applicantId, 0, id)];
-    }
-    if (expensesAmountSum > 0) {
-        lixiLivingExpenses = expensesWithoutEstimate.map(function (expense, index) {
-            return generateExpense(expense, applicantId, index, id);
-        });
-    }
-    if (lixiLivingExpenses.length > 0) {
-        (0, lodash_1.set)(partialApplication, application_paths_1.paths.LivingExpenses, lixiLivingExpenses);
-    }
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.Household + ".@UniqueID", applicationId + "-household");
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.PersonApplicant + ".@UniqueID", applicantId);
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.OtherCommitments, lixiCommitmentExpenses);
-    return partialApplication;
-}
-exports.generateExpenses = generateExpenses;
-/**
- * Generates the living expense from the expense array on the event.
- *
- * @param expense: Array of expenses on the event.
- * @param applicantId: Event applicantId.
- * @param index: Index of the map.
- * @param id: Id of the event.
- */
-function generateExpense(expense, applicantId, index, id) {
-    return {
-        '@Amount': expense.amount,
-        '@Category': living_expense_1.livingExpenseMapping[expense.type],
-        '@Description': expense.type,
-        '@UniqueID': otherCommitmentExpenseTypes.includes(expense.type)
-            ? id + "-commitment-" + index
-            : id + "-living-expense-" + index,
-        '@Frequency': expense_frequency_1.frequencyMapping[expense.frequency],
-        PercentResponsible: {
-            Owner: [
-                {
-                    '@Percent': 100,
-                    '@x_Party': applicantId
-                },
-            ]
-        }
-    };
-}
-exports.generateExpense = generateExpense;
-/**
- * Should change any expense with frequency as quarterly value to yearly and change the amount also set amount to 0
- * if not available, also remove the type living_expenses_estimate.
- *
- * @param expenses: expenses array from the event.
- */
-function normaliseExpenseAmount(expenses) {
-    return expenses.map(function (expense) {
-        if (!expense.amount) {
-            expense.amount = 0;
-        }
-        if (expense.frequency === public_expense_1.Frequency.Quarterly) {
-            expense.amount *= 4;
-            expense.frequency = public_expense_1.Frequency.Yearly;
-        }
-        return expense;
-    });
-}
-exports.normaliseExpenseAmount = normaliseExpenseAmount;

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

@@ -1,57 +0,0 @@
-import {
-  Frequency,
-  OwnershipProportion as PercentOwned,
-  IncomeDefinition as IncomePayload,
-} from '../types/events/public-income';
-import { PersonApplicant } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-export interface AmountFrequency {
-  amount: string;
-  frequency?: string;
-}
-export declare const EmploymentIncomeTypeMapping: Record<string, AmountFrequency>;
-export declare function isPaygIncome(incomeType: string): boolean;
-export declare function isSelfEmployedIncome(incomeType: string): boolean;
-export declare function isRentalIncome(incomeType: string): boolean;
-/**
- * Generates an partial application from a partial income event.
- *
- * @param payload a partial income event.
- * @param storedApplication: Current state of the application.
- * @return partialApplication an incomplete application.
- */
-export declare function generateIncome(payload: IncomePayload, storedApplication: any): {};
-/**
- * Gets the applicant id if given employmentId belongs to it.
- *
- * @param application
- * @param employmentId
- */
-export declare function getApplicantIdForEmploymentId(application?: any, employmentId?: string): string;
-/**
- * Checks if given employment id belongs to given applicant.
- *
- * @param applicant
- * @param employmentId
- */
-export declare function containsEmploymentId(applicant: PersonApplicant, employmentId: string): boolean;
-/**
- * Gets the employmentId if given income is employment income.
- *
- * @param payload
- */
-export declare function getEmploymentIdForIncome(payload: IncomePayload): string;
-/**
- * Creates Rental Income array.
- * @param owners List of owners.
- * @param amount Amount
- * @param frequency Frequency
- */
-export declare function createRentalIncome(
-  { owners }: PercentOwned,
-  amount: number,
-  frequency: Frequency
-): {
-  '@Frequency': import('@lendi/integrations-protocol/lib/types/lixi-internal-request').List;
-  '@RentalIncome': number;
-  '@x_Owner': string;
-}[];

package/lib/transform-events/generate-income.js

@@ -1,247 +0,0 @@
-"use strict";
-var _a;
-exports.__esModule = true;
-exports.createRentalIncome = exports.getEmploymentIdForIncome = exports.containsEmploymentId = exports.getApplicantIdForEmploymentId = exports.generateIncome = exports.isRentalIncome = exports.isSelfEmployedIncome = exports.isPaygIncome = exports.EmploymentIncomeTypeMapping = void 0;
-var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-var lodash_1 = require("lodash");
-var logger_1 = require("../logger");
-var public_income_1 = require("../types/events/public-income");
-var round_decimal_1 = require("../utils/round-decimal");
-var alieo_frequency_1 = require("../types/enum-mappings/alieo-frequency");
-var generate_lixi_percentowned_1 = require("./generate-lixi-percentowned");
-var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
-var income_type_1 = require("../types/enum-mappings/income-type");
-var government_benefits_1 = require("../types/enum-mappings/government-benefits");
-var PAYGList = [
-    public_income_1.IncomeType.PaygAllowancesNotTaxed,
-    public_income_1.IncomeType.PaygAllowancesTaxed,
-    public_income_1.IncomeType.PaygBaseSalary,
-    public_income_1.IncomeType.PaygBonusIncome,
-    public_income_1.IncomeType.PaygCarAllowance,
-    public_income_1.IncomeType.PaygCommissionIncome,
-    public_income_1.IncomeType.PaygCompanyCar,
-    public_income_1.IncomeType.PaygOvertimeIncome,
-];
-var netWorkAllowanceAmount = 'Income.@NetWorkAllowanceAmount';
-var netWorkAllowanceFrequency = 'Income.@NetWorkAllowanceFrequency';
-// Income types mapping from internal to LIXI types /paths.
-exports.EmploymentIncomeTypeMapping = (_a = {},
-    _a[public_income_1.IncomeType.PaygAllowancesNotTaxed] = {
-        amount: 'Income.@WorkAllowanceAmount',
-        frequency: 'Income.@WorkAllowanceFrequency'
-    },
-    _a[public_income_1.IncomeType.PaygAllowancesTaxed] = {
-        amount: netWorkAllowanceAmount,
-        frequency: netWorkAllowanceFrequency
-    },
-    _a[public_income_1.IncomeType.PaygBaseSalary] = {
-        amount: 'Income.@GrossSalaryAmount',
-        frequency: 'Income.@GrossSalaryFrequency'
-    },
-    _a[public_income_1.IncomeType.PaygBonusIncome] = {
-        amount: 'Income.@BonusAmount',
-        frequency: 'Income.@BonusFrequency'
-    },
-    _a[public_income_1.IncomeType.PaygCommissionIncome] = {
-        amount: 'Income.@CommissionAmount',
-        frequency: 'Income.@CommissionFrequency'
-    },
-    _a[public_income_1.IncomeType.PaygCompanyCar] = {
-        amount: 'Income.@NetCarAllowanceAmount',
-        frequency: 'Income.@NetCarAllowanceFrequency'
-    },
-    _a[public_income_1.IncomeType.PaygCarAllowance] = {
-        amount: 'Income.@CarAllowanceAmount',
-        frequency: 'Income.@CarAllowanceFrequency'
-    },
-    _a[public_income_1.IncomeType.PaygOvertimeIncome] = {
-        amount: 'Income.@GrossRegularOvertimeAmount',
-        frequency: 'Income.@GrossRegularOvertimeFrequency'
-    },
-    _a[public_income_1.IncomeType.SelfEmployedBusinessIncome] = {
-        amount: 'BusinessIncomeRecent.@ProfitBeforeTax'
-    },
-    _a);
-var descriptionOtherIncomeTypes = [
-    public_income_1.IncomeType.InvestmentIncome,
-    public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax,
-    public_income_1.IncomeType.RentalIncome,
-];
-// Check if given income type is a PAYG income type.
-function isPaygIncome(incomeType) {
-    return PAYGList.includes(incomeType);
-}
-exports.isPaygIncome = isPaygIncome;
-// Check if given income type is a self employment income type.
-function isSelfEmployedIncome(incomeType) {
-    return incomeType === public_income_1.IncomeType.SelfEmployedBusinessIncome;
-}
-exports.isSelfEmployedIncome = isSelfEmployedIncome;
-// Check if given income type is a rental income type.
-function isRentalIncome(incomeType) {
-    return incomeType === public_income_1.IncomeType.RentalIncome;
-}
-exports.isRentalIncome = isRentalIncome;
-/**
- * Generates an partial application from a partial income event.
- *
- * @param payload a partial income event.
- * @param storedApplication: Current state of the application.
- * @return partialApplication an incomplete application.
- */
-function generateIncome(payload, storedApplication) {
-    var applicationId = payload.applicationId, id = payload.id, income = payload.income;
-    var applicantId = (0, lodash_1.get)(income, 'percentOwned.owners[0].applicantId');
-    if (!applicantId) {
-        var employmentId = getEmploymentIdForIncome(payload);
-        applicantId = getApplicantIdForEmploymentId(storedApplication, employmentId);
-    }
-    var incomeAmount = income.amount, incomeType = income.type, incomeFrequency = income.frequency;
-    var partialApplication = {};
-    var incomeMapping;
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
-    if (applicantId && !isRentalIncome(incomeType)) {
-        (0, lodash_1.set)(partialApplication, application_paths_1.paths.PersonApplicant + ".@UniqueID", applicantId);
-    }
-    else {
-        logger_1.logger.warn({
-            message: "No applicantId found for income event with id : " + id + " and type " + incomeType + " for application: " + applicationId
-        });
-    }
-    if (isPaygIncome(incomeType)) {
-        var _a = exports.EmploymentIncomeTypeMapping[incomeType], amount = _a.amount, frequency = _a.frequency;
-        incomeMapping = {
-            amount: application_paths_1.paths.PAYG + "." + amount,
-            frequency: application_paths_1.paths.PAYG + "." + frequency,
-            employmentId: application_paths_1.paths.PAYG + ".@UniqueID"
-        };
-    }
-    else if (isSelfEmployedIncome(incomeType)) {
-        var amount = exports.EmploymentIncomeTypeMapping[incomeType].amount;
-        incomeMapping = {
-            amount: application_paths_1.paths.SelfEmployed + "." + amount,
-            employmentId: application_paths_1.paths.SelfEmployed + ".@UniqueID"
-        };
-    }
-    else if (isRentalIncome(incomeType)) {
-        incomeMapping = {
-            assetId: application_paths_1.paths.RealEstateAsset + ".@UniqueID",
-            percentOwned: application_paths_1.paths.RealEstateAsset + ".RentalIncome"
-        };
-    }
-    else {
-        (0, lodash_1.set)(partialApplication, application_paths_1.paths.OtherIncome + ".@UniqueID", id);
-        incomeMapping = {
-            amount: application_paths_1.paths.OtherIncome + ".@Amount",
-            frequency: application_paths_1.paths.OtherIncome + ".@Frequency",
-            percentOwned: application_paths_1.paths.OtherIncome + ".PercentOwned",
-            type: application_paths_1.paths.OtherIncome + ".@Type",
-            benefitType: application_paths_1.paths.OtherIncome + ".@GovernmentBenefitsType"
-        };
-    }
-    for (var _i = 0, _b = Object.entries(income); _i < _b.length; _i++) {
-        var _c = _b[_i], key = _c[0], value = _c[1];
-        if (incomeMapping[key]) {
-            switch (key) {
-                case 'amount':
-                    var amount = incomeFrequency === public_income_1.Frequency.Quarterly ? value * 4 : value;
-                    (0, lodash_1.set)(partialApplication, incomeMapping[key], (0, round_decimal_1.roundDecimal)(amount));
-                    break;
-                case 'frequency':
-                    (0, lodash_1.set)(partialApplication, incomeMapping[key], alieo_frequency_1.incomeExpenseFrequencyMapping[value]);
-                    break;
-                case 'percentOwned':
-                    var percentOwned = (0, generate_lixi_percentowned_1.generateLIXIPercentOwned)(value);
-                    if (isRentalIncome(incomeType)) {
-                        percentOwned = createRentalIncome(value, incomeAmount, incomeFrequency);
-                    }
-                    if (percentOwned) {
-                        (0, lodash_1.set)(partialApplication, incomeMapping[key], percentOwned);
-                    }
-                    break;
-                case 'type':
-                    var mappedType = income_type_1.otherIncomeMapping[value];
-                    if (descriptionOtherIncomeTypes.includes(value)) {
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.OtherIncome + ".@Description", mappedType);
-                        (0, lodash_1.set)(partialApplication, incomeMapping[key], lixi_internal_request_1.OtherIncomeTypeList.OtherIncome);
-                    }
-                    else {
-                        (0, lodash_1.set)(partialApplication, incomeMapping[key], mappedType);
-                    }
-                    break;
-                case 'benefitType':
-                    (0, lodash_1.set)(partialApplication, incomeMapping[key], government_benefits_1.governmentBenefitsMapping[value]);
-                    break;
-                default:
-                    (0, lodash_1.set)(partialApplication, incomeMapping[key], value);
-                    break;
-            }
-        }
-    }
-    return partialApplication;
-}
-exports.generateIncome = generateIncome;
-/**
- * Gets the applicant id if given employmentId belongs to it.
- *
- * @param application
- * @param employmentId
- */
-function getApplicantIdForEmploymentId(application, employmentId) {
-    if (!employmentId || !application)
-        return null;
-    var applicants = (0, lodash_1.get)(application, application_paths_1.paths.PersonApplicants, []);
-    var applicant = applicants.find(function (applicant) { return containsEmploymentId(applicant, employmentId); });
-    return applicant ? applicant['@UniqueID'] : null;
-}
-exports.getApplicantIdForEmploymentId = getApplicantIdForEmploymentId;
-/**
- * Checks if given employment id belongs to given applicant.
- *
- * @param applicant
- * @param employmentId
- */
-function containsEmploymentId(applicant, employmentId) {
-    return (applicant.Employment || []).some(function (employment) {
-        return (0, lodash_1.get)(employment, 'PAYG.@UniqueID') === employmentId ||
-            (0, lodash_1.get)(employment, 'SelfEmployed.@UniqueID') === employmentId ||
-            (0, lodash_1.get)(employment, 'NotEmployed.@UniqueID') === employmentId;
-    });
-}
-exports.containsEmploymentId = containsEmploymentId;
-/**
- * Gets the employmentId if given income is employment income.
- *
- * @param payload
- */
-function getEmploymentIdForIncome(payload) {
-    var _a = payload.income, incomeType = _a.type, employmentId = _a.employmentId;
-    if (isPaygIncome(incomeType) || isSelfEmployedIncome(incomeType))
-        return employmentId;
-    return undefined;
-}
-exports.getEmploymentIdForIncome = getEmploymentIdForIncome;
-/**
- * Creates Rental Income array.
- * @param owners List of owners.
- * @param amount Amount
- * @param frequency Frequency
- */
-function createRentalIncome(_a, amount, frequency) {
-    var _b = _a.owners, owners = _b === void 0 ? [] : _b;
-    if (owners.length === 0)
-        return null;
-    if (frequency === public_income_1.Frequency.Quarterly) {
-        amount = Math.ceil(amount / 3);
-        frequency = public_income_1.Frequency.Monthly;
-    }
-    return owners.map(function (_a) {
-        var percent = _a.percent, applicantId = _a.applicantId;
-        return ({
-            '@Frequency': alieo_frequency_1.incomeExpenseFrequencyMapping[frequency],
-            '@RentalIncome': percent * amount,
-            '@x_Owner': applicantId
-        });
-    });
-}
-exports.createRentalIncome = createRentalIncome;

package/lib/transform-events/generate-liability.d.ts

@@ -1,8 +0,0 @@
-import { LiabilityPayload } from '../types/events/public-liability';
-/**
- * Generates a partial internal request from a liability event payload.
- *
- * @param liabilityPayload: A liability event payload.
- * @return A partial InternalRequest.
- */
-export declare function generateLiability({ applicationId, id, liability }: LiabilityPayload): {};

package/lib/transform-events/generate-liability.js

@@ -1,87 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.generateLiability = void 0;
-var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-var lodash_1 = require("lodash");
-var alieo_frequency_1 = require("../types/enum-mappings/alieo-frequency");
-var liability_payment_type_1 = require("../types/enum-mappings/liability-payment-type");
-var liability_type_1 = require("../types/enum-mappings/liability-type");
-var get_financial_institution_1 = require("../utils/get-financial-institution");
-var round_decimal_1 = require("../utils/round-decimal");
-var generate_lixi_percentowned_1 = require("./generate-lixi-percentowned");
-var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
-/**
- * Generates a partial internal request from a liability event payload.
- *
- * @param liabilityPayload: A liability event payload.
- * @return A partial InternalRequest.
- */
-function generateLiability(_a) {
-    var applicationId = _a.applicationId, id = _a.id, liability = _a.liability;
-    var partialApplication = {};
-    var liabilityMapping = {
-        applicationId: application_paths_1.paths.ApplicationId,
-        annualInterestRate: application_paths_1.paths.Liability + ".@AnnualInterestRate",
-        id: application_paths_1.paths.Liability + ".@UniqueID",
-        clearingFromThisLoan: application_paths_1.paths.Liability + ".@ClearingFromThisLoan",
-        description: application_paths_1.paths.Liability + ".@Description",
-        financialInstitution: application_paths_1.paths.Liability + ".AccountNumber.@FinancialInstitution",
-        newLimit: application_paths_1.paths.Liability + ".@CreditLimit",
-        repaymentAmount: application_paths_1.paths.Liability + ".Repayment[0].@RepaymentAmount",
-        repaymentFrequency: application_paths_1.paths.Liability + ".Repayment[0].@RepaymentFrequency",
-        remainingTermDuration: application_paths_1.paths.Liability + ".RemainingTerm.@Duration",
-        repaymentTypeDetails: application_paths_1.paths.Liability + ".Repayment[0].@PaymentType",
-        outstandingBalance: application_paths_1.paths.Liability + ".@OutstandingBalance",
-        type: application_paths_1.paths.Liability + ".@Type",
-        percentOwned: application_paths_1.paths.Liability + ".PercentOwned"
-    };
-    (0, lodash_1.set)(partialApplication, liabilityMapping.applicationId, applicationId);
-    (0, lodash_1.set)(partialApplication, liabilityMapping.id, id);
-    // Default repayments to 0 and repaymentFrequency to weekly.
-    (0, lodash_1.set)(partialApplication, liabilityMapping.repaymentAmount, 0);
-    (0, lodash_1.set)(partialApplication, liabilityMapping.repaymentFrequency, lixi_internal_request_1.List.Weekly);
-    // Default clearingFromThisLoan to No if the value is not present in the event.
-    (0, lodash_1.set)(partialApplication, liabilityMapping.clearingFromThisLoan, lixi_internal_request_1.YesNoList.No);
-    for (var _i = 0, _b = Object.entries(liability); _i < _b.length; _i++) {
-        var _c = _b[_i], key = _c[0], value = _c[1];
-        if (liabilityMapping[key]) {
-            switch (key) {
-                case 'outstandingBalance':
-                case 'newLimit':
-                case 'repaymentAmount':
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], (0, round_decimal_1.roundDecimal)(value));
-                    break;
-                case 'type':
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], liability_type_1.liabilityTypeMapping[value]);
-                    break;
-                case 'clearingFromThisLoan':
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], value ? lixi_internal_request_1.YesNoList.Yes : lixi_internal_request_1.YesNoList.No);
-                    break;
-                case 'repaymentFrequency':
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], alieo_frequency_1.liabilityFrequencyMapping[value]);
-                    break;
-                case 'repaymentTypeDetails':
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], liability_payment_type_1.liabilityPaymentTypeMapping[value]);
-                    break;
-                case 'remainingTermDuration':
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], Math.round(+value));
-                    break;
-                case 'financialInstitution':
-                    var financialInstitution = (0, get_financial_institution_1.getFinancialInstitution)(value.toString());
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], financialInstitution);
-                    break;
-                case 'percentOwned':
-                    var percentOwned = (0, generate_lixi_percentowned_1.generateLIXIPercentOwned)(value);
-                    if (percentOwned) {
-                        (0, lodash_1.set)(partialApplication, liabilityMapping[key], percentOwned);
-                    }
-                    break;
-                default:
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], value);
-                    break;
-            }
-        }
-    }
-    return partialApplication;
-}
-exports.generateLiability = generateLiability;

package/lib/transform-events/generate-lixi-percentowned.d.ts

@@ -1,12 +0,0 @@
-import { PercentOwned } from '../types/events/public-liability';
-/**
- * Transform percentOwned to lixi's format.
- *
- * @param percentOwned PercentOwned for an asset or liability on public liability event.
- */
-export declare function generateLIXIPercentOwned({ owners }: PercentOwned): {
-  Owner: {
-    '@Percent': number;
-    '@x_Party': string;
-  }[];
-};

package/lib/transform-events/generate-lixi-percentowned.js

@@ -1,23 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.generateLIXIPercentOwned = void 0;
-/**
- * Transform percentOwned to lixi's format.
- *
- * @param percentOwned PercentOwned for an asset or liability on public liability event.
- */
-function generateLIXIPercentOwned(_a) {
-    var _b = _a.owners, owners = _b === void 0 ? [] : _b;
-    if (owners.length === 0)
-        return null;
-    return {
-        Owner: owners.map(function (_a) {
-            var percent = _a.percent, applicantId = _a.applicantId;
-            return ({
-                '@Percent': percent * 100,
-                '@x_Party': applicantId
-            });
-        })
-    };
-}
-exports.generateLIXIPercentOwned = generateLIXIPercentOwned;

package/lib/transform-events/generate-opportunity.d.ts

@@ -1,8 +0,0 @@
-import { PayloadObject as OpportunityPayload } from '../types/events/opportunity';
-/**
- * Generates a partial internal request from a partial opportunity event.
- *
- * @param opportunity: Partial opportunity event.
- * @return  partialApplication: A partial internal request.
- */
-export declare function generateOpportunity(opportunity: OpportunityPayload): {};

package/lib/transform-events/generate-opportunity.js

@@ -1,32 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.generateOpportunity = void 0;
-var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-var lodash_1 = require("lodash");
-/**
- * Generates a partial internal request from a partial opportunity event.
- *
- * @param opportunity: Partial opportunity event.
- * @return  partialApplication: A partial internal request.
- */
-function generateOpportunity(opportunity) {
-    var partialApplication = {};
-    var opportunityMapping = {
-        id: application_paths_1.paths.ApplicationId,
-        stage: application_paths_1.paths.Instructions
-    };
-    for (var _i = 0, _a = Object.entries(opportunity); _i < _a.length; _i++) {
-        var _b = _a[_i], key = _b[0], value = _b[1];
-        if (opportunityMapping[key]) {
-            if (key === 'stage') {
-                (0, lodash_1.set)(partialApplication, application_paths_1.paths.Instructions + ".@UniqueID", opportunity.id + "-stage");
-                (0, lodash_1.set)(partialApplication, opportunityMapping[key] + ".@Details", value || 'Unknown');
-            }
-            else {
-                (0, lodash_1.set)(partialApplication, opportunityMapping[key], value);
-            }
-        }
-    }
-    return partialApplication;
-}
-exports.generateOpportunity = generateOpportunity;