@lendi/act-credit-decisions-transform 1.9.0

package/README.md

@@ -0,0 +1,31 @@
+# Integrations Transform
+
+Contains tooling for converting Lendi's kafka event data into LIXI format.
+
+## Table of Contents
+
+- [Installation](#markdown-header-installation)
+- [Publishing](#markdown-header-publishing)
+
+## Installation
+
+To install and implement this module you can run the following:
+
+```
+yarn add @lendi/act-credit-decisions-transform
+```
+
+## Development
+
+Before merging your work, please remember to bump the version in `package.json`.
+Once merged, you can then follow the below
+[publishing](#markdown-header-publishing) steps to publish the latest changes.
+
+## Publishing
+
+After your updates have been merged to `master`, you then need to publish to
+`npm` please do the following:
+
+- Click the "Publish" step from Bitbucket pipelines `master` branch.
+
+**Note**: Make sure you have bumped the `package.json` version.

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: 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-employment"), 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/transform-liability"), exports);
+__exportStar(require("./transform-events/transform-required-document"), exports);
+__exportStar(require("./transform-events/transform-funding-position"), exports);
+__exportStar(require("./update-application/merge-application"), exports);

package/lib/logger.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("@lendi/logging").Logger;

package/lib/logger.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const logging_1 = require("@lendi/logging");
+exports.logger = (0, logging_1.createLogger)({ name: 'integrations-transform', messageKey: 'message' });

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

@@ -0,0 +1,240 @@
+{
+  "definitions": {
+    "brokerAuditReview": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "requestedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO date time when Broker Audit Review was created"
+        },
+        "reviewType": {
+          "type": "string",
+          "description": "The Broker Audit Review record type"
+        },
+        "status": {
+          "type": "string",
+          "description": "The Broker Audit Review status"
+        },
+        "outcome": {
+          "type": "string",
+          "description": "The Broker Audit Review outcome"
+        },
+        "completedBy": {
+          "type": "string",
+          "format": "uuid",
+          "description": "UUID of the Team Member that completed the Broker Audit Review"
+        },
+        "completedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO date time when Broker Audit Review was completed"
+        }
+      }
+    },
+    "applicationWorkflow": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "applicationId": {
+          "type": "string",
+          "format": "uuid",
+          "description": "UUID of the Application"
+        },
+        "applicationOwner": {
+          "type": "string",
+          "format": "uuid",
+          "description": "UUID of the Application Owner (Team Member)"
+        },
+        "stage": {
+          "type": "string",
+          "description": "Opportunity stage name. This is a legacy field and will be deprecated after Lendi Group salesforce goes live",
+          "enum": [
+            "APPLICATION_TAKEN",
+            "APPOINTED",
+            "APPROVAL",
+            "APPROVED",
+            "AT_RISK",
+            "CL_FUTURE_CONTACT_DATE",
+            "CLOSED_LOST",
+            "CLOSED_WON_POLICY_ACTIVE",
+            "CLOSED_WON_SIGNED",
+            "CLOSED_WON",
+            "CONFIRMED_APPOINTMENT",
+            "IN_APPLICATION",
+            "IN_ASSESSMENT",
+            "LOAN_DOCUMENT",
+            "POST_CONTACT",
+            "POST_SETTLEMENT",
+            "PRE_CONTACT",
+            "QUALIFICATION",
+            "QUOTE",
+            "SETTLED",
+            "SETTLEMENT",
+            "SUBMITTED",
+            "UNKNOWN"
+          ]
+        },
+        "applicationStage": {
+          "type": "string",
+          "description": "Application stage in Lendi Group Salesforce",
+          "enum": [
+            "PRE_SUBMISSION",
+            "SUBMISSION_REVIEW",
+            "SUBMITTED_TO_LENDER",
+            "PRE_APPROVED",
+            "SETTLEMENT",
+            "POST_SETTLEMENT",
+            "CLOSED_LOST"
+          ]
+        },
+        "status": {
+          "type": "string",
+          "description": "Opportunity status. This is a legacy field and will be deprecated after Lendi Group salesforce goes live",
+          "enum": [
+            "APPLICATION",
+            "APPLICATION_COMPLETED",
+            "APPLICATION_STARTED",
+            "APPROVED_AND_PENDING_SETTLEMENT",
+            "APPROVED_WITH_PENDING_DOCUMENTS",
+            "COMPLIANCE",
+            "CONDITIONALLY_APPROVED",
+            "CONTACT_ATTEMPTED",
+            "CONTACT_MADE",
+            "DASHBOARD",
+            "DOCS_GENERATED",
+            "DOCUMENTS_RECEIVED",
+            "E_CONSENT_COMPLETE",
+            "FORMALLY_APPROVED",
+            "IN_APPLICATION",
+            "LOAN_DOCUMENTS_RECEIVED",
+            "LOAN_DOCUMENTS_SENT",
+            "LOAN_DOCUMENTS_VERIFIED",
+            "LOST",
+            "MIR",
+            "NO_ANSWER_1",
+            "NO_ANSWER_2",
+            "NO_ANSWER_3",
+            "NO_ANSWER_4",
+            "NO_ANSWER_5",
+            "OPP_CREATED_NEW",
+            "PENDING_SETTLEMENT",
+            "PENDING_SETTLEMENT_CONFIRMATION",
+            "PLATFORM_COMPLETE",
+            "PRE_APPROVAL",
+            "PRODUCT_SELECTION_COMPLETE",
+            "QUARANTINED",
+            "READY_TO_SUBMIT",
+            "REQUIRED_DOCS_UPLOADED",
+            "SELF_SUBMITTED",
+            "SERVICING_PASSED",
+            "SETTLED",
+            "SETTLED_NOT_PAID",
+            "SETTLED_AND_DISCHARGED",
+            "SETTLED_AND_RECONCILED",
+            "SETTLEMENT_BOOKED",
+            "SIGNED_ADDITIONAL_DOCS_REQUIRED",
+            "STP",
+            "STP_EXCEPTIONS",
+            "SUBMIT_TO_PRODUCTION",
+            "SUBMIT_TO_PRODUCTION_INCOMPLETE",
+            "SUBMIT_TO_PRODUCTION_QA",
+            "SUBMITTED",
+            "SUBMITTED_CLOSED_LOST",
+            "SUBMITTED_DECLINED",
+            "SUBMITTED_ON_HOLD",
+            "SUBMITTED_RESOLVED",
+            "SUBMITTED_MIR",
+            "UNCONDITIONAL_APPROVAL",
+            "SUBMITTED_TO_LENDER",
+            "SUBMIT_CHANGES_TO_LENDER",
+            "SIGNED_CLOSED_LOST",
+            "REFERRED",
+            "UNKNOWN"
+          ]
+        },
+        "applicationStatus": {
+          "enum": [
+            "AMENDMENT_IN_PROGRESS",
+            "APPLICATION_ERROR",
+            "APPLICATION_RECEIVED",
+            "APPROVED_IN_PRINCIPLE",
+            "CONDITIONALLY_APPROVED",
+            "DECLINED",
+            "DISCHARGED",
+            "DOCUMENTS_ISSUED",
+            "DOCUMENTS_RECEIVED",
+            "INFORMATION_PROVIDED_TO_LENDER",
+            "LODGEMENT",
+            "LOST",
+            "MORE_INFORMATION_REQUESTED",
+            "ON_HOLD",
+            "POST_CONTACT",
+            "PRE_CONTACT",
+            "PROCESS_PENDING",
+            "READY_FOR_SETTLEMENT",
+            "REFERRED",
+            "REVIEW_INCOMPLETE",
+            "SELF_SUBMITTED",
+            "SETTLED",
+            "SETTLEMENT_BOOKED",
+            "UNCONDITIONALLY_APPROVED",
+            "UNDER_REVIEW",
+            "WAITING_ON_EXCEPTION"
+          ],
+          "description": "Application status in Lendi Group Salesforce"
+        },
+        "confirmedPrimaryPurpose": {
+          "type": "string",
+          "description": "Intention for applying a loan",
+          "enum": [
+            "CHATTEL_MORTGAGE",
+            "COMMERCIAL",
+            "CONSTRUCTION_AND_PURCHASE",
+            "CONSTRUCTION_AND_REFINANCE",
+            "CONSTRUCTION",
+            "HIRE_PURCHASE",
+            "INTERNAL_REFI_SWITCH",
+            "LEASE",
+            "LOAN",
+            "NEW_PURCHASE",
+            "PRE_APPROVAL",
+            "PURCHASE_AND_REFINANCE",
+            "PURCHASE",
+            "REFINANCE",
+            "SLR",
+            "TOP_UP",
+            "VARIATION",
+            "UNKNOWN"
+          ]
+        },
+        "brokerAuditReview": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/brokerAuditReview"
+          }
+        }
+      },
+      "required": ["applicationId", "stage", "status", "brokerAuditReview"]
+    }
+  },
+  "type": "object",
+  "title": "The application workflow event schema",
+  "description": "Application workflow",
+  "additionalProperties": false,
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["ApplicationWorkflowUpdated"]
+    },
+    "payload": {
+      "$ref": "#/definitions/applicationWorkflow"
+    }
+  },
+  "required": ["version", "payload", "type"]
+}

package/lib/schemas/credit-report-retrieved-event.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "payload": {
+      "$ref": "#/definitions/payload"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["CreditReportNoMatch", "CreditReportRetrieved"]
+    },
+    "version": {
+      "type": "string"
+    }
+  },
+  "required": ["payload", "type", "version"],
+  "definitions": {
+    "payload": {
+      "allOf": [
+        {
+          "properties": {
+            "applicationId": {
+              "type": "string"
+            },
+            "applicantId": {
+              "type": "string"
+            },
+            "customerId": {
+              "type": "string"
+            },
+            "source": {
+              "description": "A list of credit report service provider",
+              "type": "string",
+              "enum": ["equifax"]
+            },
+            "createdAt": {
+              "description": "ISO 8601 time when the event is created",
+              "type": "string",
+              "format": "date-time",
+              "example": ["2020-11-03T03:43:33.333Z"]
+            },
+            "raw": {
+              "description": "Credit report raw content, compressed and 64-base encoded.",
+              "type": "string"
+            },
+            "isNoMatch": {
+              "description": "Indicate whether there is a match found or not for the customer.",
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "required": ["applicationId", "applicantId", "customerId", "source", "raw"]
+        }
+      ]
+    }
+  }
+}