@lendi/act-credit-decisions-transform 2.0.0

package/lib/utils/is-income-type.d.ts

@@ -0,0 +1,73 @@
+import { PersonApplicant } from '@lendi/act-eac-integrations-protocol/lib/types/lixi-internal-request';
+import { IncomeType, Income, IncomeBusinessDetails } from '../types/events/public-income';
+export declare const descriptionOtherIncomeTypes: string[];
+export declare const PAYGList: string[];
+export declare const otherIncomeList: IncomeType[];
+/**
+ * @description Is income type one of the PAYG income.
+ * @param {string} incomeType Income type.
+ * @returns {boolean} Returns true if Income type is a PAYG Income.
+ */
+export declare function isPaygIncome(incomeType: string): boolean;
+/**
+ * @description Is income type SelfEmployedBusinessIncome.
+ * @param {string} incomeType Income type.
+ * @returns {boolean} Returns true if Income type is SelfEmployedBusinessIncome.
+ */
+export declare function isSelfEmployedIncome(incomeType: string): boolean;
+/**
+ * @description Is income type Rental Income.
+ * @param {IncomeType} incomeType Income type.
+ * @returns {boolean} true if Income type is Rental Income.
+ */
+export declare function isRentalIncome(incomeType: string): boolean;
+/**
+ * @description Is income type grouped as OtherIncome.
+ * @param {IncomeType} incomeType Income type.
+ * @returns {boolean} true if income is of type other income.
+ */
+export declare function isOtherIncome(incomeType: IncomeType): boolean;
+/**
+ * @description Is Income type one of OtherIncome types.
+ * @param {IncomeType} incomeType Income Type.
+ * @returns {boolean} returns true for other income.
+ */
+export declare function isOtherIncomeWithDesc(incomeType: string): boolean;
+/**
+ * @description Is Self Employed Full Doc or Low Doc Income
+ * @param incomeType Income Type from Event
+ * @returns {boolean} True if either Full Doc or Low Doc Self Employed Income.
+ */
+export declare function isFullDocOrLowDocIncome(incomeType: IncomeType): boolean;
+/**
+ * Checks if there is some employment for the applicant that has the same employment id as the employment id in the income event
+ *
+ * @param {PersonApplicant} applicant - An applicant
+ * @param {string} employmentId - Employment id being searched for
+ * @returns {boolean} - Whether or not the applicant has an employment with matching employmentId
+ */
+export declare const hasMatchingEmploymentId: (applicant: PersonApplicant, employmentId: string) => boolean;
+/**
+ * Gets the applicant id using the employment id
+ *
+ * @param {PersonApplicant[]} applicants - An array of applicants.
+ * @param {string} employmentId - Employment ID
+ * @returns {string | undefined} - Applicant id or undefined
+ */
+export declare function getApplicantIdFromEmploymentId(applicants: PersonApplicant[], employmentId: string): string | undefined;
+/**
+ * @description Get an applicantId from the event or the applicants.
+ * @param {Income} income Income.
+ * @param {PersonApplicant[]} applicants An array of LIXI applicants.
+ * @returns {string | undefined} An applicantId or undefined.
+ */
+export declare function getApplicantId({ percentOwned, employmentId }: Income, applicants?: PersonApplicant[]): string | undefined;
+/**
+ * @description Sort Business Income By Year.
+ * @param incomeA Income Details for Self Employed Full Doc.
+ * @param incomeA.year
+ * @param incomeB.year
+ * @param incomeB Income Details for Self Employed Full Doc.
+ * @returns {0 | < 0 | > 0} Returns a number to be used for sorting income.
+ */
+export declare const sortBusinessIncome: ({ year: yearA }: IncomeBusinessDetails, { year: yearB }: IncomeBusinessDetails) => number;

