@lendi/integrations-transform 1.2.0 → 1.2.1

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/lib/utils/normalise-date.js

@@ -12,6 +12,6 @@ function normaliseDate(dateOfBirth) {
     var year = date.getFullYear();
     var month = ('0' + (date.getMonth() + 1)).slice(-2);
     var day = ('0' + date.getDate()).slice(-2);
-    return "".concat(year, "-").concat(month, "-").concat(day);
+    return year + "-" + month + "-" + day;
 }
 exports.normaliseDate = normaliseDate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "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.14.9",
+    "@lendi/integrations-protocol": "2.5.3",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",
     "dd-trace": "^0.28.1",
@@ -89,4 +89,4 @@
     "semver:major": "npm version major",
     "current:version": "echo $npm_package_version"
   }
-}
+}

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;

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

@@ -1,178 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.isFinancialAsset = exports.generateAsset = exports.propertyTypeNameList = exports.residentialTypeList = void 0;
-var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
-var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-var lodash_1 = require("lodash");
-var logger_1 = require("../logger");
-var public_financial_asset_1 = require("../types/enum-mappings/public-financial-asset");
-var public_primary_purpose_1 = require("../types/enum-mappings/public-primary-purpose");
-var public_property_status_1 = require("../types/enum-mappings/public-property-status");
-var public_property_type_1 = require("../types/enum-mappings/public-property-type");
-var public_asset_1 = require("../types/events/public-asset");
-var generate_address_1 = require("../utils/generate-address");
-var get_financial_institution_1 = require("../utils/get-financial-institution");
-var generate_lixi_percentowned_1 = require("./generate-lixi-percentowned");
-var toBeUsedAsSecurityMapping = {
-    "true": lixi_internal_request_1.YesNoList.Yes,
-    "false": lixi_internal_request_1.YesNoList.No
-};
-var toBePurchasedMapping = {
-    "true": lixi_internal_request_1.AssetTransactionList.Purchasing,
-    "false": lixi_internal_request_1.AssetTransactionList.Owns
-};
-var assetMapping = {
-    make: "".concat(application_paths_1.paths.NonRealEstateAsset, ".MotorVehicle.@Make"),
-    year: "".concat(application_paths_1.paths.NonRealEstateAsset, ".MotorVehicle.@Year"),
-    model: "".concat(application_paths_1.paths.NonRealEstateAsset, ".MotorVehicle.@Model"),
-    estimatedValue: "".concat(application_paths_1.paths.NonRealEstateAsset, ".EstimatedValue.@Value"),
-    zoneType: "".concat(application_paths_1.paths.RealEstateAsset, ".Zoning.@Type"),
-    toBeUsedAsSecurity: "".concat(application_paths_1.paths.RealEstateAsset, ".@ToBeUsedAsSecurity"),
-    toBePurchased: "".concat(application_paths_1.paths.RealEstateAsset, ".@Transaction"),
-    primaryPurpose: "".concat(application_paths_1.paths.RealEstateAsset, ".@PrimaryPurpose"),
-    propertyStatus: "".concat(application_paths_1.paths.RealEstateAsset, ".@Status"),
-    financialInstitution: "".concat(application_paths_1.paths.NonRealEstateAsset, ".FinancialAsset.AccountNumber.@FinancialInstitution"),
-    propertyType: "".concat(application_paths_1.paths.RealEstateAsset, ".Residential.@Type"),
-    address: application_paths_1.paths.Address
-};
-exports.residentialTypeList = Object.values(lixi_internal_request_1.ResidentialTypeList);
-exports.propertyTypeNameList = Object.values(lixi_internal_request_1.Custom3PropertyTypeNameList);
-/**
- * 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.
- */
-function generateAsset(_a) {
-    var asset = _a.asset, applicationId = _a.applicationId, id = _a.id;
-    var partialApplication = {};
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
-    var isPropertyAsset = asset.type === public_asset_1.AssetType.Property;
-    switch (asset.type) {
-        case public_asset_1.AssetType.Vehicle:
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".@Type"), lixi_internal_request_1.NonRealEstateAssetTypeList.MotorVehicleAndTransport);
-            break;
-        case public_asset_1.AssetType.Property:
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".@MultipleDwellings"), lixi_internal_request_1.YesNoList.No);
-            break;
-        case public_asset_1.AssetType.HomeContents:
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".@Type"), lixi_internal_request_1.NonRealEstateAssetTypeList.Other);
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".OtherAsset.@Type"), lixi_internal_request_1.OtherAssetTypeList.HomeContents);
-            break;
-        case public_asset_1.AssetType.Gifts:
-        case public_asset_1.AssetType.OtherAsset:
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".@Type"), lixi_internal_request_1.NonRealEstateAssetTypeList.Other);
-            if (asset.description)
-                (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".OtherAsset.@Description"), asset.description);
-            break;
-        case public_asset_1.AssetType.Shares:
-        case public_asset_1.AssetType.Superannuation:
-        case public_asset_1.AssetType.TermDeposit:
-        case public_asset_1.AssetType.SavingCheckAccount:
-        case public_asset_1.AssetType.ManagedFunds:
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".@Type"), lixi_internal_request_1.NonRealEstateAssetTypeList.FinancialAsset);
-            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".FinancialAsset.@Type"), public_financial_asset_1.financialAssetMapping[asset.type]);
-            break;
-        default:
-            logger_1.logger.warn({ message: "Unhandled asset type: ".concat(asset.type), applicationId: applicationId });
-            return;
-    }
-    if (isPropertyAsset) {
-        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".@UniqueID"), id);
-        assetMapping.percentOwned = "".concat(application_paths_1.paths.RealEstateAsset, ".PercentOwned");
-    }
-    else {
-        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.NonRealEstateAsset, ".@UniqueID"), id);
-        assetMapping.percentOwned = "".concat(application_paths_1.paths.NonRealEstateAsset, ".PercentOwned");
-    }
-    for (var _i = 0, _b = Object.entries(asset); _i < _b.length; _i++) {
-        var _c = _b[_i], key = _c[0], value = _c[1];
-        if (assetMapping[key]) {
-            switch (key) {
-                case 'primaryPurpose':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], public_primary_purpose_1.primaryPurposeMapping[value]);
-                    break;
-                case 'toBePurchased':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], toBePurchasedMapping[value]);
-                    break;
-                case 'propertyStatus':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], public_property_status_1.propertyStatusMapping[value]);
-                    break;
-                case 'toBeUsedAsSecurity':
-                    if (isPropertyAsset)
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], toBeUsedAsSecurityMapping[value]);
-                    break;
-                case 'estimatedValue':
-                    if (isPropertyAsset) {
-                        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".EstimatedValue.@Value"), value);
-                    }
-                    else {
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], value);
-                    }
-                    break;
-                case 'propertyType':
-                    var mappedValue = public_property_type_1.propertyTypeMapping[value];
-                    if (exports.residentialTypeList.includes(mappedValue)) {
-                        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".Residential.@Type"), mappedValue);
-                    }
-                    else if (exports.propertyTypeNameList.includes(mappedValue)) {
-                        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".PropertyType.@PropertyTypeName"), mappedValue);
-                        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".PropertyType.@CategoryTypeName"), lixi_internal_request_1.Custom2CategoryTypeNameList.Residential);
-                    }
-                    else {
-                        logger_1.logger.warn({ message: "Unknown propertyType ".concat(value, " for asset ").concat(id), applicationId: applicationId });
-                    }
-                    break;
-                case 'zoneType':
-                    if (asset.zoneType === public_asset_1.ZoneType.Commercial) {
-                        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".Commercial.@Type"), lixi_internal_request_1.OtherAssetTypeList.Other);
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], lixi_internal_request_1.Custom4TypeList.Commercial);
-                    }
-                    else {
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], lixi_internal_request_1.Custom4TypeList.Residential);
-                    }
-                    break;
-                case 'financialInstitution':
-                    if (isFinancialAsset(asset)) {
-                        var financialInstitution = (0, get_financial_institution_1.getFinancialInstitution)(value.toString());
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], financialInstitution);
-                    }
-                    break;
-                case 'year':
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], value.toString());
-                    break;
-                case 'address':
-                    var addressId = "".concat(id, "-address");
-                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".@x_Address"), addressId);
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], (0, generate_address_1.generateAddress)(value, addressId));
-                    break;
-                case 'percentOwned':
-                    var percentOwned = (0, generate_lixi_percentowned_1.generateLIXIPercentOwned)(value);
-                    if (percentOwned) {
-                        (0, lodash_1.set)(partialApplication, assetMapping[key], percentOwned);
-                    }
-                    break;
-                default:
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], value);
-            }
-        }
-    }
-    return partialApplication;
-}
-exports.generateAsset = generateAsset;
-/**
- * Checks if the asset is of financial type.
- * @param asset asset payload
- */
-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;