@lendi/integrations-transform 1.1.8 → 1.2.2

package/lib/index.d.ts

@@ -1,7 +1,9 @@
 export * from './transform-events/transform-applicant';
 export * from './transform-events/transform-application';
-export * from './transform-events/generate-asset';
+export * from './transform-events/transform-income';
+export * from './transform-events/transform-asset';
 export * from './transform-events/transform-expenses';
 export * from './transform-events/generate-liability';
 export * from './transform-events/generate-required-document';
 export * from './transform-events/generate-funding-position';
+export * from './update-application/merge-application';

package/lib/index.js

@@ -13,8 +13,10 @@ exports.__esModule = true;
 /* istanbul ignore file  */
 __exportStar(require("./transform-events/transform-applicant"), exports);
 __exportStar(require("./transform-events/transform-application"), exports);
-__exportStar(require("./transform-events/generate-asset"), exports);
+__exportStar(require("./transform-events/transform-income"), exports);
+__exportStar(require("./transform-events/transform-asset"), exports);
 __exportStar(require("./transform-events/transform-expenses"), exports);
 __exportStar(require("./transform-events/generate-liability"), exports);
 __exportStar(require("./transform-events/generate-required-document"), exports);
 __exportStar(require("./transform-events/generate-funding-position"), exports);
+__exportStar(require("./update-application/merge-application"), exports);

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

@@ -1,5 +1,12 @@
 {
   "definitions": {
+    "payload": {
+      "type": "object",
+      "$ref": "#/definitions/createAssetDefinition"
+    },
+    "id": {
+      "type": "string"
+    },
     "meta": {
       "type": "object",
       "additionalProperties": false,
@@ -16,22 +23,9 @@
       },
       "required": ["actionedBy", "actionedByRole"]
     },
-    "Ownership": {
-      "type": "object",
-      "properties": {
-        "applicantId": {
-          "type": "string",
-          "format": "uuid"
-        },
-        "percent": {
-          "type": "number",
-          "description": "how much percent for the corresponding applicant",
-          "examples": [0.5]
-        }
-      }
-    },
     "applicantOwnership": {
       "type": "object",
+      "required": ["applicantId", "percent"],
       "properties": {
         "applicantId": {
           "type": "string",
@@ -45,11 +39,11 @@
           "description": "how much percent for the corresponding applicant",
           "examples": [0.5]
         }
-      },
-      "required": ["percent", "applicantId"]
+      }
     },
     "percentOwned": {
       "type": "object",
+      "required": ["owners"],
       "properties": {
         "proportions": {
           "enum": ["EQUAL", "SPECIFIED", "NOT_SPECIFIED"],
@@ -93,6 +87,33 @@
       "type": "string",
       "description": "Description of the entity."
     },
+    "address": {
+      "type": "object",
+      "properties": {
+        "postcode": {
+          "description": "A 4 digit postcode",
+          "type": "string"
+        },
+        "state": {
+          "description": "One our great nation's states",
+          "type": "string"
+        },
+        "city": {
+          "description": "The suburb name",
+          "type": "string"
+        },
+        "country": {
+          "$ref": "#/definitions/countries"
+        },
+        "formatted": {
+          "description": "A formatted version of the address",
+          "type": "string"
+        },
+        "standard": {
+          "$ref": "#/definitions/addressStandard"
+        }
+      }
+    },
     "countries": {
       "type": "string",
       "example": "Australia",
@@ -338,84 +359,36 @@
         "Zimbabwe"
       ]
     },
-    "address": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "city": {
-          "description": "The city / suburb name",
-          "type": "string",
-          "example": "Sydney"
-        },
-        "country": {
-          "$ref": "#/definitions/countries"
-        },
-        "formatted": {
-          "description": "A formatted version of the address",
-          "type": "string",
-          "example": "L 9, 50 Pitt St, Sydney, NSW 2000, Australia"
-        },
-        "postcode": {
-          "description": "N digit postcode (for AU addresses, usually 4)",
-          "type": "string",
-          "example": "2000"
-        },
-        "standard": {
-          "$ref": "#/definitions/addressStandard"
-        },
-        "state": {
-          "description": "The state name",
-          "type": "string"
-        }
-      }
-    },
     "addressStandard": {
       "type": "object",
       "properties": {
         "buildingName": {
           "description": "The building name",
-          "type": "string",
-          "example": "Opera House"
-        },
-        "deliveryAddress": {
-          "description": "Postal address, usually a PO Box or Locked Bag",
-          "type": "string",
-          "example": "PO Box 1"
+          "type": "string"
         },
         "level": {
           "description": "The level of the unit/apartment",
-          "type": "string",
-          "example": "L 9"
+          "type": "string"
         },
         "lotSection": {
           "description": "The lot number",
-          "type": "string",
-          "example": "Lot 1"
+          "type": "string"
         },
         "streetName": {
           "description": "The street name",
-          "type": "string",
-          "example": "Pitt"
+          "type": "string"
         },
         "streetNumber": {
           "description": "The street number",
-          "type": "string",
-          "example": "50"
-        },
-        "streetSuffix": {
-          "description": "The street suffix",
-          "type": "string",
-          "example": "North"
+          "type": "string"
         },
         "streetType": {
           "description": "The type of the street i.e. road",
-          "type": "string",
-          "example": "St"
+          "type": "string"
         },
         "unit": {
           "description": "The unit number",
-          "type": "string",
-          "example": "U 1"
+          "type": "string"
         }
       }
     },
