@lendi/integrations-transform 1.6.7 → 1.7.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.7.0
+
+BREAKING CHANGES
+* Change to use `@lendi/integration-protocols@2.7.0` for better Identification fields support
+
+
 # 1.6.0
 
 BREAKING CHANGES

package/lib/schemas/public-applicant-event.json

@@ -1,7 +1,15 @@
 {
   "definitions": {
     "Payload": {
-      "$ref": "#/definitions/payload"
+      "type": "object",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/createApplicantDefinition"
+        },
+        {
+          "$ref": "#/definitions/updateApplicantDefinition"
+        }
+      ]
     },
     "id": {
       "type": "string",
@@ -21,7 +29,7 @@
       "description": "The metadata of the applicant",
       "properties": {
         "actionedBy": {
-          "description": "uuid of user who made the action (create/update/delete)",
+          "description": "uuid of user who made the action (create/update)",
           "type": "string"
         },
         "actionedByRole": {
@@ -413,30 +421,12 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
-        "buildingName": {
-          "description": "The building name",
-          "type": "string"
-        },
-        "deliveryAddress": {
-          "description": "Postal address, usually a PO Box or Locked Bag",
-          "type": "string",
-          "example": "PO Box 1"
-        },
-        "lotSection": {
-          "description": "The lot number",
-          "type": "string"
-        },
         "streetName": {
           "type": "string"
         },
         "streetNumber": {
           "type": "string"
         },
-        "streetSuffix": {
-          "description": "The street suffix",
-          "type": "string",
-          "example": "North"
-        },
         "streetType": {
           "type": "string"
         },
@@ -536,13 +526,13 @@
           "type": "string",
           "description": "applicant's mobile number formatted in +611234567890"
         },
+        "previousAddresses": {
+          "$ref": "#/definitions/previousAddresses"
+        },
         "postSettlementAddress": {
           "$ref": "#/definitions/address",
           "description": "applicant's post settlement address being captured as part of funnels 5 (post product select)"
         },
-        "previousAddresses": {
-          "$ref": "#/definitions/previousAddresses"
-        },
         "emailAddress": {
           "type": "string",
           "description": "The applicant email"
@@ -554,14 +544,18 @@
       "description": "different invitation statuses an applicant can have"
     },
     "entity": {
-      "enum": ["PERSON", "COMPANY"],
+      "enum": ["PERSON", "COMPANY", "TRUST"],
       "description": "applicant's entity. For a person applicant this is 'PERSON'"
     },
     "isFirstHomeBuyer": {
       "type": "boolean",
       "description": "Whether it's the applicants first home purchase."
     },
-    "payload": {
+    "cityOfBirth": {
+      "type": "string",
+      "example": "Sydney"
+    },
+    "createApplicantDefinition": {
       "type": "object",
       "additionalProperties": false,
       "properties": {
@@ -573,14 +567,13 @@
           "$ref": "#/definitions/id",
           "description": "uuid of application"
         },
+        "cityOfBirth": {
+          "$ref": "#/definitions/cityOfBirth"
+        },
         "customerId": {
           "$ref": "#/definitions/id",
           "description": "uuid of customer"
         },
-        "clonedFromApplicantId": {
-          "$ref": "#/definitions/id",
-          "description": "uuid of source applicant"
-        },
         "meta": {
           "$ref": "#/definitions/applicantMeta"
         },
@@ -599,6 +592,9 @@
         "guarantorRelationshipToBorrower": {
           "$ref": "#/definitions/guarantorRelationshipToBorrowerDefinition"
         },
+        "isFirstHomeBuyer": {
+          "$ref": "#/definitions/isFirstHomeBuyer"
+        },
         "isPrimaryApplicant": {
           "$ref": "#/definitions/isPrimaryApplicant"
         },
@@ -643,28 +639,95 @@
         },
         "invitationStatus": {
           "$ref": "#/definitions/invitationStatus"
+        }
+      },
+      "required": ["id", "applicationId", "customerId", "isPrimaryApplicant", "meta"],
+      "description": "create applicant payload"
+    },
+    "updateApplicantDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of applicant"
         },
-        "countryOfBirth": {
-          "$ref": "#/definitions/countries"
+        "applicationId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of application"
         },
-        "citizenship": {
-          "$ref": "#/definitions/countries"
+        "customerId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of customer"
         },
