@lendi/integrations-transform 1.2.0 → 1.2.4

package/lib/types/enum-mappings/to-be-used-as-security.d.ts

@@ -0,0 +1,5 @@
+import { YesNoList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+export interface ToBeUsedAsSecurityMapping {
+    [key: string]: YesNoList;
+}
+export declare const toBeUsedAsSecurityMapping: ToBeUsedAsSecurityMapping;

package/lib/types/enum-mappings/to-be-used-as-security.js

@@ -0,0 +1,8 @@
+"use strict";
+exports.__esModule = true;
+exports.toBeUsedAsSecurityMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+exports.toBeUsedAsSecurityMapping = {
+    "true": lixi_internal_request_1.YesNoList.Yes,
+    "false": lixi_internal_request_1.YesNoList.No
+};

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

@@ -1,18 +1,18 @@
 /**
- * Create, update or delete
+ * Create or update
  */
 export interface PublicAsset {
-    payload: AssetDefinition;
-    type: Type;
+    payload: Payload;
     /**
      * schema version
      */
+    type: Type;
     version: string;
 }
 /**
- * create/update Asset payload
+ * create Asset payload
  */
-export interface AssetDefinition {
+export interface Payload {
     applicationId: string;
     asset: Asset;
     /**
@@ -26,9 +26,12 @@ export interface Asset {
     constructionDetails?: ConstructionDetails;
     contractDetails?: ContractDetails;
     contractPriceAmount?: number;
+    dataType?: string;
     description?: string;
     estimatedValue?: number;
     financialInstitution?: string;
+    financialInstitutionAccountNumber?: string;
+    financialInstitutionBsb?: string;
     financialInstitutionShortName?: string;
     knockDownToRebuild?: boolean;
     make?: string;
@@ -37,6 +40,7 @@ export interface Asset {
     primaryPurpose?: PrimaryPurpose;
     propertyStatus?: PropertyStatus;
     propertyType?: PropertyType;
+    relationId?: string;
     toBePurchased?: boolean;
     toBeSold?: boolean;
     toBeUsedAsSecurity?: boolean;
@@ -46,7 +50,7 @@ export interface Asset {
 }
 export interface Address {
     /**
-     * The city / suburb name
+     * The suburb name
      */
     city?: string;
     country?: Countries;
@@ -55,12 +59,12 @@ export interface Address {
      */
     formatted?: string;
     /**
-     * N digit postcode (for AU addresses, usually 4)
+     * A 4 digit postcode
      */
     postcode?: string;
     standard?: AddressStandard;
     /**
-     * The state name
+     * One our great nation's states
      */
     state?: string;
 }
@@ -310,10 +314,6 @@ export interface AddressStandard {
      * The building name
      */
     buildingName?: string;
-    /**
-     * Postal address, usually a PO Box or Locked Bag
-     */
-    deliveryAddress?: string;
     /**
      * The level of the unit/apartment
      */
@@ -330,10 +330,6 @@ export interface AddressStandard {
      * The street number
      */
     streetNumber?: string;
-    /**
-     * The street suffix
-     */
-    streetSuffix?: string;
     /**
      * The type of the street i.e. road
      */
@@ -370,7 +366,7 @@ export interface ContractDetails {
     estimatedSettlementDate?: string;
 }
 export interface PercentOwned {
-    owners?: ApplicantOwnership[];
+    owners: ApplicantOwnership[];
     /**
      * Indicate whether ownership proportions are equal, specified individually for each one or
      * not specified.
@@ -463,6 +459,9 @@ export declare enum ActionedByRole {
     Customer = "customer",
     Team = "team"
 }
+/**
+ * schema version
+ */
 export declare enum Type {
     AssetCreated = "AssetCreated",
     AssetUpdated = "AssetUpdated"

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

@@ -312,6 +312,9 @@ var ActionedByRole;
     ActionedByRole["Customer"] = "customer";
     ActionedByRole["Team"] = "team";
 })(ActionedByRole = exports.ActionedByRole || (exports.ActionedByRole = {}));
+/**
+ * schema version
+ */
 var Type;
 (function (Type) {
     Type["AssetCreated"] = "AssetCreated";

package/lib/update-application/merge-application.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Deep merges the application and custom handles specific arrays
+ *
+ * @param newApplication new application coming from events.
+ * @param existingApplication a saved dynamo application.
+ * @return merged application.
+ */
+export declare function deepMergeApplication(existingApplication: object | undefined, newApplication: object): any;

package/lib/update-application/merge-application.js

@@ -0,0 +1,132 @@
+"use strict";
+exports.__esModule = true;
+exports.deepMergeApplication = void 0;
+var merge = require("deepmerge");
+var cleanDeep = require('clean-deep');
+/**
+ * Deep merges the application and custom handles specific arrays
+ *
+ * @param newApplication new application coming from events.
+ * @param existingApplication a saved dynamo application.
+ * @return merged application.
+ */
+function deepMergeApplication(existingApplication, newApplication) {
+    // Array fields with @UniqueIDs
+    var listsWithUniqueIds = [
+        'Attachment',
+        'Address',
+        'CompanyApplicant',
+        'Dependant',
+        'Liability',
+        'LivingExpense',
+        'LoanDetails',
+        'NonRealEstateAsset',
+        'OtherCommitment',
+        'OtherIncome',
+        'PersonApplicant',
+        'RealEstateAsset',
+        'RelatedCompany',
+        'RelatedPerson',
+    ];
+    // Array fields with @x_Party
+    var listsWithXParty = ['Report'];
+    // Array fields with @x_Owner
+    var listsWithXOwner = ['RentalIncome'];
+    // Array fields with @x_Applicant
+    var listsWithXApplicant = ['Applicant'];
+    // Array fields with @x_ResidentialAddress
+    var listsWithXResidentialAddress = ['PriorAddress'];
+    // Curried function which takes a uniqueKey and returns a function which will either replace
+    // or merge the item in the array based on the uniqueKey
+    if (!existingApplication) {
+        return newApplication;
+    }
+    var mergeItems = function (uniqueKey) {
+        return function (existingItem, newItem) {
+            // if not array continue with merge
+            if (!Array.isArray(newItem)) {
+                return merge(existingItem, newItem, options);
+            }
+            return findArrayItemAndMerge(existingItem, newItem, uniqueKey, options);
+        };
+    };
+    var options = {
+        customMerge: function (key) {
+            if (listsWithUniqueIds.find(function (item) { return item === key; })) {
+                return mergeItems('@UniqueID');
+            }
+            if (listsWithXParty.find(function (item) { return item === key; })) {
+                return mergeItems('@x_Party');
+            }
+            if (listsWithXOwner.find(function (item) { return item === key; })) {
+                return mergeItems('@x_Owner');
+            }
+            if (listsWithXResidentialAddress.find(function (item) { return item === key; })) {
+                return mergeItems('@x_ResidentialAddress');
+            }
+            if (listsWithXApplicant.find(function (item) { return item === key; })) {
+                return mergeItems('@x_Applicant');
+            }
+            return mergeItems(key);
+        }
+    };
+    var mergedApplication = merge(existingApplication, newApplication, options);
+    // Default configurations of cleanDeep for reference.
+    var params = {
+        cleanValues: [],
+        emptyArrays: true,
+        emptyObjects: true,
+        emptyStrings: true,
+        NaNValues: true,
+        nullValues: true,
+        undefinedValues: true
+    };
+    return cleanDeep(mergedApplication, params);
+}
+exports.deepMergeApplication = deepMergeApplication;
+var arrayItemToReplaceKeys = ['Owner', 'Attendee', 'Shareholder', 'Fee', 'ContributionFunds', 'RentalIncome'];
+function findArrayItemAndMerge(existingItem, newItem, uniqueKey, options) {
+    // For some Key, overwritten the old value with the new data so no merge is happening.
+    if (arrayItemToReplaceKeys.includes(uniqueKey))
+        return newItem;
+    if (uniqueKey === 'Income' && existingItem && existingItem.some(function (item) { return item['@StartDate']; })) {
+        // Income array in CompanyApplicant
+        return newItem;
+    }
+    // Copying existing array
+    var mergedArray = existingItem.slice();
+    // Searching whether item in the new array exists in existing array
+    newItem.forEach(function (item) {
+        var indexOfItem = mergedArray.findIndex(function (existingItem) {
+            // TODO [CORE-2160] how to identify employment without go a level down.
+            // Employment needs to go one level deeper to check if the @UniqueID already exist.
+            if (uniqueKey === 'Employment') {
+                var currentEmploymentKeys = Object.keys(item);
+                var existingEmploymentKeys = Object.keys(existingItem);
+                if (currentEmploymentKeys.length && existingEmploymentKeys.length) {
+                    // Get the unique id from the field with proper value for current employment. The types with undefined value
+                    // are present in order to remove the related types from existing application.  These undefined types will be
+                    // removed from payload immediately after deep merging.
+                    // @pliu 19/11/19
+                    var currentEmployment = currentEmploymentKeys.find(function (key) { return item[key]; });
+                    // Each employment can only have one of three types.
+                    // @pliu 19/11/19
+                    var existingEmployment = existingEmploymentKeys[0];
+                    if (currentEmployment && existingEmployment) {
+                        return existingItem[existingEmployment]['@UniqueID'] === item[currentEmployment]['@UniqueID'];
+                    }
+                }
+                return -1;
+            }
+            return existingItem[uniqueKey] === item[uniqueKey];
+        });
+        // Checks if item should be added or merged
+        if (indexOfItem === -1) {
+            mergedArray.push(item);
+        }
+        else {
+            mergedArray[indexOfItem] = merge(mergedArray[indexOfItem], item, options);
+        }
+    });
+    return mergedArray;
+}

package/lib/utils/address-tools.d.ts

@@ -2,7 +2,7 @@
  * A set of tools for manipulating addresses in LIXI applications.
  */
 import { AddressType, CurrentAddress, PreviousAddress } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-import { CommonAddressProperties, PreviousAddress as InternalPreviousAddress } from '../types/events/public-applicant';
+import { Address, CommonAddressProperties, Countries, PreviousAddress as InternalPreviousAddress } from '../types/events/public-applicant';
 /**
  * Type definition for functions used to transform types while mapping from event values to LIXI values.
  */
@@ -25,6 +25,7 @@ export interface MappedTransform {
  */
 export declare type PathMappedTransform = Record<string, MappedTransform>;
 export declare const lixiContactAddressMapping: PathMappedTransform;
+export declare const australianStates: string[];
 /**
  * The transform map used for the LIXI address
  */
@@ -66,4 +67,16 @@ export declare function isMissingCountry(addressEvent: EventAddressType): boolea
  * @param address
  */
 export declare function setCountry(address: EventAddressType): EventAddressType;
+/**
+ * @description Extract a country from a formatted address.
+ * @param {string} formatted - A formatted Address.
+ * @returns {Countries} The country extracted from the Address.
+ */
+export declare function extractCountryFromFormatted(formatted?: string): Countries;
+/**
+ * @description If the address has an overseas country or state, it returns true, defaults to false if no country and state found.
+ * @param {Address} address - Asset Address
+ * @returns {boolean} - Returns true if overseas address.
+ */
+export declare function isOverseasAddress({ country, formatted, state }?: Address): boolean;
 export {};

package/lib/utils/address-tools.js

@@ -3,7 +3,8 @@
  * A set of tools for manipulating addresses in LIXI applications.
  */
 exports.__esModule = true;
-exports.setCountry = exports.isMissingCountry = exports.rebuildPreviousAddress = exports.rebuildAddress = exports.mapTransform = exports.lixiAddressMapping = exports.lixiContactAddressMapping = void 0;
+exports.isOverseasAddress = exports.extractCountryFromFormatted = exports.setCountry = exports.isMissingCountry = exports.rebuildPreviousAddress = exports.rebuildAddress = exports.mapTransform = exports.lixiAddressMapping = exports.australianStates = exports.lixiContactAddressMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
 var lodash_1 = require("lodash");
 var country_code_1 = require("../types/enum-mappings/country-code");
 var housing_status_1 = require("../types/enum-mappings/housing-status");
@@ -24,6 +25,7 @@ exports.lixiContactAddressMapping = {
         path: '@EndDate'
     }
 };
+exports.australianStates = Object.values(lixi_internal_request_1.AuStateList);
 /**
  * The transform map used for the LIXI address
  */
@@ -136,11 +138,41 @@ exports.isMissingCountry = isMissingCountry;
  * @param address
  */
 function setCountry(address) {
-    var _a;
     var formatted = (0, lodash_1.get)(address, 'residentialAddress.formatted');
     if (formatted && !address.residentialAddress.country) {
-        address.residentialAddress.country = (_a = formatted.split(',').pop()) === null || _a === void 0 ? void 0 : _a.trim();
+        address.residentialAddress.country = extractCountryFromFormatted(formatted);
     }
     return address;
 }
 exports.setCountry = setCountry;
+/**
+ * @description Extract a country from a formatted address.
+ * @param {string} formatted - A formatted Address.
+ * @returns {Countries} The country extracted from the Address.
+ */
+function extractCountryFromFormatted(formatted) {
+    var _a;
+    if (formatted === void 0) { formatted = ''; }
+    return (_a = formatted === null || formatted === void 0 ? void 0 : formatted.split(',').pop()) === null || _a === void 0 ? void 0 : _a.trim();
+}
+exports.extractCountryFromFormatted = extractCountryFromFormatted;
+/**
+ * @description If the address has an overseas country or state, it returns true, defaults to false if no country and state found.
+ * @param {Address} address - Asset Address
+ * @returns {boolean} - Returns true if overseas address.
+ */
+function isOverseasAddress(_a) {
+    var _b = _a === void 0 ? {} : _a, country = _b.country, formatted = _b.formatted, state = _b.state;
+    if (country) {
+        return country !== public_applicant_1.Countries.Australia;
+    }
+    if (formatted) {
+        var lastPast = extractCountryFromFormatted(formatted);
+        return lastPast !== public_applicant_1.Countries.Australia;
+    }
+    if (state) {
+        return !exports.australianStates.includes(state);
+    }
+    return false;
+}
+exports.isOverseasAddress = isOverseasAddress;

package/lib/utils/generate-address.d.ts

@@ -4,10 +4,9 @@ export declare const StreetNumberMaxLength = 16;
 export declare const StreetTypeArray: StreetTypeList[];
 /**
  * Generates an address for an asset.
-
- * @param address: An address object.
- * @param id: Id of asset object.
- * @return A transformed address object.
+ * @param {Address} address - An address object.
+ * @param {string} id - Id of asset object.
+ * @return {Partial<AddressType>} A transformed address object.
  */
 export declare function generateAddress(address: Address, id: string): Partial<AddressType>;
 /**

package/lib/utils/generate-address.js

@@ -6,7 +6,9 @@ var lodash_1 = require("lodash");
 var country_code_1 = require("..//types/enum-mappings/country-code");
 var postcode_1 = require("../types/enum-mappings/postcode");
 var public_asset_1 = require("../types/events/public-asset");
+var address_tools_1 = require("./address-tools");
 exports.StreetNumberMaxLength = 16;
+exports.StreetTypeArray = Object.values(lixi_internal_request_1.StreetTypeList);
 var addressMapping = {
     country: '@Country',
     city: '@Suburb',
@@ -21,21 +23,18 @@ var standardMapping = {
     level: '@Level',
     unit: '@Unit'
 };
-exports.StreetTypeArray = Object.values(lixi_internal_request_1.StreetTypeList);
 /**
  * Generates an address for an asset.
-
- * @param address: An address object.
- * @param id: Id of asset object.
- * @return A transformed address object.
+ * @param {Address} address - An address object.
+ * @param {string} id - Id of asset object.
+ * @return {Partial<AddressType>} A transformed address object.
  */
 function generateAddress(address, id) {
-    var _a;
     var transformedAddress = {
         '@Country': lixi_internal_request_1.CountryCodeList.Au,
         '@UniqueID': id
     };
-    var country = (((_a = address.formatted) === null || _a === void 0 ? void 0 : _a.split(',').pop()) || '').trim();
+    var country = (0, address_tools_1.extractCountryFromFormatted)(address.formatted);
     if (!address.country && country.length > 0) {
         address.country = country;
     }
@@ -50,8 +49,8 @@ function generateAddress(address, id) {
             transformedAddress['@AustralianPostCode'] = postcode_1.postcodeMapping[address.state];
         }
     }
-    for (var _i = 0, _b = Object.entries(address); _i < _b.length; _i++) {
-        var _c = _b[_i], key = _c[0], value = _c[1];
+    for (var _i = 0, _a = Object.entries(address); _i < _a.length; _i++) {
+        var _b = _a[_i], key = _b[0], value = _b[1];
         if (addressMapping[key]) {
             switch (key) {
                 case 'standard':

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

@@ -0,0 +1,25 @@
+import { Asset } from '../types/events/public-asset';
+/**
+ * @description Checks if the asset is of financial type.
+ * @param {Asset} asset asset payload.
+ * @returns {boolean} returns true if asset is a financial asset.
+ */
+export declare function isFinancialAsset(asset: Asset): boolean;
+/**
+ * @description Is Asset a Real Estate Asset.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if Asset is a Real Estate Asset.
+ */
+export declare function isRealEstateAsset(asset: Asset): boolean;
+/**
+ * @description Is Asset a Motor Vehicle.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if an Asset is a vehicle.
+ */
+export declare function isMotorVehicle(asset: Asset): boolean;
+/**
+ * @description Is Asset of LIXI type `OtherAsset`.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if asset is `OtherAsset`.
+ */
+export declare function isOtherAsset(asset: Asset): boolean;

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

@@ -0,0 +1,46 @@
+"use strict";
+exports.__esModule = true;
+exports.isOtherAsset = exports.isMotorVehicle = exports.isRealEstateAsset = exports.isFinancialAsset = void 0;
+var public_asset_1 = require("../types/events/public-asset");
+/**
+ * @description Checks if the asset is of financial type.
+ * @param {Asset} asset asset payload.
+ * @returns {boolean} returns true if asset is a financial asset.
+ */
+function isFinancialAsset(asset) {
+    return [
+        public_asset_1.AssetType.Shares,
+        public_asset_1.AssetType.Superannuation,
+        public_asset_1.AssetType.TermDeposit,
+        public_asset_1.AssetType.SavingCheckAccount,
+        public_asset_1.AssetType.ManagedFunds,
+    ].includes(asset.type);
+}
+exports.isFinancialAsset = isFinancialAsset;
+/**
+ * @description Is Asset a Real Estate Asset.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if Asset is a Real Estate Asset.
+ */
+function isRealEstateAsset(asset) {
+    return asset.type === public_asset_1.AssetType.Property;
+}
+exports.isRealEstateAsset = isRealEstateAsset;
+/**
+ * @description Is Asset a Motor Vehicle.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if an Asset is a vehicle.
+ */
+function isMotorVehicle(asset) {
+    return asset.type === public_asset_1.AssetType.Vehicle;
+}
+exports.isMotorVehicle = isMotorVehicle;
+/**
+ * @description Is Asset of LIXI type `OtherAsset`.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if asset is `OtherAsset`.
+ */
+function isOtherAsset(asset) {
+    return [public_asset_1.AssetType.HomeContents, public_asset_1.AssetType.Gifts, public_asset_1.AssetType.OtherAsset].includes(asset.type);
+}
+exports.isOtherAsset = isOtherAsset;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.2.0",
+  "version": "1.2.4",
   "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.14.4",
-    "@lendi/integrations-protocol": "2.3.0",
+    "@lendi/integrations-credit-protocol": "1.15.2",
+    "@lendi/integrations-protocol": "2.5.4",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",
     "dd-trace": "^0.28.1",

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

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