@lendi/act-credit-decisions-transform 2.0.15 → 2.0.16

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

@@ -3,6 +3,7 @@ import { Payload } from '../types/events/public-employment';
  * Generates a partial application from a employment event.
  *
  * @param employment a employment event payload.
+ * @param isSelfEmployed
  * @returns partialApplication an incomplete application.
  */
 export declare function transformEmployment(employment: Payload, isSelfEmployed: boolean): {};

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

@@ -11,6 +11,7 @@ const enum_mappings_1 = require("../types/enum-mappings");
  * Generates a partial application from a employment event.
  *
  * @param employment a employment event payload.
+ * @param isSelfEmployed
  * @returns partialApplication an incomplete application.
  */
 function transformEmployment(employment, isSelfEmployed) {
@@ -32,6 +33,9 @@ function transformEmployment(employment, isSelfEmployed) {
             break;
         case public_employment_1.EmploymentType.SelfEmployed:
             employmentPath = application_paths_1.paths.SelfEmployed;
+            /**
+             * @todo This is wrong but does not harm anything coz right now we dont call this function with `isSelfEmployed`
+             */
             if (companyId && isSelfEmployed) {
                 (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.CompanyApplicant}.@UniqueID`, companyId);
                 (0, lodash_1.set)(partialApplication, `${employmentPath}.@x_Employer`, companyId);

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

@@ -17,6 +17,7 @@ export declare function getIncomeMapping(incomeType: IncomeType): Record<string,
  *
  * @param payload a partial income event.
  * @param applicantId PersonApplicant uniqueId on the application.
+ * @param storedApplication The stored application version, to retrieve the applicant id when processing SelfEmployed Income
  * @returns partialApplication an incomplete application.
  */
 export declare function transformIncome(payload: IncomePayload, applicantId?: string): PartialApplication;
@@ -32,6 +33,9 @@ export interface SelfEmploymentIncomeMapping {
     year: string;
     companyProfitBeforeTax: string;
     addback: Record<string, string>;
+    /**
+     * @todo to map this field, currently no field in SelfEmployed to map this field to
+     */
     nonRecurringIncome: string;
 }
 /**

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

@@ -76,16 +76,21 @@ function getIncomeMapping(incomeType) {
     if ((0, is_income_type_1.isFullDocOrLowDocIncome)(incomeType)) {
         basePath = application_paths_1.paths.SelfEmployed;
         return {
+            // Low Doc and Full Doc common fields
+            companyId: `${basePath}.@x_Employer`,
+            gross: `${basePath}.DeclaredIncome.@IncomeAmount`,
+            // Full Doc
+            incomes: `${basePath}.BusinessIncome`,
             /**
-             * @todo ACT1-758 map this income correctly for Full Doc and Low Doc
+             * @todo To map bas correctly. Currently there is no way to map bas to SelfEmployed
              */
-            bas: `${basePath}.Income[0].BusinessActivityStatement`,
-            incomes: `${basePath}.Income`,
-            // companyId: `${basePath}.@UniqueID`,
+            // bas: `${basePath}.Income[0].BusinessActivityStatement`,
             //
-            gross: `${basePath}.DeclaredIncome.@IncomeAmount`,
         };
     }
+    /**
+     * @deprecated This is legacy version and shall not be used
+     */
     if ((0, is_income_type_1.isSelfEmployedIncome)(incomeType)) {
         basePath = application_paths_1.paths.SelfEmployed;
         const { amount } = exports.EmploymentIncomeTypeMapping[incomeType];
@@ -113,9 +118,10 @@ exports.getIncomeMapping = getIncomeMapping;
  *
  * @param payload a partial income event.
  * @param applicantId PersonApplicant uniqueId on the application.
+ * @param storedApplication The stored application version, to retrieve the applicant id when processing SelfEmployed Income
  * @returns partialApplication an incomplete application.
  */
-function transformIncome(payload, applicantId) {
+function transformIncome(payload, applicantId = undefined) {
     const { applicationId, id, income } = payload;
     const { amount: incomeAmount, type: incomeType, frequency: incomeFrequency } = income;
     const partialApplication = {};
@@ -179,6 +185,9 @@ function transformIncome(payload, applicantId) {
             }
         }
     }
+    if ((0, is_income_type_1.isFullDocOrLowDocIncome)(incomeType)) {
+        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@UniqueID`, applicantId);
+    }
     return partialApplication;
 }
 exports.transformIncome = transformIncome;
