@lendi/integrations-transform 1.1.1 → 1.1.6

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

@@ -36,7 +36,7 @@ var assetMapping = {
     address: application_paths_1.paths.Address
 };
 exports.residentialTypeList = Object.values(lixi_internal_request_1.ResidentialTypeList);
-exports.propertyTypeNameList = Object.values(lixi_internal_request_1.Custom3PropertyTypeNameList);
+exports.propertyTypeNameList = Object.values(lixi_internal_request_1.Custom2PropertyTypeNameList);
 /**
  * Generates a partial internal request from a partial public asset event.
  *
@@ -119,7 +119,7 @@ function generateAsset(_a) {
                     }
                     else if (exports.propertyTypeNameList.includes(mappedValue)) {
                         (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".PropertyType.@PropertyTypeName"), mappedValue);
-                        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".PropertyType.@CategoryTypeName"), lixi_internal_request_1.Custom2CategoryTypeNameList.Residential);
+                        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".PropertyType.@CategoryTypeName"), lixi_internal_request_1.Custom1CategoryTypeNameList.Residential);
                     }
                     else {
                         logger_1.logger.warn({ message: "Unknown propertyType ".concat(value, " for asset ").concat(id), applicationId: applicationId });
@@ -128,10 +128,10 @@ function generateAsset(_a) {
                 case 'zoneType':
                     if (asset.zoneType === public_asset_1.ZoneType.Commercial) {
                         (0, lodash_1.set)(partialApplication, "".concat(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);
+                        (0, lodash_1.set)(partialApplication, assetMapping[key], lixi_internal_request_1.Custom3TypeList.Commercial);
                     }
                     else {
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], lixi_internal_request_1.Custom4TypeList.Residential);
+                        (0, lodash_1.set)(partialApplication, assetMapping[key], lixi_internal_request_1.Custom3TypeList.Residential);
                     }
                     break;
                 case 'financialInstitution':

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

@@ -1,21 +1,21 @@
+import { IncomeBusinessActivityStatement, IncomeElement } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
 import { RentalIncome } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
+import { BASDefinition, Frequency, IncomeBusinessDetails, IncomeDefinition as IncomePayload, IncomeType, Ownership } from '../types/events/public-income';
 import { PartialApplication } from '../types/partial-application';
-import { Frequency, IncomeBusinessDetails, IncomeDefinition as IncomePayload, IncomeType, Ownership } from '../types/events/public-income';
-import { IncomeRecent } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
 export interface AmountFrequency {
     amount: string;
     frequency?: string;
 }
 export declare const EmploymentIncomeTypeMapping: Record<string, AmountFrequency>;
-export declare function getIncomeMapping(incomeType: IncomeType, basePath?: string): Record<string, string>;
+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 storedApplication: Current state of the application.
+ * @param applicantId PersonApplicant uniqueId on the application.
  * @return partialApplication an incomplete application.
  */
-export declare function generateIncome(payload: IncomePayload, storedApplication: PartialApplication): PartialApplication;
+export declare function generateIncome(payload: IncomePayload, applicantId?: string): PartialApplication;
 /**
  * Creates Rental Income array.
  * @param amount Amount
@@ -32,6 +32,10 @@ export interface SelfEmploymentIncomeMapping {
 /**
  * @description Transform a Self Employed Income Details to LIXI
  * @param data Financial Year Income Details for Self Employed Income.
- * @returns {IncomeRecent} LIXI Income for the Self Employed.
+ * @returns {IncomeElement} LIXI Income for the Self Employed.
  */
-export declare function generateIncomeBusinessDetails(data: IncomeBusinessDetails): IncomeRecent;
+export declare function generateIncomeBusinessDetails(data: IncomeBusinessDetails): IncomeElement;
+/**
+ * Generates the BAS array from the bas definition on the event.
+ */
+export declare function generateBAS(bas: BASDefinition[]): IncomeBusinessActivityStatement[];

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

@@ -1,4 +1,15 @@
 "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);
+};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -12,17 +23,17 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 var _a;
 exports.__esModule = true;
-exports.generateIncomeBusinessDetails = exports.createRentalIncome = exports.generateIncome = exports.getIncomeMapping = exports.EmploymentIncomeTypeMapping = void 0;
+exports.generateBAS = exports.generateIncomeBusinessDetails = exports.createRentalIncome = exports.generateIncome = exports.getIncomeMapping = exports.EmploymentIncomeTypeMapping = 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 application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
 var lodash_1 = require("lodash");
 var alieo_frequency_1 = require("../types/enum-mappings/alieo-frequency");
 var government_benefits_1 = require("../types/enum-mappings/government-benefits");
 var income_type_1 = require("../types/enum-mappings/income-type");
 var public_income_1 = require("../types/events/public-income");
