@lendi/integrations-transform 1.3.5 → 1.3.8

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

@@ -442,6 +442,10 @@
     "constructionDetails": {
       "type": "object",
       "properties": {
+        "constructionType": {
+          "type": "string",
+          "enum": ["STRUCTURAL_RENOVATIONS", "BUILD_A_PROPERTY", "KNOCKDOWN_REBUILD"]
+        },
         "buildPriceAmount": {
           "type": "number"
         },
@@ -451,6 +455,16 @@
         },
         "landEstimatedValue": {
           "type": "number"
+        },
+        "otherConstructionCosts": {
+          "type": "number"
+        },
+        "builderType": {
+          "type": "string",
+          "enum": ["LICENSED_BUILDER", "OWNER_BUILDER"]
+        },
+        "isFixedPriceContract": {
+          "type": "boolean"
         }
       }
     },
@@ -479,6 +493,9 @@
       "description": "The unique number assigned to the Financial Institution account",
       "example": "999994"
     },
+    "isConstruction": {
+      "type": "boolean"
+    },
     "dataType": {
       "type": "string"
     },
@@ -602,6 +619,9 @@
         "constructionDetails": {
           "$ref": "#/definitions/constructionDetails"
         },
+        "isConstruction": {
+          "$ref": "#/definitions/isConstruction"
+        },
         "make": {
           "$ref": "#/definitions/make"
         },

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

@@ -1,4 +1,4 @@
-import { LivingExpense } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+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, PercentOwned, PropertyExpense, PropertyType } from '../types/events/public-asset';
 import { PartialApplication } from '../types/partial-application';
@@ -31,6 +31,22 @@ 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, propertyExpenses: PropertyExpense[]): LivingExpense[];
+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,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 exports.__esModule = true;
-exports.generatePropertyExpenses = 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");
@@ -26,8 +26,22 @@ 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");
+var builder_type_1 = require("../types/enum-mappings/builder-type");
+var construction_type_1 = require("../types/enum-mappings/construction-type");
+var __1 = require("..");
 exports.propertyTypeNameList = Object.values(lixi_internal_request_2.Custom2PropertyTypeNameList);
 exports.residentialTypeList = Object.values(lixi_internal_request_1.ResidentialTypeList);
+// will add this path to protocol
+var constructionDetailsPath = "".concat(application_paths_1.paths.RealEstateAsset, ".ConstructionDetails");
+var constructionDetailsMapping = {
+    builderType: "".concat(constructionDetailsPath, ".@BuilderType"),
+    buildPriceAmount: "".concat(constructionDetailsPath, ".@BuildPriceAmount"),
+    constructionType: "".concat(constructionDetailsPath, ".@Type"),
+    estimatedValue: "".concat(constructionDetailsPath, ".@TotalAmount"),
+    isFixedPriceContract: "".concat(constructionDetailsPath, ".@FixedPriceContract"),
+    landEstimatedValue: "".concat(constructionDetailsPath, ".@LandValue"),
+    otherConstructionCosts: "".concat(constructionDetailsPath, ".@OutOfContractItemsCost")
+};
 /**
  * Generates a partial internal request from a partial public asset event.
  *
@@ -92,8 +106,11 @@ function transformAsset(_a) {
                     if (!asset.percentOwned) {
                         break;
                     }
-                    var propertyExpenses = generatePropertyExpenses(asset.percentOwned, value);
-                    (0, lodash_1.set)(partialApplication, assetMapping[key], propertyExpenses);
+                    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]);
@@ -137,6 +154,31 @@ function transformAsset(_a) {
                         (0, lodash_1.set)(partialApplication, assetMapping[key], percentOwned);
                     }
                     break;
+                case 'constructionDetails':
+                    for (var _d = 0, _e = Object.entries(value); _d < _e.length; _d++) {
+                        var _f = _e[_d], key_1 = _f[0], constructionDetailsValue = _f[1];
+                        switch (key_1) {
+                            case 'builderType':
+                                (0, lodash_1.set)(partialApplication, constructionDetailsMapping[key_1], builder_type_1.builderTypeMapping[constructionDetailsValue]);
+                                break;
+                            case 'constructionType':
+                                (0, lodash_1.set)(partialApplication, constructionDetailsMapping[key_1], construction_type_1.constructionTypeMapping[constructionDetailsValue]);
+                                break;
+                            case 'isFixedPriceContract':
+                                (0, lodash_1.set)(partialApplication, constructionDetailsMapping[key_1], (0, __1.booleanMapping)(constructionDetailsValue));
+                                break;
+                            default:
+                                (0, lodash_1.set)(partialApplication, constructionDetailsMapping[key_1], constructionDetailsValue);
+                                break;
+                        }
+                    }
+                    break;
+                case 'estimatedValue':
+                    if (asset.isConstruction) {
+                        (0, lodash_1.set)(partialApplication, constructionDetailsMapping[key], value);
+                    }
+                    (0, lodash_1.set)(partialApplication, assetMapping[key], value);
+                    break;
                 default:
                     (0, lodash_1.set)(partialApplication, assetMapping[key], value);
                     break;
@@ -200,7 +242,9 @@ function getAssetMapping(asset) {
             propertyType: "".concat(application_paths_1.paths.RealEstateAsset, ".Residential"),
             toBePurchased: "".concat(application_paths_1.paths.RealEstateAsset, ".@Transaction"),
             toBeUsedAsSecurity: "".concat(application_paths_1.paths.RealEstateAsset, ".@ToBeUsedAsSecurity"),
-            zoneType: "".concat(application_paths_1.paths.RealEstateAsset, ".Zoning.@Type")
+            zoneType: "".concat(application_paths_1.paths.RealEstateAsset, ".Zoning.@Type"),
+            isConstruction: "".concat(application_paths_1.paths.RealEstateAsset, ".@Construction"),
+            constructionDetails: "".concat(application_paths_1.paths.RealEstateAsset, ".ConstructionDetails")
         };
     }
     if ((0, is_asset_type_1.isMotorVehicle)(asset)) {
@@ -216,22 +260,20 @@ 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, propertyExpenses) {
+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) {
-            if (expense.frequency === public_expense_1.Frequency.Quarterly) {
-                expense.frequency = public_expense_1.Frequency.Yearly;
-                expense.amount *= 4;
-            }
+            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': (0, uuid_1.v4)(),
+                '@UniqueID': "".concat((0, uuid_1.v4)(), "--").concat(assetId),
                 PercentResponsible: {
                     Owner: [
                         {
@@ -246,4 +288,53 @@ function generatePropertyExpenses(percentOwned, propertyExpenses) {
     });
     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/builder-type.d.ts

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

package/lib/types/enum-mappings/builder-type.js

@@ -0,0 +1,10 @@
+"use strict";
+var _a;
+exports.__esModule = true;
+exports.builderTypeMapping = 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.builderTypeMapping = (_a = {},
+    _a[public_asset_1.BuilderType.LicensedBuilder] = lixi_internal_request_1.BuilderTypeList.LicensedBuilder,
+    _a[public_asset_1.BuilderType.OwnerBuilder] = lixi_internal_request_1.BuilderTypeList.OwnerBuilder,
+    _a);

package/lib/types/enum-mappings/construction-type.d.ts

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

package/lib/types/enum-mappings/construction-type.js

@@ -0,0 +1,11 @@
+"use strict";
+var _a;
+exports.__esModule = true;
+exports.constructionTypeMapping = 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.constructionTypeMapping = (_a = {},
+    _a[public_asset_1.ConstructionType.BuildAProperty] = lixi_internal_request_1.ConstructionTypeList.FullConstruction,
+    _a[public_asset_1.ConstructionType.KnockdownRebuild] = lixi_internal_request_1.ConstructionTypeList.FullConstruction,
+    _a[public_asset_1.ConstructionType.StructuralRenovations] = lixi_internal_request_1.ConstructionTypeList.Renovation,
+    _a);

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

@@ -33,6 +33,7 @@ export interface Asset {
     financialInstitutionAccountNumber?: string;
     financialInstitutionBsb?: string;
     financialInstitutionShortName?: string;
+    isConstruction?: boolean;
     knockDownToRebuild?: boolean;
     make?: string;
     model?: string;
@@ -346,7 +347,20 @@ export interface ConstructionDetails {
      */
     buildIn6Months?: boolean;
     buildPriceAmount?: number;