-        "mothersMaidenName": {
-          "type": "string",
-          "description": "Mothers Maiden Name"
+        "meta": {
+          "$ref": "#/definitions/applicantMeta"
         },
-        "isFirstHomeBuyer": {
-          "$ref": "#/definitions/isFirstHomeBuyer"
+        "applicantType": {
+          "$ref": "#/definitions/applicantType"
+        },
+        "creditStatus": {
+          "$ref": "#/definitions/creditStatus"
+        },
+        "employmentType": {
+          "$ref": "#/definitions/employmentType"
+        },
+        "guarantorRelationshipToBorrower": {
+          "$ref": "#/definitions/guarantorRelationshipToBorrowerDefinition"
+        },
+        "isPrimaryApplicant": {
+          "$ref": "#/definitions/isPrimaryApplicant"
+        },
+        "hasSelfEmploymentProof": {
+          "$ref": "#/definitions/hasSelfEmploymentProof"
+        },
+        "totalIncomeEstimate": {
+          "$ref": "#/definitions/totalIncomeEstimate"
+        },
+        "dateOfBirth": {
+          "$ref": "#/definitions/dateOfBirth"
+        },
+        "gender": {
+          "$ref": "#/definitions/gender"
+        },
+        "maritalStatus": {
+          "$ref": "#/definitions/maritalStatus"
+        },
+        "maritalDetails": {
+          "$ref": "#/definitions/applicantKeyObject"
+        },
+        "residencyStatus": {
+          "$ref": "#/definitions/residencyStatus"
+        },
+        "dependants": {
+          "$ref": "#/definitions/dependants"
+        },
+        "firstName": {
+          "$ref": "#/definitions/firstName"
+        },
+        "middleName": {
+          "$ref": "#/definitions/middleName"
+        },
+        "lastName": {
+          "$ref": "#/definitions/lastName"
+        },
+        "title": {
+          "$ref": "#/definitions/title"
+        },
+        "contact": {
+          "$ref": "#/definitions/contact"
+        },
+        "invitationStatus": {
+          "$ref": "#/definitions/invitationStatus"
         }
       },
-      "required": ["id", "applicationId", "customerId"],
-      "description": "create/update applicant payload"
+      "required": ["id", "applicationId", "customerId", "meta"],
+      "description": "update applicant payload. Entity shouldn't be updated."
     }
   },
   "type": "object",
   "title": "The applicant event schema",