package/lib/utils/is-income-type.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortBusinessIncome = exports.getApplicantId = exports.getApplicantIdFromEmploymentId = exports.hasMatchingEmploymentId = exports.isFullDocOrLowDocIncome = exports.isOtherIncomeWithDesc = exports.isOtherIncome = exports.isRentalIncome = exports.isSelfEmployedIncome = exports.isPaygIncome = exports.otherIncomeList = exports.PAYGList = exports.descriptionOtherIncomeTypes = void 0;
+const lodash_1 = require("lodash");
+const public_income_1 = require("../types/events/public-income");
+exports.descriptionOtherIncomeTypes = [
+    public_income_1.IncomeType.InvestmentIncome,
+    public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax,
+];
+exports.PAYGList = [
+    public_income_1.IncomeType.PaygAllowancesNotTaxed,
+    public_income_1.IncomeType.PaygAllowancesTaxed,
+    public_income_1.IncomeType.PaygBaseSalary,
+    public_income_1.IncomeType.PaygBonusIncome,
+    public_income_1.IncomeType.PaygCarAllowance,
+    public_income_1.IncomeType.PaygCommissionIncome,
+    public_income_1.IncomeType.PaygCompanyCar,
+    public_income_1.IncomeType.PaygOvertimeIncome,
+];
+exports.otherIncomeList = [
+    public_income_1.IncomeType.ChildMaintenance,
+    public_income_1.IncomeType.ForeignIncome,
+    public_income_1.IncomeType.GovtBenefit,
+    public_income_1.IncomeType.InvestmentIncome,
+    public_income_1.IncomeType.OtherIncome,
+    public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax,
+    public_income_1.IncomeType.PaygSalarySacrifice,
+    public_income_1.IncomeType.SuperAnnuityPension,
+    public_income_1.IncomeType.WorkersCompensation,
+];
+/**
+ * @description Is income type one of the PAYG income.
+ * @param {string} incomeType Income type.
+ * @returns {boolean} Returns true if Income type is a PAYG Income.
+ */
+function isPaygIncome(incomeType) {
+    return exports.PAYGList.includes(incomeType);
+}
+exports.isPaygIncome = isPaygIncome;
+/**
+ * @description Is income type SelfEmployedBusinessIncome.
+ * @param {string} incomeType Income type.
+ * @returns {boolean} Returns true if Income type is SelfEmployedBusinessIncome.
+ */
+function isSelfEmployedIncome(incomeType) {
+    return incomeType === public_income_1.IncomeType.SelfEmployedBusinessIncome;
+}
+exports.isSelfEmployedIncome = isSelfEmployedIncome;
+/**
+ * @description Is income type Rental Income.
+ * @param {IncomeType} incomeType Income type.
+ * @returns {boolean} true if Income type is Rental Income.
+ */
+function isRentalIncome(incomeType) {
+    return incomeType === public_income_1.IncomeType.RentalIncome;
+}
+exports.isRentalIncome = isRentalIncome;
+/**
+ * @description Is income type grouped as OtherIncome.
+ * @param {IncomeType} incomeType Income type.
+ * @returns {boolean} true if income is of type other income.
+ */
+function isOtherIncome(incomeType) {
+    return exports.otherIncomeList.includes(incomeType);
+}
+exports.isOtherIncome = isOtherIncome;
+/**
+ * @description Is Income type one of OtherIncome types.
+ * @param {IncomeType} incomeType Income Type.
+ * @returns {boolean} returns true for other income.
+ */
+function isOtherIncomeWithDesc(incomeType) {
+    return exports.descriptionOtherIncomeTypes.includes(incomeType);
+}
+exports.isOtherIncomeWithDesc = isOtherIncomeWithDesc;
+/**
+ * @description Is Self Employed Full Doc or Low Doc Income
+ * @param incomeType Income Type from Event
+ * @returns {boolean} True if either Full Doc or Low Doc Self Employed Income.
+ */
+function isFullDocOrLowDocIncome(incomeType) {
+    return [public_income_1.IncomeType.SelfEmployedBusinessIncomeFullDoc, public_income_1.IncomeType.SelfEmployedBusinessIncomeLowDoc].includes(incomeType);
+}
+exports.isFullDocOrLowDocIncome = isFullDocOrLowDocIncome;
+/**
+ * Checks if there is some employment for the applicant that has the same employment id as the employment id in the income event
+ *
+ * @param {PersonApplicant} applicant - An applicant
+ * @param {string} employmentId - Employment id being searched for
+ * @returns {boolean} - Whether or not the applicant has an employment with matching employmentId
+ */
+const hasMatchingEmploymentId = (applicant, employmentId) => (applicant.Employment || []).some((employment) => {
+    const id = (0, lodash_1.get)(employment, 'PAYG.@UniqueID') ||
+        (0, lodash_1.get)(employment, 'SelfEmployed.@UniqueID') ||
+        (0, lodash_1.get)(employment, 'NotEmployed.@UniqueID');
+    return id === employmentId;
+});
+exports.hasMatchingEmploymentId = hasMatchingEmploymentId;
+/**
+ * Gets the applicant id using the employment id
+ *
+ * @param {PersonApplicant[]} applicants - An array of applicants.
+ * @param {string} employmentId - Employment ID
+ * @returns {string | undefined} - Applicant id or undefined
+ */
+function getApplicantIdFromEmploymentId(applicants, employmentId) {
+    let applicantId;
+    if (applicants && employmentId) {
+        const applicant = applicants.find((applicant) => (0, exports.hasMatchingEmploymentId)(applicant, employmentId));
+        applicantId = applicant === null || applicant === void 0 ? void 0 : applicant['@UniqueID'];
+    }
+    return applicantId;
+}
+exports.getApplicantIdFromEmploymentId = getApplicantIdFromEmploymentId;
+/**
+ * @description Get an applicantId from the event or the applicants.
+ * @param {Income} income Income.
+ * @param {PersonApplicant[]} applicants An array of LIXI applicants.
+ * @returns {string | undefined} An applicantId or undefined.
+ */
+function getApplicantId({ percentOwned, employmentId }, applicants = []) {
+    return (0, lodash_1.get)(percentOwned, 'owners[0].applicantId') || getApplicantIdFromEmploymentId(applicants, employmentId);
+}
+exports.getApplicantId = getApplicantId;
+/**
+ * @description Sort Business Income By Year.
+ * @param incomeA Income Details for Self Employed Full Doc.
+ * @param incomeA.year
+ * @param incomeB.year
+ * @param incomeB Income Details for Self Employed Full Doc.
+ * @returns {0 | < 0 | > 0} Returns a number to be used for sorting income.
+ */
+const sortBusinessIncome = ({ year: yearA = 0 }, { year: yearB = 0 }) => yearB - yearA;
+exports.sortBusinessIncome = sortBusinessIncome;

