@lendi/integrations-transform 1.3.4 → 1.3.7

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

@@ -503,6 +503,36 @@
     "applicationId": {
       "type": "string"
     },
+    "PropertyExpenses": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["type"],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "BODY_CORPORATE_FEES_STRATA_FEES_AND_LAND_TAX",
+              "PRIMARY_RESIDENCE_RUNNING_COSTS",
+              "INVESTMENT_PROPERTY_RUNNING_COSTS",
+              "SECONDARY_RESIDENCE_RUNNING_COSTS"
+            ]
+          },
+          "amount": {
+            "type": "number",
+            "example": 100000
+          },
+          "frequency": {
+            "type": "string",
+            "enum": ["FORTNIGHTLY", "MONTHLY", "QUARTERLY", "WEEKLY", "YEARLY"]
+          },
+          "comments": {
+            "type": "string"
+          }
+        }
+      }
+    },
     "asset": {
       "type": "object",
       "properties": {
@@ -580,6 +610,9 @@
         },
         "year": {
           "$ref": "#/definitions/year"
+        },
+        "propertyExpenses": {
+          "$ref": "#/definitions/PropertyExpenses"
         }
       },
       "additionalProperties": true,

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

@@ -1,5 +1,6 @@
+import { LivingExpense, PropertyExpense as LIXIPropertyExpense, OccupancyList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
 import { PropertyType as LixiPropertyType, Residential } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-import { Asset, Payload, PropertyType } from '../types/events/public-asset';
+import { Asset, Payload, PercentOwned, PropertyExpense, PropertyType } from '../types/events/public-asset';
 import { PartialApplication } from '../types/partial-application';
 export interface PropertyTypeMapping {
     path: string;
@@ -26,3 +27,26 @@ export declare function getPropertyType(propertyType: PropertyType): PropertyTyp
  * @returns {Record<string, string>} Asset Transform Mapping.
  */
 export declare function getAssetMapping(asset: Asset): Record<string, string>;
+/**
+ * Creates living expense items from a propertyExpense object.
+ *
+ * @param percentOwned: owners of the property
+ * @param assetId: Asset id
+ * @param propertyExpenses: propertyExpenses items
+ */
+export declare function generateLivingExpenses(percentOwned: PercentOwned, assetId: string, propertyExpenses: PropertyExpense[]): LivingExpense[];
+/**
+ * Creates PropertyExpense array on RealEstateAsset from the same array on the event.
+ * @param propertyExpenses
+ */
+export declare function generatePropertyExpenses(propertyExpenses: PropertyExpense[]): LIXIPropertyExpense[];
+/**
+ * Determines the occupancy based on the list of property expense types available.
+ * @param propertyExpenses
+ */
+export declare function determineOccupancy(propertyExpenses: PropertyExpense[]): OccupancyList;
+/**
+ * Calculates the correct amount and frequency.
+ * @param expense
+ */
+export declare function normalizeAmounts(expense: PropertyExpense): PropertyExpense;

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

@@ -11,16 +11,19 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 exports.__esModule = true;
-exports.getAssetMapping = exports.getPropertyType = exports.transformAsset = exports.residentialTypeList = exports.propertyTypeNameList = void 0;
+exports.normalizeAmounts = exports.determineOccupancy = exports.generatePropertyExpenses = exports.generateLivingExpenses = exports.getAssetMapping = exports.getPropertyType = exports.transformAsset = exports.residentialTypeList = exports.propertyTypeNameList = void 0;
 var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
 var application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
 var lixi_internal_request_2 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
+var uuid_1 = require("uuid");
 var lodash_1 = require("lodash");
 var logger_1 = require("../logger");
 var enum_mappings_1 = require("../types/enum-mappings");
 var public_asset_1 = require("../types/events/public-asset");
+var public_expense_1 = require("../types/events/public-expense");
 var get_financial_institution_1 = require("../utils/get-financial-institution");
 var is_asset_type_1 = require("../utils/is-asset-type");
+var round_decimal_1 = require("../utils/round-decimal");
 var transform_asset_address_1 = require("./transform-asset-address");
 var transform_percent_owned_1 = require("./transform-percent-owned");
 exports.propertyTypeNameList = Object.values(lixi_internal_request_2.Custom2PropertyTypeNameList);
@@ -85,6 +88,16 @@ function transformAsset(_a) {
                 case 'toBePurchased':
                     (0, lodash_1.set)(partialApplication, assetMapping[key], enum_mappings_1.toBePurchasedMapping[value]);
                     break;
+                case 'propertyExpenses':
+                    if (!asset.percentOwned) {
+                        break;
+                    }
+                    var propertyExpenses = generatePropertyExpenses(value);
+                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".PropertyExpense"), propertyExpenses);
+                    var livingExpenses = generateLivingExpenses(asset.percentOwned, id, value);
+                    (0, lodash_1.set)(partialApplication, assetMapping[key], livingExpenses);
+                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.RealEstateAsset, ".Occupancy"), determineOccupancy(value));
+                    break;
                 case 'propertyStatus':
                     (0, lodash_1.set)(partialApplication, assetMapping[key], enum_mappings_1.propertyStatusMapping[value]);
                     break;