-  "description": "Create, update or delete. UpdatePrimaryApplicant is DEPRECATED",
+  "description": "Create or update.",
   "additionalProperties": false,
   "properties": {
     "version": {

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

@@ -1,34 +1,4 @@
 import { YesNoList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-import { Contact, Dependant, Payload as ApplicantPayload } from '../types/events/public-applicant';
+import { Payload as ApplicantPayload } from '../types/events/public-applicant';
 export declare const booleanMapping: (input?: boolean) => YesNoList;
-/**
- * Transforms a partial Applicant event to a partial LIXI application.
- *
- * @param applicant: A partial applicant.
- * @param applicant
- * @returns partialApplication an incomplete application.
- */
-export declare function transformApplicant(applicant: ApplicantPayload): {};
-/**
- * Generates a LIXI contact from given contact.
- *
- * @param contact
- * @param id
- */
-export declare function generateContact(contact: Contact, id: string): {
-    lixiContact: {};
-    lixiAddresses: any[];
-};
-/**
- * Generate dependants
- *
- * @param dependants
- * @param id
- */
-export declare function generateDependants(dependants: Dependant[], id: string): {
-    '@Age': number;
-    '@UniqueID': string;
-    FinancialProvider: {
-        '@x_Party': string;
-    }[];
-}[];
+export declare function transformApplicant(applicant: ApplicantPayload): import("../types/recursive-partial").RecursivePartial<import("@lendi/integrations-protocol/lib/types/lixi-internal-request").InternalRequest>;

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

@@ -1,58 +1,73 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDependants = exports.generateContact = exports.transformApplicant = exports.booleanMapping = void 0;
-const lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
+exports.transformApplicant = exports.booleanMapping = void 0;
+const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+const lixi_internal_request_2 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
 const application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
 const lodash_1 = require("lodash");
-const address_tools_1 = require("../utils/address-tools");
 const enum_mappings_1 = require("../types/enum-mappings");
+const applicant_gender_1 = require("../types/enum-mappings/applicant-gender");
+const applicant_type_1 = require("../types/enum-mappings/applicant-type");
+const guarantor_relationship_type_1 = require("../types/enum-mappings/guarantor-relationship-type");
 const public_applicant_1 = require("../types/events/public-applicant");
+const errors_1 = require("../utils/errors");
 const normalise_date_1 = require("../utils/normalise-date");
-const booleanMapping = (input = false) => (input === true ? lixi_internal_request_1.YesNoList.Yes : lixi_internal_request_1.YesNoList.No);
+const booleanMapping = (input = false) => (input === true ? lixi_internal_request_2.YesNoList.Yes : lixi_internal_request_2.YesNoList.No);
 exports.booleanMapping = booleanMapping;
-const applicantMapping = {
-    applicationId: application_paths_1.paths.ApplicationId,
-    citizenship: `${application_paths_1.paths.PersonApplicant}.@Citizenship`,
-    contact: `${application_paths_1.paths.PersonApplicant}.Contact`,
-    dependants: 'dependants',
-    dateOfBirth: `${application_paths_1.paths.PersonApplicant}.@DateOfBirth`,
-    firstName: `${application_paths_1.paths.PersonApplicant}.PersonName.@FirstName`,
-    id: `${application_paths_1.paths.PersonApplicant}.@UniqueID`,
-    isFirstHomeBuyer: `${application_paths_1.paths.PersonApplicant}.@FirstHomeBuyer`,
-    isPrimaryApplicant: `${application_paths_1.paths.PersonApplicant}.@PrimaryApplicant`,
-    lastName: `${application_paths_1.paths.PersonApplicant}.PersonName.@Surname`,
-    maritalStatus: `${application_paths_1.paths.PersonApplicant}.@MaritalStatus`,
-    maritalDetails: `${application_paths_1.paths.PersonApplicant}.MaritalStatusDetails.@x_Spouse`,
-    middleName: `${application_paths_1.paths.PersonApplicant}.PersonName.@MiddleNames`,
-    residencyStatus: `${application_paths_1.paths.PersonApplicant}.@ResidencyStatus`,
-    title: `${application_paths_1.paths.PersonName}.@NameTitle`,
-};
-/**
- * Transforms a partial Applicant event to a partial LIXI application.
- *
- * @param applicant: A partial applicant.
- * @param applicant
- * @returns partialApplication an incomplete application.
- */
 function transformApplicant(applicant) {
     const partialApplication = {};
-    const { id: applicantId, applicationId } = applicant;
-    (0, lodash_1.set)(partialApplication, applicantMapping['isFirstHomeBuyer'], (0, exports.booleanMapping)(applicant.isFirstHomeBuyer));
-    (0, lodash_1.set)(partialApplication, applicantMapping['isPrimaryApplicant'], (0, exports.booleanMapping)(applicant.isPrimaryApplicant));
-    (0, lodash_1.set)(partialApplication, applicantMapping['title'], enum_mappings_1.titleMapping[applicant.title || public_applicant_1.Title.Unknown]);
-    const applicantUpdated = (0, lodash_1.omit)(applicant, ['isFirstHomeBuyer', 'isPrimaryApplicant', 'title']);
-    for (const [key, value] of Object.entries(applicantUpdated)) {
+    const applicantId = applicant.id; // This is how SF events cross reference applicant with its entities.
+    const applicantMapping = {
+        applicantType: `${application_paths_1.paths.PersonApplicant}.@ApplicantType`,
+        applicationId: application_paths_1.paths.ApplicationId,
+        citizenship: `${application_paths_1.paths.PersonApplicant}.@Citizenship`,
+        cityOfBirth: `${application_paths_1.paths.PersonApplicant}.@PlaceOfBirth`,
+        contact: 'contact',
+        countryOfBirth: `${application_paths_1.paths.PersonApplicant}.@CountryOfBirth`,
+        dateOfBirth: `${application_paths_1.paths.PersonApplicant}.@DateOfBirth`,
+        dependants: 'dependants',
+        email: `${application_paths_1.paths.PersonApplicant}.Contact.EmailAddress[0].@Email`,
+        firstName: `${application_paths_1.paths.PersonApplicant}.PersonName.@FirstName`,
+        id: `${application_paths_1.paths.PersonApplicant}.@UniqueID`,
+        lastName: `${application_paths_1.paths.PersonApplicant}.PersonName.@Surname`,
+        maritalDetails: `${application_paths_1.paths.PersonApplicant}.MaritalStatusDetails.@x_Spouse`,
+        maritalStatus: `${application_paths_1.paths.PersonApplicant}.@MaritalStatus`,
+        middleName: `${application_paths_1.paths.PersonApplicant}.PersonName.@MiddleNames`,
+        mothersMaidenName: `${application_paths_1.paths.PersonApplicant}.@MothersMaidenName`,
+        phone: `${application_paths_1.paths.PersonApplicant}.Contact.Mobile.@Number`,
+        residencyStatus: `${application_paths_1.paths.PersonApplicant}.@ResidencyStatus`,
+        title: `${application_paths_1.paths.PersonName}.@NameTitle`,
+    };
+    // Any applicant event need to have at least dateOfBirth, firstName and lastName.
+    if (!(applicant.dateOfBirth && applicant.firstName && applicant.lastName)) {
+        throw new errors_1.InvalidEvent('Applicant needs to have dateOfBirth, firstName and lastName');
+    }
+    // If applicant event comes without an applicantType then default it to ApplicantType.Borrower
+    if (!applicant.applicantType) {
+        applicant.applicantType = public_applicant_1.ApplicantType.Borrower;
+    }
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonName}.@NameTitle`, lixi_internal_request_1.NameTitleList.Other);
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@PrimaryApplicant`, (0, exports.booleanMapping)(applicant.isPrimaryApplicant));
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@FirstHomeBuyer`, (0, exports.booleanMapping)(applicant.isFirstHomeBuyer));
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Gender`, applicant_gender_1.applicantGenderMapping[applicant.gender]);
+    if (applicant.applicantType === public_applicant_1.ApplicantType.Guarantor) {
+        const mappedGuarantorRelationship = applicant.guarantorRelationshipToBorrower
+            ? guarantor_relationship_type_1.guarantorRelationshipTypeMappings[applicant.guarantorRelationshipToBorrower.type]
+            : lixi_internal_request_1.KinRelationshipList.OtherRelative;
+        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@RelationshipToPrimaryApplicant`, mappedGuarantorRelationship);
+    }
+    for (const [key, value] of Object.entries(applicant)) {
         if (applicantMapping[key]) {
             switch (key) {
+                case 'applicantType':
+                    (0, lodash_1.set)(partialApplication, applicantMapping[key], applicant_type_1.applicantTypeMapping[value]);
+                    break;
                 case 'dateOfBirth':
                     (0, lodash_1.set)(partialApplication, applicantMapping[key], (0, normalise_date_1.normaliseDate)(value));
                     break;
                 case 'maritalStatus':
                     (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.maritalStatusMapping[value]);
                     break;
-                case 'citizenship':
-                    (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.countryCodeMapping[value]);
-                    break;
                 case 'residencyStatus':
                     (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.residencyStatusMapping[value]);
                     // Certain bank integrations require the ability to differentiate between permanentResident and Citizen
@@ -61,24 +76,44 @@ function transformApplicant(applicant) {
                     // If citizen this field will be always added and value will be AU.
                     // @tsilva 21/11/19
                     if (value === public_applicant_1.ResidencyStatus.AustralianCitizen) {
-                        (0, lodash_1.set)(partialApplication, applicantMapping.citizenship, lixi_internal_request_1.CountryCodeList.Au);
+                        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Citizenship`, lixi_internal_request_2.CountryCodeList.Au);
                     }
                     break;
+                case 'countryOfBirth':
+                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@CountryOfBirth`, enum_mappings_1.countryCodeMapping[value]);
+                    break;
+                case 'citizenship':
+                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Citizenship`, enum_mappings_1.countryCodeMapping[value]);
+                    break;
+                case 'title':
+                    (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.titleMapping[value]);
+                    break;
                 case 'maritalDetails':
                     const id = (0, lodash_1.get)(value, 'applicantId');
                     if (id)
                         (0, lodash_1.set)(partialApplication, applicantMapping[key], id);
                     break;
                 case 'contact':