package/lib/utils/iso-date.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Formats a date to ISO 8601 format with time
+ *
+ * @param {string | Date} str - A string that could be converted to a Date (or) a Date.
+ * @returns {string} - A ISO Date format without the time. (yyyy-MM-dd)
+ */
+export declare const isoDate: (str: string | Date) => string;

package/lib/utils/iso-date.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isoDate = void 0;
+const date_fns_1 = require("date-fns");
+/**
+ * Formats a date to ISO 8601 format with time
+ *
+ * @param {string | Date} str - A string that could be converted to a Date (or) a Date.
+ * @returns {string} - A ISO Date format without the time. (yyyy-MM-dd)
+ */
+const isoDate = (str) => (0, date_fns_1.formatISO)(new Date(str), { representation: 'date' });
+exports.isoDate = isoDate;

package/lib/utils/normalise-date.d.ts

@@ -0,0 +1,8 @@
+export type DateConstructorParam = ConstructorParameters<DateConstructor>[0];
+/**
+ * Accepts any type of data format and normalises it into a consistent format
+ * as "2019-09-19".
+ *
+ * @param {any} dateOfBirth - Date string.
+ */
+export declare function normaliseDate(dateOfBirth: DateConstructorParam): string;

package/lib/utils/normalise-date.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normaliseDate = void 0;
+/**
+ * Accepts any type of data format and normalises it into a consistent format
+ * as "2019-09-19".
+ *
+ * @param {any} dateOfBirth - Date string.
+ */
+function normaliseDate(dateOfBirth) {
+    const date = new Date(dateOfBirth);
+    const year = date.getFullYear();
+    const month = ('0' + (date.getMonth() + 1)).slice(-2);
+    const day = ('0' + date.getDate()).slice(-2);
+    return `${year}-${month}-${day}`;
+}
+exports.normaliseDate = normaliseDate;

