@lendi/integrations-transform 1.3.2 → 1.3.6

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 } 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,11 @@ 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 generatePropertyExpenses(percentOwned: PercentOwned, assetId: string, propertyExpenses: PropertyExpense[]): LivingExpense[];

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.generatePropertyExpenses = 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,13 @@ 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(asset.percentOwned, id, value);
+                    (0, lodash_1.set)(partialApplication, assetMapping[key], propertyExpenses);
+                    break;
                 case 'propertyStatus':
                     (0, lodash_1.set)(partialApplication, assetMapping[key], enum_mappings_1.propertyStatusMapping[value]);
                     break;
@@ -185,6 +195,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 +212,39 @@ 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 generatePropertyExpenses(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) {
+            if (expense.frequency === public_expense_1.Frequency.Quarterly) {
+                expense.frequency = public_expense_1.Frequency.Yearly;
+                expense.amount *= 4;
+            }
+            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.generatePropertyExpenses = generatePropertyExpenses;

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

@@ -50,7 +50,7 @@ function transformLiability(_a) {
     // Currently repayments is not captured for store cards and credit cards, default the monthly repayment amount to
     // the credit limit with interest rate of 3%.
     if ([public_liability_1.LiabilityType.CreditCard, public_liability_1.LiabilityType.StoreCard].includes(liability.type) && liability.creditLimit) {
-        (0, lodash_1.set)(partialApplication, liabilityMapping.repaymentAmount, liability.creditLimit * 0.03);
+        (0, lodash_1.set)(partialApplication, liabilityMapping.repaymentAmount, (0, round_decimal_1.roundDecimal)(liability.creditLimit * 0.03));
         (0, lodash_1.set)(partialApplication, liabilityMapping.repaymentFrequency, lixi_internal_request_1.List.Monthly);
     }
     // Default clearingFromThisLoan to No if the value is not present in the event.

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.2",
+  "version": "1.3.6",
   "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.6",
+    "@lendi/integrations-credit-protocol": "1.15.8",
     "@lendi/integrations-protocol": "2.5.4",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",
@@ -30,11 +30,8 @@
   },
   "devDependencies": {
     "@lendi/prettier-config": "^1.0.0",
-    "@lendi/tslint-config": "^1.1.0",
     "@lendi/typescript-config": "^2.0.0",
-    "@types/convict": "^4.2.1",
-    "@types/delay": "^3.1.0",
-    "@types/jest": "^24.0.21",
+    "@types/jest": "^26.0.14",
     "@types/lodash": "^4.14.141",
     "@types/node": "^12.12.5",
     "@types/pino": "^6.3.3",
@@ -50,7 +47,6 @@
     "jest": "^26.6.3",
     "jest-buildkite-reporter": "^0.2.8",
     "jest-sonar-reporter": "^2.0.0",
-    "lint-staged": "^9.4.1",
     "path": "^0.12.7",
     "prettier": "^2.2.1",
     "prettier-check": "^2.0.0",
@@ -59,8 +55,6 @@
     "sinon": "^7.4.2",
     "ts-jest": "^26.5.0",
     "ts-node": "^8.4.1",
-    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.18.0",
     "typedoc": "^0.20.36",
     "typescript": "^4.1.3"
   },