@@ -185,6 +198,7 @@ function getAssetMapping(asset) {
             estimatedValue: estimatedValue,
             percentOwned: percentOwned,
             primaryPurpose: "".concat(application_paths_1.paths.RealEstateAsset, ".@PrimaryPurpose"),
+            propertyExpenses: application_paths_1.paths.LivingExpenses,
             propertyStatus: "".concat(application_paths_1.paths.RealEstateAsset, ".@Status"),
             propertyType: "".concat(application_paths_1.paths.RealEstateAsset, ".Residential"),
             toBePurchased: "".concat(application_paths_1.paths.RealEstateAsset, ".@Transaction"),
@@ -201,3 +215,85 @@ function getAssetMapping(asset) {
     return baseMapping;
 }
 exports.getAssetMapping = getAssetMapping;
+/**
+ * Creates living expense items from a propertyExpense object.
+ *
+ * @param percentOwned: owners of the property
+ * @param assetId: Asset id
+ * @param propertyExpenses: propertyExpenses items
+ */
+function generateLivingExpenses(percentOwned, assetId, propertyExpenses) {
+    var livingExpenses = [];
+    var filteredPropertyExpenses = propertyExpenses.filter(function (expense) { return expense.amount !== undefined; });
+    percentOwned.owners.forEach(function (owner) {
+        var expenses = filteredPropertyExpenses.map(function (expense) {
+            normalizeAmounts(expense);
+            return {
+                '@Amount': (0, round_decimal_1.roundDecimal)(expense.amount * owner.percent),
+                '@Category': enum_mappings_1.livingExpenseMapping[expense.type],
+                '@Frequency': enum_mappings_1.incomeExpenseFrequencyMapping[expense.frequency],
+                '@UniqueID': "".concat((0, uuid_1.v4)(), "-").concat(assetId),
+                PercentResponsible: {
+                    Owner: [
+                        {
+                            '@Percent': 100,
+                            '@x_Party': owner.applicantId
+                        },
+                    ]
+                }
+            };
+        });
+        livingExpenses = livingExpenses.concat(expenses);
+    });
+    return livingExpenses;
+}
+exports.generateLivingExpenses = generateLivingExpenses;
+/**
+ * Creates PropertyExpense array on RealEstateAsset from the same array on the event.
+ * @param propertyExpenses
+ */
+function generatePropertyExpenses(propertyExpenses) {
+    return propertyExpenses
+        .filter(function (expense) { return expense.amount !== undefined; })
+        .map(function (expense) {
+        normalizeAmounts(expense);
+        return {
+            '@Amount': expense.amount,
+            '@Category': enum_mappings_1.propertyExpenseCategoryMapping[expense.type],
+            '@Frequency': enum_mappings_1.incomeExpenseFrequencyMapping[expense.frequency]
+        };
+    });
+}
+exports.generatePropertyExpenses = generatePropertyExpenses;
+/**
+ * Determines the occupancy based on the list of property expense types available.
+ * @param propertyExpenses
+ */
+function determineOccupancy(propertyExpenses) {
+    var propertyExpenseCategoryList = propertyExpenses.map(function (expense) { return expense.type; });
+    if (propertyExpenseCategoryList.includes(public_asset_1.PropertyExpenseType.InvestmentPropertyRunningCosts)) {
+        return lixi_internal_request_1.OccupancyList.NonOwner;
+    }
+    else if (propertyExpenseCategoryList.includes(public_asset_1.PropertyExpenseType.PrimaryResidenceRunningCosts && public_asset_1.PropertyExpenseType.SecondaryResidenceRunningCosts)) {
+        return lixi_internal_request_1.OccupancyList.OwnerSecondary;
+    }
+    else if (propertyExpenseCategoryList.some(function (item) {
+        return item !== public_asset_1.PropertyExpenseType.SecondaryResidenceRunningCosts &&
+            item === public_asset_1.PropertyExpenseType.PrimaryResidenceRunningCosts;
+    })) {
+        return lixi_internal_request_1.OccupancyList.OwnerPrimary;
+    }
+}
+exports.determineOccupancy = determineOccupancy;
+/**
+ * Calculates the correct amount and frequency.
+ * @param expense
+ */
+function normalizeAmounts(expense) {
+    if (expense.frequency === public_expense_1.Frequency.Quarterly) {
+        expense.frequency = public_expense_1.Frequency.Yearly;
+        expense.amount *= 4;
+    }
+    return expense;
+}
+exports.normalizeAmounts = normalizeAmounts;

package/lib/types/enum-mappings/index.d.ts

@@ -14,6 +14,7 @@ export * from './marital-status';
 export * from './postcode';
 export * from './preferred-repayment';
 export * from './proof-of-identity';
+export * from './property-expense-category';
 export * from './public-financial-asset';
 export * from './public-primary-purpose';
 export * from './public-property-status';

package/lib/types/enum-mappings/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./marital-status"), exports);
 __exportStar(require("./postcode"), exports);
 __exportStar(require("./preferred-repayment"), exports);
 __exportStar(require("./proof-of-identity"), exports);
+__exportStar(require("./property-expense-category"), exports);
 __exportStar(require("./public-financial-asset"), exports);
 __exportStar(require("./public-primary-purpose"), exports);
 __exportStar(require("./public-property-status"), exports);

package/lib/types/enum-mappings/property-expense-category.d.ts

@@ -0,0 +1,7 @@
+import { PropertyExpenseCategoryList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { PropertyExpenseType } from '../events/public-asset';
+declare type PropertyExpenseCategoryMapping = {
+    [key in PropertyExpenseType]: PropertyExpenseCategoryList;
+};
+export declare const propertyExpenseCategoryMapping: PropertyExpenseCategoryMapping;
+export {};

package/lib/types/enum-mappings/property-expense-category.js

@@ -0,0 +1,12 @@
+"use strict";
+var _a;
+exports.__esModule = true;
+exports.propertyExpenseCategoryMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+var public_asset_1 = require("../events/public-asset");
+exports.propertyExpenseCategoryMapping = (_a = {},
+    _a[public_asset_1.PropertyExpenseType.BodyCorporateFeesStrataFeesAndLandTax] = lixi_internal_request_1.PropertyExpenseCategoryList.BodyCorporateFeesStrataFeesAndLandTax,
+    _a[public_asset_1.PropertyExpenseType.InvestmentPropertyRunningCosts] = lixi_internal_request_1.PropertyExpenseCategoryList.RunningCosts,
+    _a[public_asset_1.PropertyExpenseType.PrimaryResidenceRunningCosts] = lixi_internal_request_1.PropertyExpenseCategoryList.RunningCosts,
+    _a[public_asset_1.PropertyExpenseType.SecondaryResidenceRunningCosts] = lixi_internal_request_1.PropertyExpenseCategoryList.RunningCosts,
+    _a);

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

@@ -6,7 +6,7 @@ export interface PublicAsset {
     /**
      * schema version
      */
-    type: Type;
+    type: PublicAssetType;
     version: string;
 }
 /**
@@ -38,6 +38,7 @@ export interface Asset {
     model?: string;
     percentOwned?: PercentOwned;
     primaryPurpose?: PrimaryPurpose;
+    propertyExpenses?: PropertyExpense[];
     propertyStatus?: PropertyStatus;
     propertyType?: PropertyType;
     relationId?: string;
@@ -397,6 +398,25 @@ export declare enum PrimaryPurpose {
     Investment = "INVESTMENT",
     OwnerOccupied = "OWNER_OCCUPIED"
 }
+export interface PropertyExpense {
+    amount?: number;
+    comments?: string;
+    frequency?: Frequency;
+    type: PropertyExpenseType;
+}
+export declare enum Frequency {
+    Fortnightly = "FORTNIGHTLY",
+    Monthly = "MONTHLY",
+    Quarterly = "QUARTERLY",
+    Weekly = "WEEKLY",
+    Yearly = "YEARLY"
+}
+export declare enum PropertyExpenseType {
+    BodyCorporateFeesStrataFeesAndLandTax = "BODY_CORPORATE_FEES_STRATA_FEES_AND_LAND_TAX",
+    InvestmentPropertyRunningCosts = "INVESTMENT_PROPERTY_RUNNING_COSTS",
+    PrimaryResidenceRunningCosts = "PRIMARY_RESIDENCE_RUNNING_COSTS",
+    SecondaryResidenceRunningCosts = "SECONDARY_RESIDENCE_RUNNING_COSTS"
+}
 export declare enum PropertyStatus {
     Established = "ESTABLISHED",
     NewBuilding = "NEW_BUILDING",
@@ -462,7 +482,7 @@ export declare enum ActionedByRole {
 /**
  * schema version
  */
-export declare enum Type {
+export declare enum PublicAssetType {
     AssetCreated = "AssetCreated",
     AssetUpdated = "AssetUpdated"
 }

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

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.Type = exports.ActionedByRole = exports.ZoneType = exports.AssetType = exports.PropertyType = exports.PropertyStatus = exports.PrimaryPurpose = exports.Proportions = exports.Countries = void 0;
+exports.PublicAssetType = exports.ActionedByRole = exports.ZoneType = exports.AssetType = exports.PropertyType = exports.PropertyStatus = exports.PropertyExpenseType = exports.Frequency = exports.PrimaryPurpose = exports.Proportions = exports.Countries = void 0;
 var Countries;
 (function (Countries) {
     Countries["Afghanistan"] = "Afghanistan";
@@ -258,6 +258,21 @@ var PrimaryPurpose;
     PrimaryPurpose["Investment"] = "INVESTMENT";
     PrimaryPurpose["OwnerOccupied"] = "OWNER_OCCUPIED";
 })(PrimaryPurpose = exports.PrimaryPurpose || (exports.PrimaryPurpose = {}));
+var Frequency;
+(function (Frequency) {
+    Frequency["Fortnightly"] = "FORTNIGHTLY";
+    Frequency["Monthly"] = "MONTHLY";
+    Frequency["Quarterly"] = "QUARTERLY";
+    Frequency["Weekly"] = "WEEKLY";
+    Frequency["Yearly"] = "YEARLY";
+})(Frequency = exports.Frequency || (exports.Frequency = {}));
+var PropertyExpenseType;
+(function (PropertyExpenseType) {
+    PropertyExpenseType["BodyCorporateFeesStrataFeesAndLandTax"] = "BODY_CORPORATE_FEES_STRATA_FEES_AND_LAND_TAX";
+    PropertyExpenseType["InvestmentPropertyRunningCosts"] = "INVESTMENT_PROPERTY_RUNNING_COSTS";
+    PropertyExpenseType["PrimaryResidenceRunningCosts"] = "PRIMARY_RESIDENCE_RUNNING_COSTS";
+    PropertyExpenseType["SecondaryResidenceRunningCosts"] = "SECONDARY_RESIDENCE_RUNNING_COSTS";
+})(PropertyExpenseType = exports.PropertyExpenseType || (exports.PropertyExpenseType = {}));
 var PropertyStatus;
 (function (PropertyStatus) {
     PropertyStatus["Established"] = "ESTABLISHED";
@@ -315,8 +330,8 @@ var ActionedByRole;
 /**
  * schema version
  */
-var Type;
-(function (Type) {
-    Type["AssetCreated"] = "AssetCreated";
-    Type["AssetUpdated"] = "AssetUpdated";
-})(Type = exports.Type || (exports.Type = {}));
+var PublicAssetType;
+(function (PublicAssetType) {
+    PublicAssetType["AssetCreated"] = "AssetCreated";
+    PublicAssetType["AssetUpdated"] = "AssetUpdated";
+})(PublicAssetType = exports.PublicAssetType || (exports.PublicAssetType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.3.4",
+  "version": "1.3.7",
   "description": "Library for kafka event data transforming",
   "author": "Integrations <integrations@lendi.com.au>",
   "homepage": "https://bitbucket.org/lendi-dev/integrations-shared-packages#readme",
@@ -21,7 +21,7 @@
     "url": "git+ssh://git@bitbucket.org/lendi-dev/integrations-shared-packages.git"
   },
   "dependencies": {
-    "@lendi/integrations-credit-protocol": "1.15.8",
+    "@lendi/integrations-credit-protocol": "1.16.0",
     "@lendi/integrations-protocol": "2.5.4",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",