@lendi/integrations-transform 1.4.6 → 1.4.9

package/lib/index.d.ts

@@ -6,5 +6,5 @@ export * from './transform-events/transform-asset';
 export * from './transform-events/transform-expenses';
 export * from './transform-events/transform-liability';
 export * from './transform-events/generate-required-document';
-export * from './transform-events/generate-funding-position';
+export * from './transform-events/transform-funding-position';
 export * from './update-application/merge-application';

package/lib/index.js

@@ -23,5 +23,5 @@ __exportStar(require("./transform-events/transform-asset"), exports);
 __exportStar(require("./transform-events/transform-expenses"), exports);
 __exportStar(require("./transform-events/transform-liability"), exports);
 __exportStar(require("./transform-events/generate-required-document"), exports);
-__exportStar(require("./transform-events/generate-funding-position"), exports);
+__exportStar(require("./transform-events/transform-funding-position"), exports);
 __exportStar(require("./update-application/merge-application"), exports);

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

@@ -8,6 +8,7 @@
     },
     "brokerPrimaryPurpose": {
       "description": "Additional data point for broker to capture primary purpose, other than the preliminary primary purpose associated with current user journey for new purchase or refinance",
+      "_comment": "PURCHASE is deprecated (will migrated to NEW_PURCHASE), VARIATION is deprecated (domain variation/lendi variation brand will be migrated to VARIATION_NON_CREDIT_CRITICAL, domain/lendi brand will be migrated to VARIATION_CREDIT_CRITICAL) and both PURCHASE and VARIATION will be removed in the future",
       "enum": [
         "COMMERCIAL",
         "CONSTRUCTION",
@@ -21,7 +22,9 @@
         "REFINANCE",
         "SLR",
         "TOP_UP",
-        "VARIATION"
+        "VARIATION",
+        "VARIATION_CREDIT_CRITICAL",
+        "VARIATION_NON_CREDIT_CRITICAL"
       ]
     },
     "customerId": {
@@ -83,10 +86,12 @@
       "type": "boolean"
     },
     "totalMonthlyExpenses": {
-      "type": "number"
+      "type": "number",
+      "minimum": 0
     },
     "numberOfDependants": {
-      "type": "number"
+      "type": "number",
+      "minimum": 0
     },
     "contributions": {
       "type": "array",
@@ -98,7 +103,8 @@
             "enum": ["DEPOSIT"]
           },
           "amount": {
-            "type": "number"
+            "type": "number",
+            "minimum": 0
           }
         }
       }
@@ -109,6 +115,13 @@
         "enum": ["CONSOLIDATE_CASHOUT", "FASTER_PAYOFF", "DECREASE_REPAYMENTS", "CONSTRUCTION"]
       }
     },
+    "highIntent": {
+      "description": "Indication that this application carries high customer intent",
+      "type": "boolean"
+    },
+    "hasOptedInRateLock": {
+      "type": "boolean"
+    },
     "payload": {
       "type": "object",
       "additionalProperties": false,
@@ -137,6 +150,9 @@
         "brand": {
           "enum": ["lendi", "domain", "domain variation", "lendi variation"]
         },
+        "hasOptedInRateLock": {
+          "$ref": "#/definitions/hasOptedInRateLock"
+        },
         "preliminary": {
           "type": "object",
           "additionalProperties": false,
@@ -191,6 +207,9 @@
               "$ref": "#/definitions/contributions"
             }
           }
+        },
+        "highIntent": {
+          "$ref": "#/definitions/highIntent"
         }
       },
       "required": ["id", "preliminary"]

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

@@ -2,10 +2,11 @@
 exports.__esModule = true;
 exports.transformApplication = void 0;
 var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
-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 application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
+var application_paths_2 = require("@lendi/integrations-protocol/lib/utils/application-paths");
 var lodash_1 = require("lodash");
 var enum_mappings_1 = require("../types/enum-mappings/");
