@lendi/integrations-transform 1.1.2 → 1.1.3

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

@@ -1,13 +1,13 @@
+import { IncomeElement } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
 import { RentalIncome } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-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';
+import { PartialApplication } from '../types/partial-application';
 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.
  *
@@ -15,7 +15,7 @@ export declare function getIncomeMapping(incomeType: IncomeType, basePath?: stri
  * @param storedApplication: Current state of 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,6 @@ 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;

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

@@ -14,15 +14,15 @@ var _a;
 exports.__esModule = true;
 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.
@@ -60,15 +60,17 @@ exports.EmploymentIncomeTypeMapping = (_a = {},
         frequency: 'Income.@GrossRegularOvertimeFrequency'
     },
     _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 {
             companyId: "".concat(basePath, ".@UniqueID"),
             incomes: "".concat(basePath, ".IncomeRecent"),
@@ -78,6 +80,7 @@ function getIncomeMapping(incomeType, basePath) {
         };
     }
     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;
         var mapping = {
             amount: "".concat(basePath, ".").concat(amount),
@@ -104,33 +107,18 @@ exports.getIncomeMapping = getIncomeMapping;
  * @param storedApplication: Current state of 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.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]) {
@@ -155,7 +143,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);
                         }
@@ -224,7 +212,7 @@ 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 = {};

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,38 +21,24 @@ 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
  * @returns {boolean} True if either Full Doc or Low Doc Self Employed Income.
  */
 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 income type is RENTAL_INCOME and an assetId exists.
- */
-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

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.getStoredApplicantId = exports.getEmploymentIds = 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
@@ -63,50 +82,6 @@ function isFullDocOrLowDocIncome(incomeType) {
     return [public_income_1.IncomeType.SelfEmployedBusinessIncomeFullDoc, public_income_1.IncomeType.SelfEmployedBusinessIncomeLowDoc].includes(incomeType);
 }
 exports.isFullDocOrLowDocIncome = isFullDocOrLowDocIncome;
-/**
- * @description Checks if an Income event is a valid rental income event.
- * @param {Income} income Income.
- * @returns {boolean} true if income type is RENTAL_INCOME and an assetId exists.
- */
-function isValidRentalIncomeEvent(_a) {
-    var assetId = _a.assetId, incomeType = _a.type;
-    return isRentalIncome(incomeType) && !!assetId;
-}
-exports.isValidRentalIncomeEvent = isValidRentalIncomeEvent;
-/**
- * @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.
- */
-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 (!isFullDocOrLowDocIncome(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

package/package.json

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