@lendi/integrations-transform 1.2.7 → 1.3.1

package/lib/index.d.ts

@@ -1,9 +1,10 @@
 export * from './transform-events/transform-applicant';
 export * from './transform-events/transform-application';
+export * from './transform-events/transform-application-workflow';
 export * from './transform-events/transform-income';
 export * from './transform-events/transform-asset';
 export * from './transform-events/transform-expenses';
-export * from './transform-events/generate-liability';
+export * from './transform-events/transform-liability';
 export * from './transform-events/generate-required-document';
 export * from './transform-events/generate-funding-position';
 export * from './update-application/merge-application';

package/lib/index.js

@@ -13,10 +13,11 @@ exports.__esModule = true;
 /* istanbul ignore file  */
 __exportStar(require("./transform-events/transform-applicant"), exports);
 __exportStar(require("./transform-events/transform-application"), exports);
+__exportStar(require("./transform-events/transform-application-workflow"), exports);
 __exportStar(require("./transform-events/transform-income"), exports);
 __exportStar(require("./transform-events/transform-asset"), exports);
 __exportStar(require("./transform-events/transform-expenses"), exports);
-__exportStar(require("./transform-events/generate-liability"), 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("./update-application/merge-application"), exports);

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

@@ -11,15 +11,15 @@
         },
         "reviewType": {
           "type": "string",
-          "description": "The Broker Audit Review record type",
+          "description": "The Broker Audit Review record type"
         },
         "status": {
           "type": "string",
-          "description": "The Broker Audit Review status",
+          "description": "The Broker Audit Review status"
         },
         "outcome": {
           "type": "string",
-          "description": "The Broker Audit Review outcome",
+          "description": "The Broker Audit Review outcome"
         },
         "completedBy": {
           "type": "string",
@@ -218,12 +218,7 @@
           }
         }
       },
-      "anyOf": [
-        { "required": ["applicationId", "stage", "status", "brokerAuditReview"] },
-        {
-          "required": ["applicationId", "stage", "status", "applicationStage", "applicationStatus", "brokerAuditReview"]
-        }
-      ]
+      "required": ["applicationId", "stage", "status", "brokerAuditReview"]
     }
   },
   "type": "object",

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

@@ -61,6 +61,21 @@
     "financialInstitution": {
       "type": "string"
     },
+    "financialInstitutionShortName": {
+      "type": "string"
+    },
+    "FinancialInstitutionBsb": {
+      "type": "string",
+      "pattern": "^\\d{6}$",
+      "description": "The BSB number identifying where the account is held within the Financial Institution",
+      "example": "123456"
+    },
+    "FinancialInstitutionAccountNumber": {
+      "type": "string",
+      "pattern": "^\\d{0,10}$",
+      "description": "The unique number assigned to the Financial Institution account",
+      "example": "999994"
+    },
     "repaymentAmount": {
       "type": "number"
     },
@@ -145,6 +160,15 @@
         "financialInstitution": {
           "$ref": "#/definitions/financialInstitution"
         },
+        "financialInstitutionShortName": {
+          "$ref": "#/definitions/financialInstitutionShortName"
+        },
+        "financialInstitutionBsb": {
+          "$ref": "#/definitions/FinancialInstitutionBsb"
+        },
+        "financialInstitutionAccountNumber": {
+          "$ref": "#/definitions/FinancialInstitutionAccountNumber"
+        },
         "repaymentAmount": {
           "$ref": "#/definitions/repaymentAmount"
         },
@@ -191,7 +215,7 @@
           "$ref": "#/definitions/description"
         }
       },