@@ -494,6 +467,25 @@
     "financialInstitutionShortName": {
       "type": "string"
     },
+    "FinancialInstitutionBsb": {
+      "type": "string",
+      "pattern": "^\\d{6}$",
+      "description": "The BSB number identifying where the account is held within the Financial Institution",
+      "example": "123456"
+    },
+    "FinancialInstitutionAccountNumber": {
+      "type": "string",
+      "pattern": "^\\d{0,10}$",
+      "description": "The unique number assigned to the Financial Institution account",
+      "example": "999994"
+    },
+    "dataType": {
+      "type": "string"
+    },
+    "relationId": {
+      "$ref": "#/definitions/id",
+      "description": "uuid of relation"
+    },
     "assetType": {
       "enum": [
         "GIFTS",
@@ -520,6 +512,9 @@
         "description": {
           "type": "string"
         },
+        "dataType": {
+          "$ref": "#/definitions/dataType"
+        },
         "type": {
           "$ref": "#/definitions/assetType"
         },
@@ -532,6 +527,12 @@
         "financialInstitutionShortName": {
           "$ref": "#/definitions/financialInstitutionShortName"
         },
+        "financialInstitutionBsb": {
+          "$ref": "#/definitions/FinancialInstitutionBsb"
+        },
+        "financialInstitutionAccountNumber": {
+          "$ref": "#/definitions/FinancialInstitutionAccountNumber"
+        },
         "toBeSold": {
           "$ref": "#/definitions/toBeSold"
         },
@@ -562,6 +563,9 @@
         "propertyType": {
           "$ref": "#/definitions/propertyType"
         },
+        "relationId": {
+          "$ref": "#/definitions/relationId"
+        },
         "contractDetails": {
           "$ref": "#/definitions/contractDetails"
         },
@@ -578,21 +582,14 @@
           "$ref": "#/definitions/year"
         }
       },
+      "additionalProperties": true,
       "required": ["type"]
     },
-    "australianStates": {
-      "type": "string",
-      "enum": ["QLD", "NSW", "VIC", "WA", "SA", "TAS", "ACT", "NT"]
-    },
-    "otherState": {
-      "type": "string",
-      "example": "Ohio"
-    },
-    "AssetDefinition": {
+    "createAssetDefinition": {
       "type": "object",
       "properties": {
         "id": {
-          "type": "string",
+          "$ref": "#/definitions/id",
           "description": "uuid of asset"
         },
         "meta": {
@@ -606,27 +603,23 @@
         }
       },
       "required": ["id", "applicationId", "asset"],
-      "description": "create/update Asset payload"
-    },
-    "Amount": {
-      "type": "number",
-      "example": 100000
+      "description": "create Asset payload"
     }
   },
   "type": "object",