package/lib/utils/round-decimal.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Rounds given value to 2 decimals.
+ *
+ * @param amount A number value.
+ */
+export declare function roundDecimal(amount: number): number;

package/lib/utils/round-decimal.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.roundDecimal = void 0;
+/**
+ * Rounds given value to 2 decimals.
+ *
+ * @param amount A number value.
+ */
+function roundDecimal(amount) {
+    return parseFloat(amount.toFixed(2));
+}
+exports.roundDecimal = roundDecimal;

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@lendi/act-credit-decisions-transform",
+  "version": "2.0.0",
+  "description": "Library for kafka event data transforming",
+  "author": "Integrations <integrations@lendi.com.au>",
+  "homepage": "https://bitbucket.org/lendi-dev/integrations-shared-packages#readme",
+  "license": "ISC",
+  "main": "./lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "test"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/lendi-dev/integrations-shared-packages.git"
+  },
+  "dependencies": {
+    "@lendi/integrations-credit-protocol": "1.18.7",
+    "@lendi/act-eac-integrations-protocol": "3.0.0",
+    "@lendi/logging": "^1.0.0",
+    "clean-deep": "^3.4.0",
+    "date-fns": "2.19.0",
+    "lodash": "^4.17.15"
+  },
+  "devDependencies": {
+    "@lendi/prettier-config": "^1.0.0",
+    "@lendi/typescript-config": "^2.0.0",
+    "@types/jest": "^28.1.4",
+    "@types/lodash": "^4.14.141",
+    "@types/node": "^16.11.7",
+    "@types/prettier": "^1.16.1",
+    "@types/sinon": "^7.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.21.0",
+    "@typescript-eslint/parser": "^5.21.0",
+    "eslint": "^8.14.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jsdoc": "^39.2.9",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-sonarjs": "^0.13.0",
+    "husky": "^3.0.8",
+    "jest": "^28.1.2",
+    "jest-buildkite-reporter": "^0.2.8",
+    "jest-sonar-reporter": "^2.0.0",
+    "path": "^0.12.7",
+    "quicktype": "^15.0.261",
+    "sinon": "^7.4.2",
+    "ts-jest": "^28.0.5",
+    "ts-node": "^8.4.1",
+    "typedoc": "^0.20.36",
+    "typescript": "^4.1.3"
+  },
+  "scripts": {
+    "build": "tsc && cp -r src/schemas lib",
+    "build:types": "yarn run build:types:events && yarn run format",
+    "build:types:events": "./src/scripts/build-event-types.sh",
+    "check:formatting": "prettier-check '**/*.{json,ts,md}'",
+    "check:typings:sources": "tsc --project tsconfig.json --noEmit",
+    "check:typings:tests": "tsc --project tsconfig.tests.json --noEmit",
+    "lint:types": "tsc --project tsconfig.json --noEmit",
+    "lint": "eslint './src/**/*.ts'; exit 0",
+    "lint:fix": "eslint './src/**/*.ts' --fix",
+    "format": "prettier --write '**/*.{json,ts,md}'",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run build",
+    "postpack": "rm -rf lib",
+    "test:unit": "jest --config jest.config.json",
+    "list:package-contents": "npm publish --dry-run",
+    "semver:patch": "npm version patch",
+    "semver:minor": "npm version minor",
+    "semver:major": "npm version major",
+    "current:version": "echo $npm_package_version"
+  }
+}