-      "required": ["outstandingBalance", "percentOwned", "type"]
+      "required": ["type", "outstandingBalance"]
     },
     "LiabilityPayload": {
       "type": "object",

package/lib/transform-events/transform-application-workflow.d.ts

@@ -1,8 +1,8 @@
-import { ApplicationWorkflowClass } from '../types/events/application-workflow';
+import { PayloadClass as ApplicationWorkflow } from '../types/events/application-workflow';
 /**
- * Generates a partial internal request from a partial opportunity event.
+ * Generates a partial internal request from a partial application workflow event.
  *
  * @return  partialApplication: A partial internal request.
  * @param applicationWorkflow: ApplicationWorkflow object.
  */
-export declare function transformApplicationWorkflow(applicationWorkflow: ApplicationWorkflowClass): {};
+export declare function transformApplicationWorkflow(applicationWorkflow: ApplicationWorkflow): {};

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

@@ -4,7 +4,7 @@ exports.transformApplicationWorkflow = void 0;
 var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
 var lodash_1 = require("lodash");
 /**
- * Generates a partial internal request from a partial opportunity event.
+ * Generates a partial internal request from a partial application workflow event.
  *
  * @return  partialApplication: A partial internal request.
  * @param applicationWorkflow: ApplicationWorkflow object.
@@ -20,7 +20,7 @@ function transformApplicationWorkflow(applicationWorkflow) {
         if (opportunityMapping[key]) {
             if (key === 'stage') {
                 (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.Instructions, ".@UniqueID"), "".concat(applicationWorkflow.applicationId, "-stage"));
-                (0, lodash_1.set)(partialApplication, "".concat(opportunityMapping[key], ".@Details"), (0, lodash_1.capitalize)(value) || 'Unknown');
+                (0, lodash_1.set)(partialApplication, "".concat(opportunityMapping[key], ".@Details"), value || 'Unknown');
             }
             else {
                 (0, lodash_1.set)(partialApplication, opportunityMapping[key], value);

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

@@ -1,8 +1,9 @@
 import { LiabilityPayload } from '../types/events/public-liability';
+import { PartialApplication } from '../types/partial-application';
 /**
  * Generates a partial internal request from a liability event payload.
  *
  * @param liabilityPayload: A liability event payload.
  * @return A partial InternalRequest.
  */
-export declare function generateLiability({ applicationId, id, liability }: LiabilityPayload): {};
+export declare function transformLiability({ applicationId, id, liability }: LiabilityPayload): PartialApplication;

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

@@ -1,22 +1,24 @@
 "use strict";
 exports.__esModule = true;
-exports.generateLiability = void 0;
+exports.transformLiability = void 0;
 var application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
 var lodash_1 = require("lodash");
 var alieo_frequency_1 = require("../types/enum-mappings/alieo-frequency");
 var liability_payment_type_1 = require("../types/enum-mappings/liability-payment-type");
 var liability_type_1 = require("../types/enum-mappings/liability-type");
+var public_liability_1 = require("../types/events/public-liability");
 var get_financial_institution_1 = require("../utils/get-financial-institution");
 var round_decimal_1 = require("../utils/round-decimal");
 var transform_percent_owned_1 = require("./transform-percent-owned");
 var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
+var lixi_internal_request_2 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
 /**
  * Generates a partial internal request from a liability event payload.
  *
  * @param liabilityPayload: A liability event payload.
  * @return A partial InternalRequest.
  */
-function generateLiability(_a) {
+function transformLiability(_a) {
     var applicationId = _a.applicationId, id = _a.id, liability = _a.liability;
     var partialApplication = {};
     var liabilityMapping = {
@@ -26,7 +28,11 @@ function generateLiability(_a) {
         clearingFromThisLoan: "".concat(application_paths_1.paths.Liability, ".@ClearingFromThisLoan"),
         description: "".concat(application_paths_1.paths.Liability, ".@Description"),
         financialInstitution: "".concat(application_paths_1.paths.Liability, ".AccountNumber.@FinancialInstitution"),
-        newLimit: "".concat(application_paths_1.paths.Liability, ".@CreditLimit"),
+        financialInstitutionAccountNumber: "".concat(application_paths_1.paths.Liability, ".AccountNumber.@AccountNumber"),
+        financialInstitutionBsb: "".concat(application_paths_1.paths.Liability, ".AccountNumber.@BSB"),
+        interestOnlyRemainingTerm: "".concat(application_paths_1.paths.Liability, ".OriginalTerm.@PaymentTypeDuration"),
+        creditLimit: "".concat(application_paths_1.paths.Liability, ".@CreditLimit"),
+        newLimit: "".concat(application_paths_1.paths.Liability, ".@NewLimit"),
         repaymentAmount: "".concat(application_paths_1.paths.Liability, ".Repayment[0].@RepaymentAmount"),
         repaymentFrequency: "".concat(application_paths_1.paths.Liability, ".Repayment[0].@RepaymentFrequency"),
         remainingTermDuration: "".concat(application_paths_1.paths.Liability, ".RemainingTerm.@Duration"),
@@ -40,6 +46,12 @@ function generateLiability(_a) {
     // Default repayments to 0 and repaymentFrequency to weekly.
     (0, lodash_1.set)(partialApplication, liabilityMapping.repaymentAmount, 0);
     (0, lodash_1.set)(partialApplication, liabilityMapping.repaymentFrequency, lixi_internal_request_1.List.Weekly);
+    // 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.repaymentFrequency, lixi_internal_request_1.List.Monthly);
+    }
     // Default clearingFromThisLoan to No if the value is not present in the event.
     (0, lodash_1.set)(partialApplication, liabilityMapping.clearingFromThisLoan, lixi_internal_request_1.YesNoList.No);
     for (var _i = 0, _b = Object.entries(liability); _i < _b.length; _i++) {
@@ -47,16 +59,26 @@ function generateLiability(_a) {
         if (liabilityMapping[key]) {
             switch (key) {
                 case 'outstandingBalance':
+                case 'creditLimit':
                 case 'newLimit':
                 case 'repaymentAmount':
                     (0, lodash_1.set)(partialApplication, liabilityMapping[key], (0, round_decimal_1.roundDecimal)(value));
                     break;
+                case 'interestOnlyRemainingTerm':
+                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], (0, round_decimal_1.roundDecimal)(value));
+                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.Liability, ".OriginalTerm.@PaymentType"), lixi_internal_request_1.PaymentTypeList.InterestOnly);
+                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.Liability, ".OriginalTerm.@PaymentTypeUnits"), lixi_internal_request_1.LoanTermUnitsList.Years);
+                    break;
                 case 'type':
                     (0, lodash_1.set)(partialApplication, liabilityMapping[key], liability_type_1.liabilityTypeMapping[value]);
                     break;
                 case 'clearingFromThisLoan':
                     (0, lodash_1.set)(partialApplication, liabilityMapping[key], value ? lixi_internal_request_1.YesNoList.Yes : lixi_internal_request_1.YesNoList.No);
                     break;
+                case 'clearingFromOtherSource':
+                    if (value === public_liability_1.ClearingFromOtherSource.PayingOut)
+                        (0, lodash_1.set)(partialApplication, liabilityMapping[key], lixi_internal_request_1.YesNoList.Yes);
+                    break;
                 case 'repaymentFrequency':
                     (0, lodash_1.set)(partialApplication, liabilityMapping[key], alieo_frequency_1.liabilityFrequencyMapping[value]);
                     break;
@@ -64,10 +86,11 @@ function generateLiability(_a) {
                     (0, lodash_1.set)(partialApplication, liabilityMapping[key], liability_payment_type_1.liabilityPaymentTypeMapping[value]);
                     break;
                 case 'remainingTermDuration':
-                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], Math.round(+value));
+                    (0, lodash_1.set)(partialApplication, liabilityMapping[key], Math.round(value * 12));
+                    (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.Liability, ".RemainingTerm.@Units"), lixi_internal_request_2.UnitsList.Months);
                     break;
                 case 'financialInstitution':
-                    var financialInstitution = (0, get_financial_institution_1.getFinancialInstitution)(value.toString());
+                    var financialInstitution = (0, get_financial_institution_1.getFinancialInstitution)(value.toString()) || lixi_internal_request_2.FinancialInstitutionList.Other;
                     (0, lodash_1.set)(partialApplication, liabilityMapping[key], financialInstitution);
                     break;
                 case 'percentOwned':
@@ -84,4 +107,4 @@ function generateLiability(_a) {
     }
     return partialApplication;
 }