+var transform_applicant_1 = require("./transform-applicant");
 /**
  * Transforms a partial opportunity event to a partial internal request.
  *
@@ -15,16 +16,18 @@ var enum_mappings_1 = require("../types/enum-mappings/");
 function transformApplication(opportunity) {
     var partialApplication = {};
     var opportunityMapping = {
-        brand: application_paths_1.paths.BusinessName,
-        id: application_paths_1.paths.ApplicationId,
-        paymentType: "".concat(application_paths_1.paths.LoanTerm, ".@PaymentType"),
+        brand: application_paths_2.paths.BusinessName,
+        id: application_paths_2.paths.ApplicationId,
+        paymentType: "".concat(application_paths_2.paths.LoanTerm, ".@PaymentType"),
         preliminary: 'preliminary',
-        primaryPurpose: application_paths_1.paths.PurposeOfApplication,
-        brokerPrimaryPurpose: 'Package.Content.NeedsAnalysis.PurposeOfApplication[0].@Description'
+        primaryPurpose: application_paths_2.paths.PurposeOfApplication,
+        brokerPrimaryPurpose: 'Package.Content.NeedsAnalysis.PurposeOfApplication[0].@Description',
+        hasOptedInRateLock: "".concat(application_paths_1.paths.FeaturesSelected, ".@RateLock")
     };
-    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.LoanDetail, ".@UniqueID"), "".concat(opportunity.id, "-loanDetails"));
-    (0, lodash_1.set)(partialApplication, "".concat(application_paths_2.paths.Instructions, ".@UniqueID"), "".concat(opportunity.id, "-stage"));
-    (0, lodash_1.set)(partialApplication, "".concat(application_paths_2.paths.Instructions, ".@Name"), lixi_internal_request_1.EventNameApplicationInstructionsList.ApplicationReceived);
+    (0, lodash_1.set)(partialApplication, "".concat(application_paths_2.paths.LoanDetail, ".@UniqueID"), "".concat(opportunity.id, "-loanDetails"));
+    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.Instructions, ".@UniqueID"), "".concat(opportunity.id, "-stage"));
+    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.Instructions, ".@Name"), lixi_internal_request_1.EventNameApplicationInstructionsList.ApplicationReceived);
+    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.FeaturesSelected, ".@RateLock"), lixi_internal_request_1.YesNoList.No);
     for (var _i = 0, _a = Object.entries(opportunity); _i < _a.length; _i++) {
         var _b = _a[_i], opportunityKey = _b[0], opportunityValue = _b[1];
         if (opportunityMapping[opportunityKey]) {
@@ -43,6 +46,9 @@ function transformApplication(opportunity) {
                     }
                 }
             }
+            else if (opportunityKey === 'hasOptedInRateLock') {
+                (0, lodash_1.set)(partialApplication, opportunityMapping[opportunityKey], (0, transform_applicant_1.booleanMapping)(opportunityValue));
+            }
             else {
                 (0, lodash_1.set)(partialApplication, opportunityMapping[opportunityKey], opportunityValue);
             }

package/lib/transform-events/{generate-funding-position.d.ts → transform-funding-position.d.ts}

@@ -1,18 +1,20 @@
 import { Fee } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-import { FundsRequiredBreakdown } from '../types/events/public-funding-position';
-import { Payload as FundingPositionPayload } from '../types/events/public-funding-position';
+import { FundsRequiredBreakdown, Payload as FundingPositionPayload } from '../types/events/public-funding-position';
+import { PartialApplication } from '../types/partial-application';
 /**
  * GenerateFundingPosition
  *
  * @param fundingPosition a partialFundingPosition.
  * @return partialApplication with fees, grants and borrowers contributions added.
  */
-export declare function generateFundingPosition(fundingPosition: FundingPositionPayload): {};
+export declare function transformFundingPosition(fundingPosition: FundingPositionPayload): PartialApplication;
 /**
  * getFee
  *
  * @param fundsRequiredBreakDown a FundsRequiredBreakdown.
+ * @param lmi
+ * @param lmiIncluded
  * @param id
  * @return Array of fees
  */
-export declare function getFees(fundsRequiredBreakDown: FundsRequiredBreakdown, id: string): Fee[];
+export declare function getFees(fundsRequiredBreakDown: FundsRequiredBreakdown, lmi: number, lmiIncluded: boolean, id: string): Fee[];

package/lib/transform-events/{generate-funding-position.js → transform-funding-position.js}

@@ -1,19 +1,20 @@
 "use strict";
 exports.__esModule = true;