-                    const { lixiContact, lixiAddresses } = generateContact(value, applicantId);
-                    (0, lodash_1.set)(partialApplication, applicantMapping[key], lixiContact);
-                    if (lixiAddresses.length > 0) {
-                        (0, lodash_1.set)(partialApplication, application_paths_1.paths.Addresses, lixiAddresses);
+                    const emailAddress = (0, lodash_1.get)(value, 'emailAddress');
+                    const mobileNumber = (0, lodash_1.get)(value, 'mobileNumber');
+                    if (emailAddress) {
+                        (0, lodash_1.set)(partialApplication, applicantMapping.email, emailAddress);
+                    }
+                    if (mobileNumber) {
+                        (0, lodash_1.set)(partialApplication, applicantMapping.phone, mobileNumber.replace('+61', '0'));
                     }
                     break;
                 case 'dependants':
-                    const dependants = generateDependants(value, applicantId);
-                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Household}.@UniqueID`, `${applicationId}-household`);
+                    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Household}.@UniqueID`, `${applicant.applicationId}-household`);
+                    const dependants = value.map((dependant) => ({
+                        '@Age': dependant.age,
+                        '@UniqueID': dependant.id,
+                        FinancialProvider: [
+                            {
+                                '@x_Party': applicantId,
+                            },
+                        ],
+                    }));
                     (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Household}.Dependant`, dependants);
                     break;
                 default:
@@ -90,91 +125,3 @@ function transformApplicant(applicant) {
     return partialApplication;
 }
 exports.transformApplicant = transformApplicant;
-const contactMapping = {
-    emailAddress: 'EmailAddress.0.@Email',
-    mobileNumber: 'Mobile.@Number',
-    currentAddress: 'CurrentAddress',
-    previousAddresses: 'PreviousAddress',
-    priorAddress: 'PriorAddress',
-    mailingAddress: 'CurrentAddress.@x_MailingAddress',
-    postSettlementAddress: 'PostSettlementAddress',
-};
-/**
- * Generates a LIXI contact from given contact.
- *
- * @param contact
- * @param id
- */
-function generateContact(contact, id) {
-    const lixiContact = {};
-    const lixiAddresses = [];
-    for (const [key, value] of Object.entries(contact)) {
-        if (contactMapping[key]) {
-            switch (key) {
-                case 'currentAddress':
-                    {
-                        const addressId = `${id}-current`;
-                        const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)(value, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], lixiContactAddress);
-                    }
-                    break;
-                case 'postSettlementAddress':
-                    {
-                        const addressId = `${id}-postSettlement`;
-                        const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)({ residentialAddress: value }, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], lixiContactAddress);
-                    }
-                    break;
-                case 'mailingAddress':
-                    {
-                        const addressId = `${id}-mailing`;
-                        const { lixiAddress } = (0, address_tools_1.rebuildAddress)({ residentialAddress: value }, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], addressId);
-                    }
-                    break;
-                case 'previousAddresses':
-                    {
-                        const addressId = `${id}-previous`;
-                        const previousAddresses = value.sort((lhs, rhs) => lhs.endDate.localeCompare(rhs.endDate));
-                        const previousAddress = previousAddresses.pop();
-                        const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)(previousAddress, addressId);
-                        lixiAddresses.push(lixiAddress);
-                        (0, lodash_1.set)(lixiContact, contactMapping[key], lixiContactAddress);
-                        // PriorAddresses
-                        previousAddresses.forEach((address, index) => {
-                            const { lixiAddress, lixiContactAddress } = (0, address_tools_1.rebuildAddress)(address, `${id}-prior-${index}`);
-                            lixiAddresses.push(lixiAddress);
-                            (0, lodash_1.set)(lixiContact, `${contactMapping['priorAddress']}.${index}`, lixiContactAddress);
-                        });
-                    }
-                    break;
-                default:
-                    (0, lodash_1.set)(lixiContact, contactMapping[key], value);
-                    break;
-            }
-        }
-    }
-    return { lixiContact, lixiAddresses };
-}
-exports.generateContact = generateContact;
-/**
- * Generate dependants
- *
- * @param dependants
- * @param id
- */
-function generateDependants(dependants, id) {
-    return dependants.map((dependant) => ({
-        '@Age': dependant.age,
-        '@UniqueID': dependant.id,
-        FinancialProvider: [
-            {
-                '@x_Party': id,
-            },
-        ],
-    }));
-}
-exports.generateDependants = generateDependants;

package/lib/types/enum-mappings/applicant-gender.d.ts

@@ -0,0 +1,6 @@
+import { Gender } from '../events/public-applicant';
+import { GenderList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+export declare type ApplicantGenderMapping = {
+    [key in Gender]: GenderList;
+};
+export declare const applicantGenderMapping: ApplicantGenderMapping;

package/lib/types/enum-mappings/applicant-gender.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applicantGenderMapping = void 0;
+const public_applicant_1 = require("../events/public-applicant");
+const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+exports.applicantGenderMapping = {
+    [public_applicant_1.Gender.Female]: lixi_internal_request_1.GenderList.Female,
+    [public_applicant_1.Gender.Male]: lixi_internal_request_1.GenderList.Male,
+    [public_applicant_1.Gender.Undisclosed]: lixi_internal_request_1.GenderList.Undisclosed,
+    [public_applicant_1.Gender.Unknown]: lixi_internal_request_1.GenderList.Undisclosed,
+};

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

@@ -0,0 +1,6 @@
+import { ApplicantTypeList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { ApplicantType } from '../events/public-applicant';
+export declare type ApplicantTypeMapping = {
+    [key in ApplicantType]: ApplicantTypeList;
+};
+export declare const applicantTypeMapping: ApplicantTypeMapping;

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applicantTypeMapping = void 0;
+const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+const public_applicant_1 = require("../events/public-applicant");
+exports.applicantTypeMapping = {
+    [public_applicant_1.ApplicantType.Borrower]: lixi_internal_request_1.ApplicantTypeList.Borrower,
+    [public_applicant_1.ApplicantType.BorrowerAndGuarantor]: lixi_internal_request_1.ApplicantTypeList.BorrowerAndGuarantor,
+    [public_applicant_1.ApplicantType.Guarantor]: lixi_internal_request_1.ApplicantTypeList.Guarantor,
+};

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

@@ -1,5 +1,5 @@
 /**
- * Create, update or delete. UpdatePrimaryApplicant is DEPRECATED
+ * Create or update.
  */
 export interface PublicApplicant {
     payload: Payload;
@@ -10,7 +10,9 @@ export interface PublicApplicant {
     version: string;
 }
 /**
- * create/update applicant payload
+ * create applicant payload
+ *
+ * update applicant payload. Entity shouldn't be updated.
  */
 export interface Payload {
     applicantType?: ApplicantType;
@@ -18,13 +20,8 @@ export interface Payload {
      * uuid of application
      */
     applicationId: string;
-    citizenship?: Countries;
-    /**
-     * uuid of source applicant
-     */
-    clonedFromApplicantId?: string;
+    cityOfBirth?: string;
     contact?: Contact;
-    countryOfBirth?: Countries;
     creditStatus?: CreditStatus;
     /**
      * uuid of customer
@@ -48,12 +45,8 @@ export interface Payload {
     lastName?: string;
     maritalDetails?: ApplicantKeyObject;
     maritalStatus?: MaritalStatus;
-    meta?: ApplicantMeta;
+    meta: ApplicantMeta;
     middleName?: string;
-    /**
-     * Mothers Maiden Name
-     */
-    mothersMaidenName?: string;
     residencyStatus?: ResidencyStatus;
     title?: Title;
     totalIncomeEstimate?: number;
@@ -63,6 +56,57 @@ export declare enum ApplicantType {
     BorrowerAndGuarantor = "BORROWER_AND_GUARANTOR",
     Guarantor = "GUARANTOR"
 }
+export interface Contact {
+    currentAddress?: CommonAddressProperties;
+    /**
+     * The applicant email
+     */
+    emailAddress?: string;
+    /**
+     * applicant's mailing address being captured as part of funnels 5 (post product select)
+     */
+    mailingAddress?: Address;
+    /**
+     * applicant's mobile number formatted in +611234567890
+     */
+    mobileNumber?: string;
+    /**
+     * applicant's post settlement address being captured as part of funnels 5 (post product
+     * select)
+     */
+    postSettlementAddress?: Address;
+    previousAddresses?: PreviousAddress[];
+}
+export interface CommonAddressProperties {
+    externalId?: string;
+    housingStatus?: HousingStatusList;
+    residentialAddress?: Address;
+    startDate?: string;
+}
+export declare enum HousingStatusList {
+    Boarding = "Boarding",
+    Caravan = "Caravan",
+    Other = "Other",
+    OwnHome = "Own Home",
+    OwnHomeMortgage = "Own Home Mortgage",
+    Renting = "Renting",
+    SuppliedByEmployer = "Supplied by Employer",
+    WithParents = "With Parents"
+}
+/**
+ * applicant's mailing address being captured as part of funnels 5 (post product select)
+ *
+ * applicant's post settlement address being captured as part of funnels 5 (post product
+ * select)
+ */
+export interface Address {
+    city?: string;
+    country?: Countries;
+    formatted?: string;
+    postcode?: string;
+    standard?: AddressStandard;
+    state?: string;
+}
 export declare enum Countries {
     Afghanistan = "Afghanistan",
     Albania = "Albania",
@@ -304,77 +348,10 @@ export declare enum Countries {
     Zambia = "Zambia",
     Zimbabwe = "Zimbabwe"
 }
-export interface Contact {
-    currentAddress?: CommonAddressProperties;
-    /**
-     * The applicant email
-     */
-    emailAddress?: string;
-    /**
-     * applicant's mailing address being captured as part of funnels 5 (post product select)
-     */
-    mailingAddress?: Address;
-    /**
-     * applicant's mobile number formatted in +611234567890
-     */
-    mobileNumber?: string;
-    /**
-     * applicant's post settlement address being captured as part of funnels 5 (post product
-     * select)
-     */
-    postSettlementAddress?: Address;
-    previousAddresses?: PreviousAddress[];
-}
-export interface CommonAddressProperties {
-    externalId?: string;
-    housingStatus?: HousingStatusList;
-    residentialAddress?: Address;
-    startDate?: string;
-}
-export declare enum HousingStatusList {
-    Boarding = "Boarding",
-    Caravan = "Caravan",
-    Other = "Other",
-    OwnHome = "Own Home",
-    OwnHomeMortgage = "Own Home Mortgage",
-    Renting = "Renting",
-    SuppliedByEmployer = "Supplied by Employer",
-    WithParents = "With Parents"
-}
-/**
- * applicant's mailing address being captured as part of funnels 5 (post product select)
- *
- * applicant's post settlement address being captured as part of funnels 5 (post product
- * select)
- */
-export interface Address {
-    city?: string;
-    country?: Countries;
-    formatted?: string;
-    postcode?: string;
-    standard?: AddressStandard;
-    state?: string;
-}
 export interface AddressStandard {
-    /**
-     * The building name
-     */
-    buildingName?: string;
-    /**
-     * Postal address, usually a PO Box or Locked Bag
-     */
-    deliveryAddress?: string;
     level?: string;
-    /**
-     * The lot number
-     */
-    lotSection?: string;
     streetName?: string;
     streetNumber?: string;
-    /**
-     * The street suffix
-     */
-    streetSuffix?: string;
     streetType?: string;
     unit?: string;
 }
@@ -422,7 +399,8 @@ export declare enum EmploymentType {
  */
 export declare enum Entity {
     Company = "COMPANY",
-    Person = "PERSON"
+    Person = "PERSON",
+    Trust = "TRUST"
 }
 export declare enum Gender {
     Female = "FEMALE",
@@ -470,7 +448,7 @@ export declare enum MaritalStatus {
  */
 export interface ApplicantMeta {
     /**
-     * uuid of user who made the action (create/update/delete)
+     * uuid of user who made the action (create/update)
      */
     actionedBy: string;
     /**

package/lib/types/events/public-applicant.js

@@ -1,12 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Type = exports.Title = exports.ResidencyStatus = exports.ActionedByRole = exports.MaritalStatus = exports.InvitationStatus = exports.GuarantorRelationshipToBorrowerType = exports.Gender = exports.Entity = exports.EmploymentType = exports.CreditStatus = exports.HousingStatusList = exports.Countries = exports.ApplicantType = void 0;
+exports.Type = exports.Title = exports.ResidencyStatus = exports.ActionedByRole = exports.MaritalStatus = exports.InvitationStatus = exports.GuarantorRelationshipToBorrowerType = exports.Gender = exports.Entity = exports.EmploymentType = exports.CreditStatus = exports.Countries = exports.HousingStatusList = exports.ApplicantType = void 0;
 var ApplicantType;
 (function (ApplicantType) {
     ApplicantType["Borrower"] = "BORROWER";
     ApplicantType["BorrowerAndGuarantor"] = "BORROWER_AND_GUARANTOR";
     ApplicantType["Guarantor"] = "GUARANTOR";
 })(ApplicantType = exports.ApplicantType || (exports.ApplicantType = {}));
+var HousingStatusList;
+(function (HousingStatusList) {
+    HousingStatusList["Boarding"] = "Boarding";
+    HousingStatusList["Caravan"] = "Caravan";
+    HousingStatusList["Other"] = "Other";
+    HousingStatusList["OwnHome"] = "Own Home";
+    HousingStatusList["OwnHomeMortgage"] = "Own Home Mortgage";
+    HousingStatusList["Renting"] = "Renting";
+    HousingStatusList["SuppliedByEmployer"] = "Supplied by Employer";
+    HousingStatusList["WithParents"] = "With Parents";
+})(HousingStatusList = exports.HousingStatusList || (exports.HousingStatusList = {}));
 var Countries;
 (function (Countries) {
     Countries["Afghanistan"] = "Afghanistan";
@@ -249,17 +260,6 @@ var Countries;
     Countries["Zambia"] = "Zambia";
     Countries["Zimbabwe"] = "Zimbabwe";
 })(Countries = exports.Countries || (exports.Countries = {}));
-var HousingStatusList;
-(function (HousingStatusList) {
-    HousingStatusList["Boarding"] = "Boarding";
-    HousingStatusList["Caravan"] = "Caravan";
-    HousingStatusList["Other"] = "Other";
-    HousingStatusList["OwnHome"] = "Own Home";
-    HousingStatusList["OwnHomeMortgage"] = "Own Home Mortgage";
-    HousingStatusList["Renting"] = "Renting";
-    HousingStatusList["SuppliedByEmployer"] = "Supplied by Employer";
-    HousingStatusList["WithParents"] = "With Parents";
-})(HousingStatusList = exports.HousingStatusList || (exports.HousingStatusList = {}));
 /**
  * current credit status of the applicant (Customer declared value)
  */
@@ -286,6 +286,7 @@ var Entity;
 (function (Entity) {
     Entity["Company"] = "COMPANY";
     Entity["Person"] = "PERSON";
+    Entity["Trust"] = "TRUST";
 })(Entity = exports.Entity || (exports.Entity = {}));
 var Gender;
 (function (Gender) {

package/lib/utils/errors.d.ts

@@ -0,0 +1,28 @@
+export declare enum ErrorType {
+    ApplicationNotFound = "ApplicationNotFound",
+    BaseError = "BaseError",
+    DatabaseConditionalWriteError = "DatabaseConditionalWriteError",
+    DatabaseError = "DatabaseError",
+    Errors = "Errors",
+    InternalError = "InternalError",
+    InvalidApplication = "InvalidApplication",
+    InvalidEvent = "InvalidEvent",
+    InvalidEventNoApplicationId = "InvalidEventNoApplicationId",
+    InvalidEventNotCritical = "InvalidEventNotCritical",
+    OwnershipOutOfBounds = "OwnershipOutOfBounds",
+    ResourceNotFound = "ResourceNotFound"
+}
+export declare class BaseError extends Error {
+    origin: string;
+    path: string[];
+    type: ErrorType;
+    context: object;
+    constructor(message: string, path: string[], origin: string, context?: object);
+}
+/**
+ * InvalidEvent occurs when an incorrect/damaged event has been consumed and
+ * found to be invalid against its related schema.
+ */
+export declare class InvalidEvent extends BaseError {
+    constructor(message: string, path?: string[], origin?: string, context?: object);
+}

package/lib/utils/errors.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidEvent = exports.BaseError = exports.ErrorType = void 0;
+var ErrorType;
+(function (ErrorType) {
+    ErrorType["ApplicationNotFound"] = "ApplicationNotFound";
+    ErrorType["BaseError"] = "BaseError";
+    ErrorType["DatabaseConditionalWriteError"] = "DatabaseConditionalWriteError";
+    ErrorType["DatabaseError"] = "DatabaseError";
+    ErrorType["Errors"] = "Errors";
+    ErrorType["InternalError"] = "InternalError";
+    ErrorType["InvalidApplication"] = "InvalidApplication";
+    ErrorType["InvalidEvent"] = "InvalidEvent";
+    ErrorType["InvalidEventNoApplicationId"] = "InvalidEventNoApplicationId";
+    ErrorType["InvalidEventNotCritical"] = "InvalidEventNotCritical";
+    ErrorType["OwnershipOutOfBounds"] = "OwnershipOutOfBounds";
+    ErrorType["ResourceNotFound"] = "ResourceNotFound";
+})(ErrorType = exports.ErrorType || (exports.ErrorType = {}));
+class BaseError extends Error {
+    /* istanbul ignore next */
+    constructor(message, path = [], origin, context = {}) {
+        super(message);
+        Object.setPrototypeOf(this, BaseError.prototype);
+        this.type = ErrorType.BaseError;
+        this.path = path;
+        this.origin = origin;
+        this.context = context;
+    }
+}
+exports.BaseError = BaseError;
+/**
+ * InvalidEvent occurs when an incorrect/damaged event has been consumed and
+ * found to be invalid against its related schema.
+ */
+class InvalidEvent extends BaseError {
+    /* istanbul ignore next */
+    constructor(message, path, origin, context) {
+        super(message, path, origin, context);
+        Object.setPrototypeOf(this, InvalidEvent.prototype);
+        this.type = ErrorType.InvalidEvent;
+    }
+}
+exports.InvalidEvent = InvalidEvent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.6.7",
+  "version": "1.7.0",
   "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.17.5",
-    "@lendi/integrations-protocol": "^2.6.7",
+    "@lendi/integrations-credit-protocol": "^1.18.0",
+    "@lendi/integrations-protocol": "2.7.0",
     "@lendi/logging": "^1.0.0",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",