-  "title": "The alieo asset event schema",
-  "description": "Create, update or delete",
+  "title": "The asset event schema",
+  "description": "Create or update",
   "properties": {
-    "version": {
+    "type": {
       "type": "string",
+      "enum": ["AssetUpdated", "AssetCreated"],
       "description": "schema version"
     },
-    "type": {
-      "type": "string",
-      "enum": ["AssetCreated", "AssetUpdated"]
+    "version": {
+      "type": "string"
     },
     "payload": {
-      "$ref": "#/definitions/AssetDefinition"
+      "$ref": "#/definitions/payload"
     }
   },
   "required": ["version", "payload", "type"]

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

@@ -8,7 +8,7 @@ var liability_payment_type_1 = require("../types/enum-mappings/liability-payment
 var liability_type_1 = require("../types/enum-mappings/liability-type");
 var get_financial_institution_1 = require("../utils/get-financial-institution");
 var round_decimal_1 = require("../utils/round-decimal");
-var generate_lixi_percentowned_1 = require("./generate-lixi-percentowned");
+var transform_percent_owned_1 = require("./transform-percent-owned");
 var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
 /**
  * Generates a partial internal request from a liability event payload.
@@ -71,7 +71,7 @@ function generateLiability(_a) {
                     (0, lodash_1.set)(partialApplication, liabilityMapping[key], financialInstitution);
                     break;
                 case 'percentOwned':
-                    var percentOwned = (0, generate_lixi_percentowned_1.generateLIXIPercentOwned)(value);
+                    var percentOwned = (0, transform_percent_owned_1.transformPercentOwned)(value);
                     if (percentOwned) {
                         (0, lodash_1.set)(partialApplication, liabilityMapping[key], percentOwned);
                     }

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

@@ -5,10 +5,7 @@ var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/li
 var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
 var lodash_1 = require("lodash");
 var address_tools_1 = require("../utils/address-tools");
-var country_code_1 = require("../types/enum-mappings/country-code");
-var marital_status_1 = require("../types/enum-mappings/marital-status");
-var residency_status_1 = require("../types/enum-mappings/residency-status");
-var title_1 = require("../types/enum-mappings/title");
+var enum_mappings_1 = require("../types/enum-mappings");
 var public_applicant_1 = require("../types/events/public-applicant");
 var normalise_date_1 = require("../utils/normalise-date");
 var booleanMapping = function (input) {
@@ -44,7 +41,7 @@ function transformApplicant(applicant) {
     var applicantId = applicant.id, applicationId = applicant.applicationId;
     (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'], title_1.titleMapping[applicant.title || public_applicant_1.Title.Unknown]);
+    (0, lodash_1.set)(partialApplication, applicantMapping['title'], enum_mappings_1.titleMapping[applicant.title || public_applicant_1.Title.Unknown]);
     var applicantUpdated = (0, lodash_1.omit)(applicant, ['isFirstHomeBuyer', 'isPrimaryApplicant', 'title']);
     for (var _i = 0, _a = Object.entries(applicantUpdated); _i < _a.length; _i++) {
         var _b = _a[_i], key = _b[0], value = _b[1];
@@ -54,13 +51,13 @@ function transformApplicant(applicant) {
                     (0, lodash_1.set)(partialApplication, applicantMapping[key], (0, normalise_date_1.normaliseDate)(value));
                     break;
                 case 'maritalStatus':
-                    (0, lodash_1.set)(partialApplication, applicantMapping[key], marital_status_1.maritalStatusMapping[value]);
+                    (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.maritalStatusMapping[value]);
                     break;
                 case 'citizenship':
-                    (0, lodash_1.set)(partialApplication, applicantMapping[key], country_code_1.countryCodeMapping[value]);
+                    (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.countryCodeMapping[value]);
                     break;
                 case 'residencyStatus':
-                    (0, lodash_1.set)(partialApplication, applicantMapping[key], residency_status_1.residencyStatusMapping[value]);
+                    (0, lodash_1.set)(partialApplication, applicantMapping[key], enum_mappings_1.residencyStatusMapping[value]);
                     // Certain bank integrations require the ability to differentiate between permanentResident and Citizen
                     // As lixi does not have a citizen enum for residencyStatus citizen is mapped to permanentResident
                     // Adding a @Citizenship attribute to person applicant gives us the ability to determine citizenship status

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

@@ -5,8 +5,7 @@ var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types
 var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
 var application_paths_2 = require("@lendi/integrations-credit-protocol/utils/application-paths");
 var lodash_1 = require("lodash");
-var preferred_repayment_1 = require("../types/enum-mappings/preferred-repayment");
-var transaction_type_1 = require("../types/enum-mappings/transaction-type");
+var enum_mappings_1 = require("../types/enum-mappings/");
 /**
  * Transforms a partial opportunity event to a partial internal request.
  *
@@ -35,10 +34,10 @@ function transformApplication(opportunity) {
                     if (opportunityMapping[key]) {
                         switch (key) {
                             case 'paymentType':
-                                (0, lodash_1.set)(partialApplication, opportunityMapping[key], preferred_repayment_1.preferredRepaymentMapping[value]);
+                                (0, lodash_1.set)(partialApplication, opportunityMapping[key], enum_mappings_1.preferredRepaymentMapping[value]);
                                 break;
                             case 'primaryPurpose':
-                                (0, lodash_1.set)(partialApplication, opportunityMapping[key], transaction_type_1.transactionTypeMapping[value]);
+                                (0, lodash_1.set)(partialApplication, opportunityMapping[key], enum_mappings_1.transactionTypeMapping[value]);
                                 break;
                         }
                     }

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

@@ -0,0 +1,19 @@
+import { AddressType, Standard } from "@lendi/integrations-protocol/lib/types/lixi-internal-request";
+import { Address, AddressStandard } from "../types/events/public-asset";
+export declare function getAddressMapping(address: Address): Record<string, string>;
+export declare const standardMapping: Record<string, string>;
+/**
+ * Generates an address for an asset.
+ *
+ * @param address: An address object.
+ * @param id: address event id.
+ * @param toBeUsedAsSecurity
+ * @return A transformed address object.
+ */
+export declare function transformAddress(address: Address, id: string): Partial<AddressType>;
+/**
+ * @description Generates an address standard.
+ * @param {AddressStandard} addressStandard An address standard object.
+ * @return {Partial<Standard>} A transformed standard object.
+ */
+export declare function transformStandard(addressStandard: AddressStandard): Partial<Standard>;

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

@@ -0,0 +1,83 @@
+"use strict";
+exports.__esModule = true;
+exports.transformStandard = exports.transformAddress = exports.standardMapping = exports.getAddressMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
+var lodash_1 = require("lodash");
+var enum_mappings_1 = require("../types/enum-mappings");
+var address_tools_1 = require("../utils/address-tools");
+function getAddressMapping(address) {
+    return {
+        city: '@Suburb',
+        country: '@Country',
+        postcode: (0, address_tools_1.isOverseasAddress)(address) ? '@OverseasPostCode' : '@AustralianPostCode',
+        state: (0, address_tools_1.isOverseasAddress)(address) ? '@OverseasState' : '@AustralianState',
+        standard: 'Standard',
+        formatted: '@Country'
+    };
+}
+exports.getAddressMapping = getAddressMapping;
+exports.standardMapping = {
+    streetName: '@StreetName',
+    streetType: '@StreetType',
+    streetNumber: '@StreetNumber',
+    level: '@Level',
+    unit: '@Unit'
+};
+/**
+ * Generates an address for an asset.
+ *
+ * @param address: An address object.
+ * @param id: address event id.
+ * @param toBeUsedAsSecurity
+ * @return A transformed address object.
+ */
+function transformAddress(address, id) {
+    var transformedAddress = {
+        '@UniqueID': id
+    };
+    var addressMapping = getAddressMapping(address);
+    // for an Australian address: if no postcode is provided, infer one from the state:
+    if (!(0, address_tools_1.isOverseasAddress)(address) && address.state && !address.postcode) {
+        address.postcode = enum_mappings_1.postcodeMapping[address.state];
+    }
+    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':
+                    (0, lodash_1.set)(transformedAddress, addressMapping[key], transformStandard(value));
+                    break;
+                case 'country':
+                    (0, lodash_1.set)(transformedAddress, addressMapping[key], (0, address_tools_1.isOverseasAddress)(address) ? enum_mappings_1.countryCodeMapping[value] : lixi_internal_request_1.CountryCodeList.Au);
+                    break;
+                case 'formatted':
+                    if (!address.country) {
+                        var country = (0, address_tools_1.extractCountryFromFormatted)(value);
+                        (0, lodash_1.set)(transformedAddress, addressMapping[key], enum_mappings_1.countryCodeMapping[country]);
+                    }
+                    break;
+                default:
+                    (0, lodash_1.set)(transformedAddress, addressMapping[key], value);
+                    break;
+            }
+        }
+    }
+    return transformedAddress;
+}
+exports.transformAddress = transformAddress;
+/**
+ * @description Generates an address standard.
+ * @param {AddressStandard} addressStandard An address standard object.
+ * @return {Partial<Standard>} A transformed standard object.
+ */
+function transformStandard(addressStandard) {
+    var transformedStandard = {};
+    for (var _i = 0, _a = Object.entries(addressStandard); _i < _a.length; _i++) {
+        var _b = _a[_i], key = _b[0], value = _b[1];
+        if (exports.standardMapping[key]) {
+            (0, lodash_1.set)(transformedStandard, exports.standardMapping[key], value);
+        }
+    }
+    return transformedStandard;
+}
+exports.transformStandard = transformStandard;

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