-exports.getFees = exports.generateFundingPosition = void 0;
-var lodash_1 = require("lodash");
+exports.getFees = exports.transformFundingPosition = 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 funding_position_1 = require("../types/enum-mappings/funding-position");
+var lodash_1 = require("lodash");
+var enum_mappings_1 = require("../types/enum-mappings");
 /**
  * GenerateFundingPosition
  *
  * @param fundingPosition a partialFundingPosition.
  * @return partialApplication with fees, grants and borrowers contributions added.
  */
-function generateFundingPosition(fundingPosition) {
+function transformFundingPosition(fundingPosition) {
     var partialApplication = {};
     var contributionFunds = [];
-    var applicationId = fundingPosition.applicationId, id = fundingPosition.id;
+    var applicationId = fundingPosition.applicationId, id = fundingPosition.id, _a = fundingPosition.lmi, lmi = _a === void 0 ? 0 : _a, _b = fundingPosition.lmiIncluded, lmiIncluded = _b === void 0 ? false : _b;
     var fundingPositionMapping = {
         applicationId: application_paths_1.paths.ApplicationId,
         fundsRequested: "".concat(application_paths_1.paths.RolledUpAmounts, ".@TotalNewFunds"),
@@ -23,24 +24,24 @@ function generateFundingPosition(fundingPosition) {
         totalCashOut: "".concat(application_paths_1.paths.EquityRelease, ".Amount.@LumpSum"),
         fundsRequiredBreakdown: application_paths_1.paths.SummaryFee
     };
-    for (var _i = 0, _a = Object.entries(fundingPosition); _i < _a.length; _i++) {
-        var _b = _a[_i], key = _b[0], value = _b[1];
+    for (var _i = 0, _c = Object.entries(fundingPosition); _i < _c.length; _i++) {
+        var _d = _c[_i], key = _d[0], value = _d[1];
         if (fundingPositionMapping[key]) {
             switch (key) {
                 case 'totalGovernmentContributions':
                 case 'totalDeposit':
                     contributionFunds.push({
                         '@Amount': value,
-                        '@Type': funding_position_1.contributionMapping[key],
+                        '@Type': enum_mappings_1.contributionMapping[key],
                         '@UniqueID': "".concat(id, "-").concat(key)
                     });
                     break;
                 case 'fundsRequiredBreakdown':
-                    (0, lodash_1.set)(partialApplication, application_paths_1.paths.SummaryFee, getFees(value, id));
+                    (0, lodash_1.set)(partialApplication, application_paths_1.paths.SummaryFee, getFees(value, lmi, lmiIncluded, id));
                     break;
                 case 'totalCashOut':
                     (0, lodash_1.set)(partialApplication, fundingPositionMapping[key], value);
-                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.LoanDetail, ".@UniqueID"), "".concat(applicationId, "-loanDetails"));
+                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.LoanDetail, ".@UniqueID"), "".concat(applicationId, "-0"));
                     break;
                 case 'fundsRequested':
                     (0, lodash_1.set)(partialApplication, fundingPositionMapping[key], Math.round(value));
@@ -54,27 +55,39 @@ function generateFundingPosition(fundingPosition) {
     (0, lodash_1.set)(partialApplication, application_paths_1.paths.ContributionFunds, contributionFunds);
     return partialApplication;
 }
-exports.generateFundingPosition = generateFundingPosition;
+exports.transformFundingPosition = transformFundingPosition;
 /**
  * getFee
  *
  * @param fundsRequiredBreakDown a FundsRequiredBreakdown.
+ * @param lmi
+ * @param lmiIncluded
  * @param id
  * @return Array of fees
  */
-function getFees(fundsRequiredBreakDown, id) {
+function getFees(fundsRequiredBreakDown, lmi, lmiIncluded, id) {
+    // Adding lmi to fees to be transformed.
+    (0, lodash_1.set)(fundsRequiredBreakDown, 'lmi', lmi);
     // Omitting constructionCosts as they don't belong in fees.
     return Object.entries((0, lodash_1.omit)(fundsRequiredBreakDown, 'constructionCosts')).map(function (_a) {
         var key = _a[0], value = _a[1];
         var descriptionList = ['accruedInterest', 'otherSundries'];
         var fee = {
             '@Amount': value,
-            '@Category': funding_position_1.categoryMapping[key],
-            '@Type': funding_position_1.typeMapping[key],
+            '@Category': enum_mappings_1.categoryMapping[key],
+            '@Type': enum_mappings_1.typeMapping[key],
             '@UniqueID': "".concat(id, "-").concat(key)
         };
         if (descriptionList.includes(key)) {
-            fee['@Description'] = funding_position_1.descriptionMapping[key];
+            fee['@Description'] = enum_mappings_1.descriptionMapping[key];
+        }
+        if (key === 'lmi') {
+            if (lmiIncluded)
+                fee['@CapitaliseFee'] = lixi_internal_request_1.YesNoList.Yes;
+            // If lmiIncluded is undefined we do not want to set '@CapitaliseFee'
+            // only if it is false as this will affect how we handle migration.
+            if (lmiIncluded === false)
+                fee['@CapitaliseFee'] = lixi_internal_request_1.YesNoList.No;
         }
         return fee;
     });

package/lib/types/enum-mappings/funding-position.js

@@ -11,7 +11,8 @@ exports.categoryMapping = {
     otherSundries: lixi_internal_request_1.FeeCategoryList.Other,
     stampDuty: lixi_internal_request_1.FeeCategoryList.Government,
     transferFee: lixi_internal_request_1.FeeCategoryList.Government,
-    foreignBuyerSurcharge: lixi_internal_request_1.FeeCategoryList.Government
+    foreignBuyerSurcharge: lixi_internal_request_1.FeeCategoryList.Government,
+    lmi: lixi_internal_request_1.FeeCategoryList.Bank
 };
 exports.typeMapping = {
     accruedInterest: lixi_internal_request_1.FeeTypeList.Other,
@@ -22,7 +23,8 @@ exports.typeMapping = {
     otherSundries: lixi_internal_request_1.FeeTypeList.Other,
     stampDuty: lixi_internal_request_1.FeeTypeList.StampDutyOnMortgage,
     transferFee: lixi_internal_request_1.FeeTypeList.TitleTransferFee,
-    foreignBuyerSurcharge: lixi_internal_request_1.FeeTypeList.Other
+    foreignBuyerSurcharge: lixi_internal_request_1.FeeTypeList.Other,
+    lmi: lixi_internal_request_1.FeeTypeList.Lmi
 };
 exports.descriptionMapping = {
     accruedInterest: lixi_internal_request_1.Custom4DescriptionList.PotentialAccruedInterest,

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

@@ -14,7 +14,9 @@ export interface Payload {
     brokerPrimaryPurpose?: BrokerPrimaryPurpose;
     clonedFromApplicationId?: string;
     customerId?: string;
+    hasOptedInRateLock?: boolean;
     hidden?: boolean;
+    highIntent?: boolean;
     id: string;
     meta?: ApplicationMeta;
     name?: string;
@@ -43,7 +45,9 @@ export declare enum BrokerPrimaryPurpose {
     Refinance = "REFINANCE",
     Slr = "SLR",
     TopUp = "TOP_UP",
-    Variation = "VARIATION"
+    Variation = "VARIATION",
+    VariationCreditCritical = "VARIATION_CREDIT_CRITICAL",
+    VariationNonCreditCritical = "VARIATION_NON_CREDIT_CRITICAL"
 }
 /**
  * The metadata of the application

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

@@ -27,6 +27,8 @@ var BrokerPrimaryPurpose;
     BrokerPrimaryPurpose["Slr"] = "SLR";
     BrokerPrimaryPurpose["TopUp"] = "TOP_UP";
     BrokerPrimaryPurpose["Variation"] = "VARIATION";
+    BrokerPrimaryPurpose["VariationCreditCritical"] = "VARIATION_CREDIT_CRITICAL";
+    BrokerPrimaryPurpose["VariationNonCreditCritical"] = "VARIATION_NON_CREDIT_CRITICAL";
 })(BrokerPrimaryPurpose = exports.BrokerPrimaryPurpose || (exports.BrokerPrimaryPurpose = {}));
 /**
  * role of the user that made the action

package/package.json

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