+    builderType?: BuilderType;
+    constructionType?: ConstructionType;
+    isFixedPriceContract?: boolean;
     landEstimatedValue?: number;
+    otherConstructionCosts?: number;
+}
+export declare enum BuilderType {
+    LicensedBuilder = "LICENSED_BUILDER",
+    OwnerBuilder = "OWNER_BUILDER"
+}
+export declare enum ConstructionType {
+    BuildAProperty = "BUILD_A_PROPERTY",
+    KnockdownRebuild = "KNOCKDOWN_REBUILD",
+    StructuralRenovations = "STRUCTURAL_RENOVATIONS"
 }
 /**
  * Details of the purchase/sale price as specified in the Contract of Sale

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

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.PublicAssetType = exports.ActionedByRole = exports.ZoneType = exports.AssetType = exports.PropertyType = exports.PropertyStatus = exports.PropertyExpenseType = exports.Frequency = 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.ConstructionType = exports.BuilderType = exports.Countries = void 0;
 var Countries;
 (function (Countries) {
     Countries["Afghanistan"] = "Afghanistan";
@@ -243,6 +243,17 @@ var Countries;
     Countries["Zambia"] = "Zambia";
     Countries["Zimbabwe"] = "Zimbabwe";
 })(Countries = exports.Countries || (exports.Countries = {}));
+var BuilderType;
+(function (BuilderType) {
+    BuilderType["LicensedBuilder"] = "LICENSED_BUILDER";
+    BuilderType["OwnerBuilder"] = "OWNER_BUILDER";
+})(BuilderType = exports.BuilderType || (exports.BuilderType = {}));
+var ConstructionType;
+(function (ConstructionType) {
+    ConstructionType["BuildAProperty"] = "BUILD_A_PROPERTY";
+    ConstructionType["KnockdownRebuild"] = "KNOCKDOWN_REBUILD";
+    ConstructionType["StructuralRenovations"] = "STRUCTURAL_RENOVATIONS";
+})(ConstructionType = exports.ConstructionType || (exports.ConstructionType = {}));
 /**
  * Indicate whether ownership proportions are equal, specified individually for each one or
  * not specified.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.3.5",
+  "version": "1.3.8",
   "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.2",
     "@lendi/integrations-protocol": "2.5.4",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",