-exports.generateLiability = generateLiability;
+exports.transformLiability = transformLiability;

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

@@ -2,14 +2,14 @@
  * Application workflow
  */
 export interface ApplicationWorkflow {
-    payload: ApplicationWorkflowClass;
+    payload: PayloadClass;
     type: Type;
     /**
      * schema version
      */
     version: string;
 }
-export interface ApplicationWorkflowClass {
+export interface PayloadClass {
     /**
      * UUID of the Application
      */

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

@@ -29,13 +29,16 @@ export interface Liability {
     creditLimit?: number;
     description?: string;
     financialInstitution?: string;
+    financialInstitutionAccountNumber?: string;
+    financialInstitutionBsb?: string;
+    financialInstitutionShortName?: string;
     interestOnlyDuration?: number;
     interestOnlyRemainingTerm?: number;
     interestType?: InterestType;
     newLimit?: number;
     originalBalance?: number;
     outstandingBalance: number;
-    percentOwned: PercentOwned;
+    percentOwned?: PercentOwned;
     remainingTermDuration?: number;
     repaymentAmount?: number;
     repaymentFrequency?: RepaymentFrequency;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.2.7",
+  "version": "1.3.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,7 +21,7 @@
     "url": "git+ssh://git@bitbucket.org/lendi-dev/integrations-shared-packages.git"
   },
   "dependencies": {
-    "@lendi/integrations-credit-protocol": "1.15.5",
+    "@lendi/integrations-credit-protocol": "1.15.6",
     "@lendi/integrations-protocol": "2.5.4",
     "clean-deep": "^3.4.0",
     "date-fns": "2.19.0",