@lendi/integrations-transform 1.0.7 → 1.1.1

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

@@ -0,0 +1,166 @@
+"use strict";
+exports.__esModule = true;
+exports.sortBusinessIncome = exports.getApplicantId = exports.getStoredApplicantId = exports.getEmploymentIds = exports.isValidSelfEmployedIncomeEvent = exports.isValidPaygIncomeEvent = exports.isValidRentalIncomeEvent = exports.isFullDocOrLowDocIncome = exports.isOtherIncome = exports.isRentalIncome = exports.isSelfEmployedIncome = exports.isPaygIncome = exports.PAYGList = exports.descriptionOtherIncomeTypes = void 0;
+var lodash_1 = require("lodash");
+var public_income_1 = require("../types/events/public-income");
+exports.descriptionOtherIncomeTypes = [
+    public_income_1.IncomeType.InvestmentIncome,
+    public_income_1.IncomeType.PaygNonVoluntaryDeductionsPreTax,
+    public_income_1.IncomeType.RentalIncome,
+];
+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,
+];
+/**
+ * @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 one of OtherIncome types.
+ * @param {IncomeType} incomeType Income Type.
+ * @returns {boolean} returns true for other income.
+ */
+function isOtherIncome(incomeType) {
+    return exports.descriptionOtherIncomeTypes.includes(incomeType);
+}
+exports.isOtherIncome = isOtherIncome;
+/**
+ * @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;
+/**
+ * @description Checks if an Income event is a valid rental income event.
+ * @param {Income} income Income.
+ * @returns {boolean} true if event is a valid Rental Income.
+ */
+function isValidRentalIncomeEvent(_a) {
+    var assetId = _a.assetId, incomeType = _a.type;
+    return isRentalIncome(incomeType) && !assetId;
+}
+exports.isValidRentalIncomeEvent = isValidRentalIncomeEvent;
+/**
+ * @description Is event valid PAYG income event.
+ * @param {Income} income Income.
+ * @param {PersonApplicant[]} applicants An array of applicants.
+ * @returns {boolean} true if Income type is a PAYG value and event is valid PAYG event.
+ */
+function isValidPaygIncomeEvent(_a, applicants) {
+    var percentOwned = _a.percentOwned, employmentId = _a.employmentId, incomeType = _a.type;
+    if (applicants === void 0) { applicants = []; }
+    if (!isPaygIncome(incomeType))
+        return false;
+    var applicantId = (0, lodash_1.get)(percentOwned, 'owners[0].applicantId') || getStoredApplicantId(applicants, employmentId, 'PAYG');
+    if (!applicantId)
+        return false;
+    return true;
+}
+exports.isValidPaygIncomeEvent = isValidPaygIncomeEvent;
+/**
+ * @description Checks if an Income event is a valid self-employment income event.
+ * @param {Income} income Income.
+ * @param {PersonApplicant[]} applicants An array of applicants.
+ * @returns {boolean} Returns true if event is a valid self employment income event.
+ */
+function isValidSelfEmployedIncomeEvent(_a, applicants) {
+    var percentOwned = _a.percentOwned, employmentId = _a.employmentId, incomeType = _a.type;
+    if (applicants === void 0) { applicants = []; }
+    if (!isSelfEmployedIncome(incomeType))
+        return false;
+    var applicantId = (0, lodash_1.get)(percentOwned, 'owners[0].applicantId') || getStoredApplicantId(applicants, employmentId, 'PAYG');
+    if (!applicantId)
+        return false;
+    return true;
+}
+exports.isValidSelfEmployedIncomeEvent = isValidSelfEmployedIncomeEvent;
+/**
+ * @description Get the employment ids for an applicant for a specific employment type.
+ * @param {PersonApplicant} applicant An applicant
+ * @param {string} key Employment type key: PAYG or SelfEmployed.
+ * @returns {string[]} An array of employment ids for the applicant of the specified type.
+ */
+function getEmploymentIds(applicant, key) {
+    return (0, lodash_1.compact)(applicant.Employment.flatMap(function (employment) { return (0, lodash_1.get)(employment, "".concat(key, ".@UniqueID")); }));
+}
+exports.getEmploymentIds = getEmploymentIds;
+/**
+ * @description Get applicantId from an array of applicants given an employmentId and employmentType.
+ * @param {PersonApplicant[]} applicants An array of applicants.
+ * @param {string} employmentId EmploymentId
+ * @param {string} key Employment type: PAYG or SelfEmployed
+ * @returns {string | undefined} Returns applicantId or undefined.
+ */
+function getStoredApplicantId(applicants, employmentId, key) {
+    for (var _i = 0, applicants_1 = applicants; _i < applicants_1.length; _i++) {
+        var applicant = applicants_1[_i];
+        var employmentIds = getEmploymentIds(applicant, key);
+        if (employmentIds.includes(employmentId))
+            return applicant['@UniqueID'];
+    }
+    return undefined;
+}
+exports.getStoredApplicantId = getStoredApplicantId;
+/**
+ * @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(_a, applicants) {
+    var percentOwned = _a.percentOwned, employmentId = _a.employmentId;
+    if (applicants === void 0) { applicants = []; }
+    return ((0, lodash_1.get)(percentOwned, 'owners[0].applicantId') ||
+        getStoredApplicantId(applicants, employmentId, 'PAYG') ||
+        getStoredApplicantId(applicants, employmentId, 'SelfEmployed'));
+}
+exports.getApplicantId = getApplicantId;
+/**
+ * @description Sort Business Income By Year.
+ * @param incomeA Income Details for Self Employed Full Doc.
+ * @param incomeB Income Details for Self Employed Full Doc.
+ * @returns {0 | - 1 | 1} Returns a number to be used for sorting income.
+ */
+function sortBusinessIncome(_a, _b) {
+    var _c = _a.year, yearA = _c === void 0 ? 0 : _c;
+    var _d = _b.year, yearB = _d === void 0 ? 0 : _d;
+    if (yearA > yearB)
+        return -1;
+    if (yearB > yearA)
+        return 1;
+    return 0;
+}
+exports.sortBusinessIncome = sortBusinessIncome;

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

@@ -0,0 +1,8 @@
+export declare 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";
+exports.__esModule = 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) {
+    var date = new Date(dateOfBirth);
+    var year = date.getFullYear();
+    var month = ('0' + (date.getMonth() + 1)).slice(-2);
+    var day = ('0' + date.getDate()).slice(-2);
+    return "".concat(year, "-").concat(month, "-").concat(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";
+exports.__esModule = 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

@@ -1,17 +1,17 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.0.7",
+  "version": "1.1.1",
   "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": "",
+  "main": "./lib/index.js",
   "directories": {
     "lib": "lib",
     "test": "test"
   },
   "files": [
-    "lib"
+    "lib/**/*"
   ],
   "publishConfig": {
     "access": "public"
@@ -70,20 +70,23 @@
     "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": "yarn run check:typings:sources && yarn run check:typings:tests && yarn run check:linting:sources && yarn run check:linting:tests && yarn run check:formatting",
     "check:formatting": "prettier-check '**/*.{json,ts,md}'",
-    "check:linting:sources": "tslint --config tslint.json --project tsconfig.json 'src/**/*.ts'",
-    "check:linting:tests": "tslint --config tslint.tests.json --project tsconfig.json 'src/**/*.test.ts'",
     "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}'",
-    "prepublish": "yarn build",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run build",
+    "postpack": "rm -rf lib",
     "test": "yarn test:unit",
     "test:cover": "yarn test:unit --coverage",
     "test:unit": "jest --config jest.config.json --detectOpenHandles",
+    "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"
   }
 }