@@ -209,7 +218,7 @@ function createRentalIncome(amount, frequency, ownership = []) {
 exports.createRentalIncome = createRentalIncome;
 const selfEmploymentIncomeMapping = {
     year: '@StartDate',
-    companyProfitBeforeTax: '@CompanyProfitBeforeTax',
+    companyProfitBeforeTax: '@ProfitBeforeTax',
     addback: {
         depreciation: 'Addback.@Depreciation',
         interest: 'Addback.@Interest',
@@ -219,6 +228,10 @@ const selfEmploymentIncomeMapping = {
         salary: 'Addback.@Salary',
         superannuationExcess: 'Addback.@SuperannuationExcess',
     },
+    /**
+     * @todo to map this field, currently no field in SelfEmployed to map this field to
+     * Due to some limitation, leave this field here which will map the data wrongly but eventually will be removed by the validator
+     */
     nonRecurringIncome: 'NonRecurringIncome[0].@Amount',
 };
 /**

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

@@ -18,6 +18,9 @@ export interface Income {
     bas?: BASDefinition[];
     benefitType?: BenefitType;
     comments?: string;
+    /**
+     * SelfEmployed
+     */
     companyId?: string;
     description?: string;
     /**

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

@@ -43,25 +43,28 @@ export declare function isFullDocOrLowDocIncome(incomeType: IncomeType): boolean
  * 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
+ * @param {string} lookupId - Could be EmploymentId or x_EmployerId
+ * @param lookupField
  * @returns {boolean} - Whether or not the applicant has an employment with matching employmentId
  */
-export declare const hasMatchingEmploymentId: (applicant: PersonApplicant, employmentId: string) => boolean;
+export declare const hasMatchingEmployment: (lookupField: string) => (applicant: PersonApplicant, lookupId: string) => boolean;
 /**
  * Gets the applicant id using the employment id
  *
  * @param {PersonApplicant[]} applicants - An array of applicants.
  * @param {string} employmentId - Employment ID
+ * @param lookupId
+ * @param lookupField
  * @returns {string | undefined} - Applicant id or undefined
  */
-export declare function getApplicantIdFromEmploymentId(applicants: PersonApplicant[], employmentId: string): string | undefined;
+export declare function getApplicantIdFromEmployment(applicants: PersonApplicant[], lookupId: string, lookupField: string): string | undefined;
 /**
  * @description Get an applicantId from the event or the applicants.
  * @param {Income} income Income.
  * @param {PersonApplicant[]} applicants An array of LIXI applicants.
  * @returns {string | undefined} An applicantId or undefined.
  */
-export declare function getApplicantId({ percentOwned, employmentId }: Income, applicants?: PersonApplicant[]): string | undefined;
+export declare function getApplicantId({ percentOwned, employmentId, companyId }: Income, applicants?: PersonApplicant[]): string | undefined;
 /**
  * @description Sort Business Income By Year.
  * @param incomeA Income Details for Self Employed Full Doc.

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.sortBusinessIncome = exports.getApplicantId = exports.getApplicantIdFromEmployment = exports.hasMatchingEmployment = exports.isFullDocOrLowDocIncome = exports.isOtherIncomeWithDesc = exports.isOtherIncome = exports.isRentalIncome = exports.isSelfEmployedIncome = exports.isPaygIncome = exports.otherIncomeList = exports.PAYGList = exports.descriptionOtherIncomeTypes = void 0;
 const lodash_1 = require("lodash");
 const public_income_1 = require("../types/events/public-income");
 exports.descriptionOtherIncomeTypes = [
@@ -86,40 +86,47 @@ exports.isFullDocOrLowDocIncome = isFullDocOrLowDocIncome;
  * 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
+ * @param {string} lookupId - Could be EmploymentId or x_EmployerId
+ * @param lookupField
  * @returns {boolean} - Whether or not the applicant has an employment with matching employmentId
  */
-const hasMatchingEmploymentId = (applicant, employmentId) => (applicant.Employment || []).some((employment) => {
-    const 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;
+const hasMatchingEmployment = (lookupField) => (applicant, lookupId) => (applicant.Employment || []).some((employment) => {
+    const id = (0, lodash_1.get)(employment, `PAYG.${lookupField}`) ||
+        (0, lodash_1.get)(employment, `SelfEmployed.${lookupField}`) ||
+        (0, lodash_1.get)(employment, `NotEmployed.${lookupField}`);
+    return id === lookupId;
 });
-exports.hasMatchingEmploymentId = hasMatchingEmploymentId;
+exports.hasMatchingEmployment = hasMatchingEmployment;
 /**
  * Gets the applicant id using the employment id
  *
  * @param {PersonApplicant[]} applicants - An array of applicants.
  * @param {string} employmentId - Employment ID
+ * @param lookupId
+ * @param lookupField
  * @returns {string | undefined} - Applicant id or undefined
  */
-function getApplicantIdFromEmploymentId(applicants, employmentId) {
+function getApplicantIdFromEmployment(applicants, lookupId, lookupField) {
     let applicantId;
-    if (applicants && employmentId) {
-        const applicant = applicants.find((applicant) => (0, exports.hasMatchingEmploymentId)(applicant, employmentId));
+    if (applicants && lookupId) {
+        const applicant = applicants.find((applicant) => (0, exports.hasMatchingEmployment)(lookupField)(applicant, lookupId));
         applicantId = applicant === null || applicant === void 0 ? void 0 : applicant['@UniqueID'];
     }
     return applicantId;
 }
-exports.getApplicantIdFromEmploymentId = getApplicantIdFromEmploymentId;
+exports.getApplicantIdFromEmployment = getApplicantIdFromEmployment;
 /**
  * @description Get an applicantId from the event or the applicants.
  * @param {Income} income Income.
  * @param {PersonApplicant[]} applicants An array of LIXI applicants.
  * @returns {string | undefined} An applicantId or undefined.
  */
-function getApplicantId({ percentOwned, employmentId }, applicants = []) {
-    return (0, lodash_1.get)(percentOwned, 'owners[0].applicantId') || getApplicantIdFromEmploymentId(applicants, employmentId);
+function getApplicantId({ percentOwned, employmentId, companyId }, applicants = []) {
+    return ((0, lodash_1.get)(percentOwned, 'owners[0].applicantId') ||
+        // for company applicant
+        getApplicantIdFromEmployment(applicants, employmentId, '@UniqueID') ||
+        // for selfemployed
+        getApplicantIdFromEmployment(applicants, companyId, '@x_Employer'));
 }
 exports.getApplicantId = getApplicantId;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/act-credit-decisions-transform",
-  "version": "2.0.15",
+  "version": "2.0.16",
   "description": "Library for kafka event data transforming",
   "author": "Integrations <integrations@lendi.com.au>",
   "homepage": "https://bitbucket.org/lendi-dev/integrations-shared-packages#readme",
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "@lendi/integrations-credit-protocol": "1.18.8",
-    "@lendi/act-eac-integrations-protocol": "3.1.4",
+    "@lendi/act-eac-integrations-protocol": "3.1.6",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",
     "lodash": "^4.17.15"

package/CHANGELOG.md

@@ -1,64 +0,0 @@
-# 1.9.0
-
-Changes
-
-- Clone from https://bitbucket.org/lendi-dev/integrations-shared-packages/commits/f1ac57093b49cc53f872cb3986d006ad90d49b10
-
-# 1.8.6
-
-Changes
-
-- Update `merge-application` to merge the company applicant directors
-
-# 1.8.5
-
-Changes
-
-- Update `transfrom-funding-position` to set pledge amount on application if it exists in property
-
-# 1.8.4
-
-Changes
-
-- Update `applicant-event` to include SIMPLE_OR_BARE trust type and update mapping in transform
-
-# 1.8.3
-
-Changes
-
-- Update `@lendi/transform-events` to support company applicant mappings
-
-# 1.8.2
-
-Changes
-
-- Use `@lendi/integrations-protocol@2.7.4`
-
-# 1.8.1
-
-Changes
-
-- Update `transformApplicationWorkflow` to support `applicationStatus`
-- Use `@lendi/integrations-protocol@2.7.2`
-
-# 1.7.3
-
-Fix
-
-- Remove some unnecessary `additionalProperties` from event schema to void AJV warning msg
-
-# 1.7.0
-
-BREAKING CHANGES
-
-- Change to use `@lendi/integration-protocols@2.7.0` for better Identification fields support
-
-# 1.6.0
-
-BREAKING CHANGES
-
-- Change to module `commonjs` to make it compatible with existing codebase
-
-Changes
-
-- Upgrade `@lendi/integrations-protocol` to `v2.6.4`