@@ -0,0 +1,28 @@
+import { PropertyType as LixiPropertyType, Residential } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
+import { Asset, Payload, PropertyType } from '../types/events/public-asset';
+import { PartialApplication } from '../types/partial-application';
+export interface PropertyTypeMapping {
+    path: string;
+    value: Residential | LixiPropertyType;
+}
+export declare const propertyTypeNameList: string[];
+export declare const residentialTypeList: string[];
+/**
+ * Generates a partial internal request from a partial public asset event.
+ *
+ * @param {Payload} asset - A partial public asset.
+ * @return {PartialApplication} A partial InternalRequest.
+ */
+export declare function transformAsset({ asset, applicationId, id }: Payload): PartialApplication;
+/**
+ * @description Map the propertyType to a RealEstateAsset path and the value.
+ * @param {PropertyType} propertyType - A propertyType.
+ * @returns {PropertyTypeMapping | null} A path and value to be used for property type mapping.
+ */
+export declare function getPropertyType(propertyType: PropertyType): PropertyTypeMapping | null;
+/**
+ * @description Get the asset transform mapping for various asset types.
+ * @param {Asset} asset An Asset
+ * @returns {Record<string, string>} Asset Transform Mapping.
+ */
+export declare function getAssetMapping(asset: Asset): Record<string, string>;