+var is_income_type_1 = require("../utils/is-income-type");
 var round_decimal_1 = require("../utils/round-decimal");
 var generate_lixi_percentowned_1 = require("./generate-lixi-percentowned");
-var is_income_type_1 = require("../utils/is-income-type");
 var netWorkAllowanceAmount = 'Income.@NetWorkAllowanceAmount';
 var netWorkAllowanceFrequency = 'Income.@NetWorkAllowanceFrequency';
 // Income types mapping from internal to LIXI types /paths.
@@ -59,37 +70,37 @@ exports.EmploymentIncomeTypeMapping = (_a = {},
         amount: 'Income.@GrossRegularOvertimeAmount',
         frequency: 'Income.@GrossRegularOvertimeFrequency'
     },
-    _a[public_income_1.IncomeType.SelfEmployedBusinessIncome] = {
-        amount: 'BusinessIncomeRecent.@ProfitBeforeTax'
-    },
     _a);
-function getIncomeMapping(incomeType, basePath) {
-    if (basePath === void 0) { basePath = application_paths_1.paths.PAYG; }
+function getIncomeMapping(incomeType) {
+    var basePath = application_paths_1.paths.OtherIncome;
     if ((0, is_income_type_1.isRentalIncome)(incomeType)) {
+        basePath = application_paths_1.paths.RealEstateAsset;
         return {
             assetId: "".concat(basePath, ".@UniqueID"),
             percentOwned: "".concat(basePath, ".RentalIncome")
         };
     }
     if ((0, is_income_type_1.isFullDocOrLowDocIncome)(incomeType)) {
+        basePath = application_paths_1.paths.CompanyApplicant;
         return {
-            incomes: "".concat(basePath, ".IncomeRecent"),
+            bas: "".concat(basePath, ".Income[0].BusinessActivityStatement"),
             companyId: "".concat(basePath, ".@UniqueID"),
-            incomeRecent: "".concat(basePath, ".IncomeRecent"),
-            incomePrevious: "".concat(basePath, ".IncomePrevious"),
+            incomes: "".concat(basePath, ".Income"),
             gross: "".concat(basePath, ".DeclaredIncome.@IncomeAmount")
         };
     }
-    if ((0, is_income_type_1.isPaygIncome)(incomeType) || (0, is_income_type_1.isSelfEmployedIncome)(incomeType)) {
-        var _a = exports.EmploymentIncomeTypeMapping[incomeType], amount = _a.amount, frequency = _a.frequency;
-        var mapping = {
+    if ((0, is_income_type_1.isSelfEmployedIncome)(incomeType)) {
+        basePath = application_paths_1.paths.SelfEmployed;
+        var amount = exports.EmploymentIncomeTypeMapping[incomeType].amount;
+        return {
             amount: "".concat(basePath, ".").concat(amount),
             employmentId: "".concat(basePath, ".@UniqueID")
         };
-        if (frequency) {
-            mapping.frequency = "".concat(basePath, ".").concat(frequency);
-        }
-        return mapping;
+    }
+    if ((0, is_income_type_1.isPaygIncome)(incomeType)) {
+        basePath = application_paths_1.paths.PAYG;
+        var _a = exports.EmploymentIncomeTypeMapping[incomeType], amount = _a.amount, frequency = _a.frequency;
+        return __assign({ amount: "".concat(basePath, ".").concat(amount), employmentId: "".concat(basePath, ".@UniqueID") }, (frequency && { frequency: "".concat(basePath, ".").concat(frequency) }));
     }
     return {
         amount: "".concat(basePath, ".@Amount"),
@@ -104,39 +115,21 @@ exports.getIncomeMapping = getIncomeMapping;
  * Generates an partial application from a partial income event.
  *
  * @param payload a partial income event.
- * @param storedApplication: Current state of the application.
+ * @param applicantId PersonApplicant uniqueId on the application.
  * @return partialApplication an incomplete application.
  */
-function generateIncome(payload, storedApplication) {
+function generateIncome(payload, applicantId) {
     var applicationId = payload.applicationId, id = payload.id, income = payload.income;
     var incomeAmount = income.amount, incomeType = income.type, incomeFrequency = income.frequency;
     var partialApplication = {};
     (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
-    if (!(0, is_income_type_1.isRentalIncome)(incomeType)) {
-        var applicants = (0, lodash_1.get)(storedApplication, application_paths_1.paths.PersonApplicants);
-        var applicantId = (0, is_income_type_1.getApplicantId)(income, applicants);
-        if (applicantId) {
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.PersonApplicant, ".@UniqueID"), applicantId);
-        }
-    }
-    var incomeMapping;
-    if ((0, is_income_type_1.isRentalIncome)(incomeType)) {
-        incomeMapping = getIncomeMapping(incomeType, application_paths_1.paths.RealEstateAsset);
-    }
-    else if ((0, is_income_type_1.isPaygIncome)(incomeType)) {
-        incomeMapping = getIncomeMapping(incomeType, application_paths_1.paths.PAYG);
-    }
-    else if ((0, is_income_type_1.isSelfEmployedIncome)(incomeType)) {
-        incomeMapping = getIncomeMapping(incomeType, application_paths_1.paths.SelfEmployed);
-    }
-    else if ((0, is_income_type_1.isFullDocOrLowDocIncome)(incomeType)) {
-        var basePath = 'Package.Content.Application.CompanyApplicant[0]';
-        incomeMapping = getIncomeMapping(incomeType, basePath);
+    if (!(0, is_income_type_1.isRentalIncome)(incomeType) && applicantId) {
+        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.PersonApplicant, ".@UniqueID"), applicantId);
     }
-    else {
+    if ((0, is_income_type_1.isOtherIncome)(incomeType)) {
         (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.OtherIncome, ".@UniqueID"), id);
-        incomeMapping = getIncomeMapping(incomeType, application_paths_1.paths.OtherIncome);
     }
+    var incomeMapping = getIncomeMapping(incomeType);
     for (var _i = 0, _a = Object.entries(income); _i < _a.length; _i++) {
         var _b = _a[_i], key = _b[0], value = _b[1];
         if (incomeMapping[key]) {
@@ -145,6 +138,11 @@ function generateIncome(payload, storedApplication) {
                     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 'bas':
+                    var basWithAmount = value.filter(function (bas) { return bas.salesAmount !== undefined || false; });
+                    if (!(0, lodash_1.isEmpty)(basWithAmount))
+                        (0, lodash_1.set)(partialApplication, incomeMapping[key], generateBAS(basWithAmount));
+                    break;
                 case 'frequency':
                     (0, lodash_1.set)(partialApplication, incomeMapping[key], alieo_frequency_1.incomeExpenseFrequencyMapping[value]);
                     break;
@@ -161,7 +159,7 @@ function generateIncome(payload, storedApplication) {
                 case 'type':
                     if (!(0, is_income_type_1.isRentalIncome)(incomeType)) {
                         var mappedType = income_type_1.otherIncomeMapping[value];
-                        if ((0, is_income_type_1.isOtherIncome)(value)) {
+                        if ((0, is_income_type_1.isOtherIncomeWithDesc)(value)) {
                             (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.OtherIncome, ".@Description"), mappedType);
                             (0, lodash_1.set)(partialApplication, incomeMapping[key], lixi_internal_request_1.OtherIncomeTypeList.OtherIncome);
                         }
@@ -177,7 +175,7 @@ function generateIncome(payload, storedApplication) {
                     var sortedIncomeList = value
                         .sort(is_income_type_1.sortBusinessIncome)
                         .map(generateIncomeBusinessDetails);
-                    (0, lodash_1.set)(partialApplication, 'Package.Content.Application.CompanyApplicant[0].Income', sortedIncomeList);
+                    (0, lodash_1.set)(partialApplication, incomeMapping[key], sortedIncomeList);
                     break;
                 default:
                     (0, lodash_1.set)(partialApplication, incomeMapping[key], value);
@@ -230,20 +228,23 @@ var selfEmploymentIncomeMapping = {
 /**
  * @description Transform a Self Employed Income Details to LIXI
  * @param data Financial Year Income Details for Self Employed Income.
- * @returns {IncomeRecent} LIXI Income for the Self Employed.
+ * @returns {IncomeElement} LIXI Income for the Self Employed.
  */
 function generateIncomeBusinessDetails(data) {
     var income = {};
     var addbackMapping = selfEmploymentIncomeMapping.addback, dateAndIncomeMapping = __rest(selfEmploymentIncomeMapping, ["addback"]);
     for (var _i = 0, _a = Object.entries(data); _i < _a.length; _i++) {
         var _b = _a[_i], key = _b[0], value = _b[1];
-        if (selfEmploymentIncomeMapping[key] != null) {
+        if (selfEmploymentIncomeMapping[key] !== null) {
             if (key === 'addback') {
                 for (var _c = 0, _d = Object.entries(value); _c < _d.length; _c++) {
                     var _e = _d[_c], addbackKey = _e[0], addbackValue = _e[1];
                     (0, lodash_1.set)(income, addbackMapping[addbackKey], addbackValue);
                 }
             }
+            else if (key === 'year') {
+                (0, lodash_1.set)(income, dateAndIncomeMapping[key], value.toString());
+            }
             else {
                 (0, lodash_1.set)(income, dateAndIncomeMapping[key], value);
             }
@@ -252,3 +253,13 @@ function generateIncomeBusinessDetails(data) {
     return income;
 }
 exports.generateIncomeBusinessDetails = generateIncomeBusinessDetails;
+/**
+ * Generates the BAS array from the bas definition on the event.
+ */
+function generateBAS(bas) {
+    return bas.map(function (bas) { return ({
+        '@Quarter': bas.quarter,
+        '@SalesAmount': bas.salesAmount
+    }); });
+}
+exports.generateBAS = generateBAS;

package/lib/types/enum-mappings/funding-position.d.ts

@@ -1,4 +1,4 @@
-import { FeeCategoryList, FeeTypeList, Custom5DescriptionList as DescriptionList, ContributionFundsTypeList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
+import { FeeCategoryList, FeeTypeList, Custom4DescriptionList as DescriptionList, ContributionFundsTypeList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
 declare type CategoryMapping = {
     [key: string]: FeeCategoryList;
 };

package/lib/types/enum-mappings/funding-position.js

@@ -25,8 +25,8 @@ exports.typeMapping = {
     foreignBuyerSurcharge: lixi_internal_request_1.FeeTypeList.Other
 };
 exports.descriptionMapping = {
-    accruedInterest: lixi_internal_request_1.Custom5DescriptionList.PotentialAccruedInterest,
-    otherSundries: lixi_internal_request_1.Custom5DescriptionList.OtherSundries
+    accruedInterest: lixi_internal_request_1.Custom4DescriptionList.PotentialAccruedInterest,
+    otherSundries: lixi_internal_request_1.Custom4DescriptionList.OtherSundries
 };
 exports.contributionMapping = {
     totalGovernmentContributions: lixi_internal_request_1.ContributionFundsTypeList.FirstHomeOwnerGrant,

package/lib/types/enum-mappings/income-type.d.ts

@@ -1,7 +1,7 @@
-import { OtherIncomeTypeList, Custom1DescriptionList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
+import { OtherIncomeTypeList, Custom0DescriptionList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
 import { IncomeType } from '../events/public-income';
 declare type OtherIncomeMapping = {
-    [key in IncomeType]: OtherIncomeTypeList | Custom1DescriptionList;
+    [key in IncomeType]: OtherIncomeTypeList | Custom0DescriptionList;
 };
 export declare const otherIncomeMapping: Partial<OtherIncomeMapping>;
 export {};

package/lib/types/enum-mappings/income-type.js

@@ -8,9 +8,9 @@ exports.otherIncomeMapping = (_a = {},
     _a[public_income_1.IncomeType.ChildMaintenance] = lixi_internal_request_1.OtherIncomeTypeList.ChildMaintenance,
     _a[public_income_1.IncomeType.ForeignIncome] = lixi_internal_request_1.OtherIncomeTypeList.ForeignSourced,
     _a[public_income_1.IncomeType.GovtBenefit] = lixi_internal_request_1.OtherIncomeTypeList.GovernmentBenefits,
-    _a[public_income_1.IncomeType.InvestmentIncome] = lixi_internal_request_1.Custom1DescriptionList.InvestmentIncome,
+    _a[public_income_1.IncomeType.InvestmentIncome] = lixi_internal_request_1.Custom0DescriptionList.InvestmentIncome,
     _a[public_income_1.IncomeType.OtherIncome] = lixi_internal_request_1.OtherIncomeTypeList.OtherIncome,
-    _a[public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax] = lixi_internal_request_1.Custom1DescriptionList.PAYGNonVoluntaryDeductionsPreTax,
+    _a[public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax] = lixi_internal_request_1.Custom0DescriptionList.PAYGNonVoluntaryDeductionsPreTax,
     _a[public_income_1.IncomeType.PaygSalarySacrifice] = lixi_internal_request_1.OtherIncomeTypeList.SalarySacrificeContribution,
     _a[public_income_1.IncomeType.SuperAnnuityPension] = lixi_internal_request_1.OtherIncomeTypeList.Superannuation,
     _a[public_income_1.IncomeType.WorkersCompensation] = lixi_internal_request_1.OtherIncomeTypeList.WorkersCompensation,

package/lib/types/enum-mappings/public-property-type.d.ts

@@ -1,7 +1,7 @@
 import { PropertyType } from '../events/public-asset';
-import { ResidentialTypeList, Custom3PropertyTypeNameList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
+import { ResidentialTypeList, Custom2PropertyTypeNameList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
 declare type PropertyTypeMapping = {
-    [key in PropertyType]: ResidentialTypeList | Custom3PropertyTypeNameList;
+    [key in PropertyType]: ResidentialTypeList | Custom2PropertyTypeNameList;
 };
 export declare const propertyTypeMapping: PropertyTypeMapping;
 export {};

package/lib/types/enum-mappings/public-property-type.js

@@ -19,6 +19,6 @@ exports.propertyTypeMapping = (_a = {},
     _a[public_asset_1.PropertyType.Townhouse] = lixi_internal_request_1.ResidentialTypeList.Townhouse,
     _a[public_asset_1.PropertyType.Villa] = lixi_internal_request_1.ResidentialTypeList.Villa,
     _a[public_asset_1.PropertyType.WarehouseApartment] = lixi_internal_request_1.ResidentialTypeList.StudioWarehouseApartment,
-    _a[public_asset_1.PropertyType.PropertyOver10_Ha] = lixi_internal_request_1.Custom3PropertyTypeNameList.PropertyOver10HA,
-    _a[public_asset_1.PropertyType.MultiDwellingSingleTitle] = lixi_internal_request_1.Custom3PropertyTypeNameList.MultiDwellingSingleTitle,
+    _a[public_asset_1.PropertyType.PropertyOver10_Ha] = lixi_internal_request_1.Custom2PropertyTypeNameList.PropertyOver10HA,
+    _a[public_asset_1.PropertyType.MultiDwellingSingleTitle] = lixi_internal_request_1.Custom2PropertyTypeNameList.MultiDwellingSingleTitle,
     _a);

package/lib/utils/is-income-type.d.ts

@@ -2,6 +2,7 @@ import { PersonApplicant } from '@lendi/integrations-protocol/lib/types/lixi-int
 import { IncomeType, Income, IncomeBusinessDetails } from '../types/events/public-income';
 export declare const descriptionOtherIncomeTypes: string[];
 export declare const PAYGList: string[];
+export declare const otherIncomeList: IncomeType[];
 /**
  * @description Is income type one of the PAYG income.
  * @param {string} incomeType Income type.
@@ -20,12 +21,18 @@ export declare function isSelfEmployedIncome(incomeType: string): boolean;
  * @returns {boolean} true if Income type is Rental Income.
  */
 export declare function isRentalIncome(incomeType: string): boolean;
+/**
+ * @description Is income type grouped as OtherIncome.
+ * @param {IncomeType} incomeType Income type.
+ * @returns {boolean} true if income is of type other income.
+ */
+export declare function isOtherIncome(incomeType: IncomeType): boolean;
 /**
  * @description Is Income type one of OtherIncome types.
  * @param {IncomeType} incomeType Income Type.
  * @returns {boolean} returns true for other income.
  */
-export declare function isOtherIncome(incomeType: string): boolean;
+export declare function isOtherIncomeWithDesc(incomeType: string): boolean;
 /**
  * @description Is Self Employed Full Doc or Low Doc Income
  * @param incomeType Income Type from Event
@@ -33,40 +40,21 @@ export declare function isOtherIncome(incomeType: string): boolean;
  */
 export declare function isFullDocOrLowDocIncome(incomeType: IncomeType): boolean;
 /**
- * @description Checks if an Income event is a valid rental income event.
- * @param {Income} income Income.
- * @returns {boolean} true if event is a valid Rental Income.
- */
-export declare function isValidRentalIncomeEvent({ assetId, type: incomeType }: Income): boolean;
-/**
- * @description Is event valid PAYG income event.
- * @param {Income} income Income.
- * @param {PersonApplicant[]} applicants An array of applicants.
- * @returns {boolean} true if Income type is a PAYG value and event is valid PAYG event.
- */
-export declare function isValidPaygIncomeEvent({ percentOwned, employmentId, type: incomeType }: Income, applicants?: PersonApplicant[]): boolean;
-/**
- * @description Checks if an Income event is a valid self-employment income event.
- * @param {Income} income Income.
- * @param {PersonApplicant[]} applicants An array of applicants.
- * @returns {boolean} Returns true if event is a valid self employment income event.
- */
-export declare function isValidSelfEmployedIncomeEvent({ percentOwned, employmentId, type: incomeType }: Income, applicants?: PersonApplicant[]): boolean;
-/**
- * @description Get the employment ids for an applicant for a specific employment type.
- * @param {PersonApplicant} applicant An applicant
- * @param {string} key Employment type key: PAYG or SelfEmployed.
- * @returns {string[]} An array of employment ids for the applicant of the specified type.
+ * Checks if there is some employment for the applicant that has the same employment id as the employment id in the income event
+ *
+ * @param {PersonApplicant} applicant - An applicant
+ * @param {string} employmentId - Employment id being searched for
+ * @returns {boolean} - Whether or not the applicant has an employment with matching employmentId
  */
-export declare function getEmploymentIds(applicant: PersonApplicant, key: 'PAYG' | 'SelfEmployed'): string[];
+export declare const hasMatchingEmploymentId: (applicant: PersonApplicant, employmentId: string) => boolean;
 /**
- * @description Get applicantId from an array of applicants given an employmentId and employmentType.
- * @param {PersonApplicant[]} applicants An array of applicants.
- * @param {string} employmentId EmploymentId
- * @param {string} key Employment type: PAYG or SelfEmployed
- * @returns {string | undefined} Returns applicantId or undefined.
+ * Gets the applicant id using the employment id
+ *
+ * @param {PersonApplicant[]} applicants - An array of applicants.
+ * @param {string} employmentId - Employment ID
+ * @returns {string | undefined} - Applicant id or undefined
  */
-export declare function getStoredApplicantId(applicants: PersonApplicant[], employmentId: string, key: 'PAYG' | 'SelfEmployed'): string | undefined;
+export declare function getApplicantIdFromEmploymentId(applicants: PersonApplicant[], employmentId: string): string | undefined;
 /**
  * @description Get an applicantId from the event or the applicants.
  * @param {Income} income Income.
@@ -78,6 +66,6 @@ export declare function getApplicantId({ percentOwned, employmentId }: Income, a
  * @description Sort Business Income By Year.
  * @param incomeA Income Details for Self Employed Full Doc.
  * @param incomeB Income Details for Self Employed Full Doc.
- * @returns {0 | - 1 | 1} Returns a number to be used for sorting income.
+ * @returns {0 | < 0 | > 0} Returns a number to be used for sorting income.
  */
-export declare function sortBusinessIncome({ year: yearA }: IncomeBusinessDetails, { year: yearB }: IncomeBusinessDetails): number;
+export declare const sortBusinessIncome: ({ year: yearA }: IncomeBusinessDetails, { year: yearB }: IncomeBusinessDetails) => number;

package/lib/utils/is-income-type.js

@@ -1,12 +1,11 @@
 "use strict";
 exports.__esModule = true;
-exports.sortBusinessIncome = exports.getApplicantId = exports.getStoredApplicantId = exports.getEmploymentIds = exports.isValidSelfEmployedIncomeEvent = exports.isValidPaygIncomeEvent = exports.isValidRentalIncomeEvent = exports.isFullDocOrLowDocIncome = exports.isOtherIncome = exports.isRentalIncome = exports.isSelfEmployedIncome = exports.isPaygIncome = exports.PAYGList = exports.descriptionOtherIncomeTypes = void 0;
+exports.sortBusinessIncome = exports.getApplicantId = exports.getApplicantIdFromEmploymentId = exports.hasMatchingEmploymentId = exports.isFullDocOrLowDocIncome = exports.isOtherIncomeWithDesc = exports.isOtherIncome = exports.isRentalIncome = exports.isSelfEmployedIncome = exports.isPaygIncome = exports.otherIncomeList = exports.PAYGList = exports.descriptionOtherIncomeTypes = void 0;
 var lodash_1 = require("lodash");
 var public_income_1 = require("../types/events/public-income");
 exports.descriptionOtherIncomeTypes = [
     public_income_1.IncomeType.InvestmentIncome,
     public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax,
-    public_income_1.IncomeType.RentalIncome,
 ];
 exports.PAYGList = [
     public_income_1.IncomeType.PaygAllowancesNotTaxed,
@@ -18,6 +17,17 @@ exports.PAYGList = [
     public_income_1.IncomeType.PaygCompanyCar,
     public_income_1.IncomeType.PaygOvertimeIncome,
 ];
+exports.otherIncomeList = [
+    public_income_1.IncomeType.ChildMaintenance,
+    public_income_1.IncomeType.ForeignIncome,
+    public_income_1.IncomeType.GovtBenefit,
+    public_income_1.IncomeType.InvestmentIncome,
+    public_income_1.IncomeType.OtherIncome,
+    public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax,
+    public_income_1.IncomeType.PaygSalarySacrifice,
+    public_income_1.IncomeType.SuperAnnuityPension,
+    public_income_1.IncomeType.WorkersCompensation,
+];
 /**
  * @description Is income type one of the PAYG income.
  * @param {string} incomeType Income type.
@@ -45,15 +55,24 @@ function isRentalIncome(incomeType) {
     return incomeType === public_income_1.IncomeType.RentalIncome;
 }
 exports.isRentalIncome = isRentalIncome;
+/**
+ * @description Is income type grouped as OtherIncome.
+ * @param {IncomeType} incomeType Income type.
+ * @returns {boolean} true if income is of type other income.
+ */
+function isOtherIncome(incomeType) {
+    return exports.otherIncomeList.includes(incomeType);
+}
+exports.isOtherIncome = isOtherIncome;
 /**
  * @description Is Income type one of OtherIncome types.
  * @param {IncomeType} incomeType Income Type.
  * @returns {boolean} returns true for other income.
  */
-function isOtherIncome(incomeType) {
+function isOtherIncomeWithDesc(incomeType) {
     return exports.descriptionOtherIncomeTypes.includes(incomeType);
 }
-exports.isOtherIncome = isOtherIncome;
+exports.isOtherIncomeWithDesc = isOtherIncomeWithDesc;
 /**
  * @description Is Self Employed Full Doc or Low Doc Income
  * @param incomeType Income Type from Event
@@ -64,76 +83,37 @@ function isFullDocOrLowDocIncome(incomeType) {
 }
 exports.isFullDocOrLowDocIncome = isFullDocOrLowDocIncome;
 /**
- * @description Checks if an Income event is a valid rental income event.
- * @param {Income} income Income.
- * @returns {boolean} true if event is a valid Rental Income.
+ * Checks if there is some employment for the applicant that has the same employment id as the employment id in the income event
+ *
+ * @param {PersonApplicant} applicant - An applicant
+ * @param {string} employmentId - Employment id being searched for
+ * @returns {boolean} - Whether or not the applicant has an employment with matching employmentId
  */
-function isValidRentalIncomeEvent(_a) {
-    var assetId = _a.assetId, incomeType = _a.type;
-    return isRentalIncome(incomeType) && !assetId;
-}
-exports.isValidRentalIncomeEvent = isValidRentalIncomeEvent;
+var hasMatchingEmploymentId = function (applicant, employmentId) {
+    return (applicant.Employment || []).some(function (employment) {
+        var id = (0, lodash_1.get)(employment, 'PAYG.@UniqueID') ||
+            (0, lodash_1.get)(employment, 'SelfEmployed.@UniqueID') ||
+            (0, lodash_1.get)(employment, 'NotEmployed.@UniqueID');
+        return id === employmentId;
+    });
+};
+exports.hasMatchingEmploymentId = hasMatchingEmploymentId;
 /**
- * @description Is event valid PAYG income event.
- * @param {Income} income Income.
- * @param {PersonApplicant[]} applicants An array of applicants.
- * @returns {boolean} true if Income type is a PAYG value and event is valid PAYG event.
+ * Gets the applicant id using the employment id
+ *
+ * @param {PersonApplicant[]} applicants - An array of applicants.
+ * @param {string} employmentId - Employment ID
+ * @returns {string | undefined} - Applicant id or undefined
  */
-function isValidPaygIncomeEvent(_a, applicants) {
-    var percentOwned = _a.percentOwned, employmentId = _a.employmentId, incomeType = _a.type;
-    if (applicants === void 0) { applicants = []; }
-    if (!isPaygIncome(incomeType))
-        return false;
-    var applicantId = (0, lodash_1.get)(percentOwned, 'owners[0].applicantId') || getStoredApplicantId(applicants, employmentId, 'PAYG');
-    if (!applicantId)
-        return false;
-    return true;
-}
-exports.isValidPaygIncomeEvent = isValidPaygIncomeEvent;
-/**
- * @description Checks if an Income event is a valid self-employment income event.
- * @param {Income} income Income.
- * @param {PersonApplicant[]} applicants An array of applicants.
- * @returns {boolean} Returns true if event is a valid self employment income event.
- */
-function isValidSelfEmployedIncomeEvent(_a, applicants) {
-    var percentOwned = _a.percentOwned, employmentId = _a.employmentId, incomeType = _a.type;
-    if (applicants === void 0) { applicants = []; }
-    if (!isSelfEmployedIncome(incomeType))
-        return false;
-    var applicantId = (0, lodash_1.get)(percentOwned, 'owners[0].applicantId') || getStoredApplicantId(applicants, employmentId, 'PAYG');
-    if (!applicantId)
-        return false;
-    return true;
-}
-exports.isValidSelfEmployedIncomeEvent = isValidSelfEmployedIncomeEvent;
-/**
- * @description Get the employment ids for an applicant for a specific employment type.
- * @param {PersonApplicant} applicant An applicant
- * @param {string} key Employment type key: PAYG or SelfEmployed.
- * @returns {string[]} An array of employment ids for the applicant of the specified type.
- */
-function getEmploymentIds(applicant, key) {
-    return (0, lodash_1.compact)(applicant.Employment.flatMap(function (employment) { return (0, lodash_1.get)(employment, "".concat(key, ".@UniqueID")); }));
-}
-exports.getEmploymentIds = getEmploymentIds;
-/**
- * @description Get applicantId from an array of applicants given an employmentId and employmentType.
- * @param {PersonApplicant[]} applicants An array of applicants.
- * @param {string} employmentId EmploymentId
- * @param {string} key Employment type: PAYG or SelfEmployed
- * @returns {string | undefined} Returns applicantId or undefined.
- */
-function getStoredApplicantId(applicants, employmentId, key) {
-    for (var _i = 0, applicants_1 = applicants; _i < applicants_1.length; _i++) {
-        var applicant = applicants_1[_i];
-        var employmentIds = getEmploymentIds(applicant, key);
-        if (employmentIds.includes(employmentId))
-            return applicant['@UniqueID'];
+function getApplicantIdFromEmploymentId(applicants, employmentId) {
+    var applicantId;
+    if (applicants && employmentId) {
+        var applicant = applicants.find(function (applicant) { return (0, exports.hasMatchingEmploymentId)(applicant, employmentId); });
+        applicantId = applicant === null || applicant === void 0 ? void 0 : applicant['@UniqueID'];
     }
-    return undefined;
+    return applicantId;
 }
-exports.getStoredApplicantId = getStoredApplicantId;
+exports.getApplicantIdFromEmploymentId = getApplicantIdFromEmploymentId;
 /**
  * @description Get an applicantId from the event or the applicants.
  * @param {Income} income Income.
@@ -143,24 +123,18 @@ exports.getStoredApplicantId = getStoredApplicantId;
 function getApplicantId(_a, applicants) {
     var percentOwned = _a.percentOwned, employmentId = _a.employmentId;
     if (applicants === void 0) { applicants = []; }
-    return ((0, lodash_1.get)(percentOwned, 'owners[0].applicantId') ||
-        getStoredApplicantId(applicants, employmentId, 'PAYG') ||
-        getStoredApplicantId(applicants, employmentId, 'SelfEmployed'));
+    return (0, lodash_1.get)(percentOwned, 'owners[0].applicantId') || getApplicantIdFromEmploymentId(applicants, employmentId);
 }
 exports.getApplicantId = getApplicantId;
 /**
  * @description Sort Business Income By Year.
  * @param incomeA Income Details for Self Employed Full Doc.
  * @param incomeB Income Details for Self Employed Full Doc.
- * @returns {0 | - 1 | 1} Returns a number to be used for sorting income.
+ * @returns {0 | < 0 | > 0} Returns a number to be used for sorting income.
  */
-function sortBusinessIncome(_a, _b) {
+var sortBusinessIncome = function (_a, _b) {
     var _c = _a.year, yearA = _c === void 0 ? 0 : _c;
     var _d = _b.year, yearB = _d === void 0 ? 0 : _d;
-    if (yearA > yearB)
-        return -1;
-    if (yearB > yearA)
-        return 1;
-    return 0;
-}
+    return yearB - yearA;
+};
 exports.sortBusinessIncome = sortBusinessIncome;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.1.1",
+  "version": "1.1.6",
   "description": "Library for kafka event data transforming",
   "author": "Integrations <integrations@lendi.com.au>",
   "homepage": "https://bitbucket.org/lendi-dev/integrations-shared-packages#readme",
@@ -21,8 +21,8 @@
     "url": "git+ssh://git@bitbucket.org/lendi-dev/integrations-shared-packages.git"
   },
   "dependencies": {
-    "@lendi/integrations-credit-protocol": "1.13.9",
-    "@lendi/integrations-protocol": "2.3.0",
+    "@lendi/integrations-credit-protocol": "1.14.7",
+    "@lendi/integrations-protocol": "2.4.9",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",
     "dd-trace": "^0.28.1",