@lendi/integrations-transform 1.1.6 → 1.2.1

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

@@ -23,17 +23,15 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 var _a;
 exports.__esModule = true;
-exports.generateBAS = exports.generateIncomeBusinessDetails = exports.createRentalIncome = exports.generateIncome = exports.getIncomeMapping = exports.EmploymentIncomeTypeMapping = void 0;
+exports.generateBAS = exports.generateIncomeBusinessDetails = exports.createRentalIncome = exports.transformIncome = exports.getIncomeMapping = exports.EmploymentIncomeTypeMapping = void 0;
 var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
 var application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
 var lodash_1 = require("lodash");
-var alieo_frequency_1 = require("../types/enum-mappings/alieo-frequency");
-var government_benefits_1 = require("../types/enum-mappings/government-benefits");
-var income_type_1 = require("../types/enum-mappings/income-type");
+var enum_mappings_1 = require("../types/enum-mappings");
 var public_income_1 = require("../types/events/public-income");
 var is_income_type_1 = require("../utils/is-income-type");
 var round_decimal_1 = require("../utils/round-decimal");
-var generate_lixi_percentowned_1 = require("./generate-lixi-percentowned");
+var transform_percent_owned_1 = require("./transform-percent-owned");
 var netWorkAllowanceAmount = 'Income.@NetWorkAllowanceAmount';
 var netWorkAllowanceFrequency = 'Income.@NetWorkAllowanceFrequency';
 // Income types mapping from internal to LIXI types /paths.
@@ -70,44 +68,47 @@ exports.EmploymentIncomeTypeMapping = (_a = {},
         amount: 'Income.@GrossRegularOvertimeAmount',
         frequency: 'Income.@GrossRegularOvertimeFrequency'
     },
+    _a[public_income_1.IncomeType.SelfEmployedBusinessIncome] = {
+        amount: 'BusinessIncomeRecent.@ProfitBeforeTax'
+    },
     _a);
 function getIncomeMapping(incomeType) {
     var basePath = application_paths_1.paths.OtherIncome;
     if ((0, is_income_type_1.isRentalIncome)(incomeType)) {
         basePath = application_paths_1.paths.RealEstateAsset;
         return {
-            assetId: "".concat(basePath, ".@UniqueID"),
-            percentOwned: "".concat(basePath, ".RentalIncome")
+            assetId: basePath + ".@UniqueID",
+            percentOwned: basePath + ".RentalIncome"
         };
     }
     if ((0, is_income_type_1.isFullDocOrLowDocIncome)(incomeType)) {
         basePath = application_paths_1.paths.CompanyApplicant;
         return {
-            bas: "".concat(basePath, ".Income[0].BusinessActivityStatement"),
-            companyId: "".concat(basePath, ".@UniqueID"),
-            incomes: "".concat(basePath, ".Income"),
-            gross: "".concat(basePath, ".DeclaredIncome.@IncomeAmount")
+            bas: basePath + ".Income[0].BusinessActivityStatement",
+            companyId: basePath + ".@UniqueID",
+            incomes: basePath + ".Income",
+            gross: basePath + ".DeclaredIncome.@IncomeAmount"
         };
     }
     if ((0, is_income_type_1.isSelfEmployedIncome)(incomeType)) {
         basePath = application_paths_1.paths.SelfEmployed;
         var amount = exports.EmploymentIncomeTypeMapping[incomeType].amount;
         return {
-            amount: "".concat(basePath, ".").concat(amount),
-            employmentId: "".concat(basePath, ".@UniqueID")
+            amount: basePath + "." + amount,
+            employmentId: basePath + ".@UniqueID"
         };
     }
     if ((0, is_income_type_1.isPaygIncome)(incomeType)) {
         basePath = application_paths_1.paths.PAYG;
         var _a = exports.EmploymentIncomeTypeMapping[incomeType], amount = _a.amount, frequency = _a.frequency;
-        return __assign({ amount: "".concat(basePath, ".").concat(amount), employmentId: "".concat(basePath, ".@UniqueID") }, (frequency && { frequency: "".concat(basePath, ".").concat(frequency) }));
+        return __assign({ amount: basePath + "." + amount, employmentId: basePath + ".@UniqueID" }, (frequency && { frequency: basePath + "." + frequency }));
     }
     return {
-        amount: "".concat(basePath, ".@Amount"),
-        frequency: "".concat(basePath, ".@Frequency"),
-        percentOwned: "".concat(basePath, ".PercentOwned"),
-        type: "".concat(basePath, ".@Type"),
-        benefitType: "".concat(basePath, ".@GovernmentBenefitsType")
+        amount: basePath + ".@Amount",
+        frequency: basePath + ".@Frequency",
+        percentOwned: basePath + ".PercentOwned",
+        type: basePath + ".@Type",
+        benefitType: basePath + ".@GovernmentBenefitsType"
     };
 }
 exports.getIncomeMapping = getIncomeMapping;
@@ -118,16 +119,16 @@ exports.getIncomeMapping = getIncomeMapping;
  * @param applicantId PersonApplicant uniqueId on the application.
  * @return partialApplication an incomplete application.
  */
-function generateIncome(payload, applicantId) {
+function transformIncome(payload, applicantId) {
     var applicationId = payload.applicationId, id = payload.id, income = payload.income;
     var incomeAmount = income.amount, incomeType = income.type, incomeFrequency = income.frequency;
     var partialApplication = {};
     (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
     if (!(0, is_income_type_1.isRentalIncome)(incomeType) && applicantId) {
-        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.PersonApplicant, ".@UniqueID"), applicantId);
+        (0, lodash_1.set)(partialApplication, application_paths_1.paths.PersonApplicant + ".@UniqueID", applicantId);
     }
     if ((0, is_income_type_1.isOtherIncome)(incomeType)) {
-        (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.OtherIncome, ".@UniqueID"), id);
+        (0, lodash_1.set)(partialApplication, application_paths_1.paths.OtherIncome + ".@UniqueID", id);
     }
     var incomeMapping = getIncomeMapping(incomeType);
     for (var _i = 0, _a = Object.entries(income); _i < _a.length; _i++) {
@@ -144,11 +145,11 @@ function generateIncome(payload, applicantId) {
                         (0, lodash_1.set)(partialApplication, incomeMapping[key], generateBAS(basWithAmount));
                     break;
                 case 'frequency':
-                    (0, lodash_1.set)(partialApplication, incomeMapping[key], alieo_frequency_1.incomeExpenseFrequencyMapping[value]);
+                    (0, lodash_1.set)(partialApplication, incomeMapping[key], enum_mappings_1.incomeExpenseFrequencyMapping[value]);
                     break;
                 case 'percentOwned':
                     var ownership = value;
-                    var percentOwned = (0, generate_lixi_percentowned_1.generateLIXIPercentOwned)(ownership);
+                    var percentOwned = (0, transform_percent_owned_1.transformPercentOwned)(ownership);
                     if ((0, is_income_type_1.isRentalIncome)(incomeType)) {
                         percentOwned = createRentalIncome(incomeAmount, incomeFrequency, ownership.owners);
                     }
@@ -158,9 +159,9 @@ function generateIncome(payload, applicantId) {
                     break;
                 case 'type':
                     if (!(0, is_income_type_1.isRentalIncome)(incomeType)) {
-                        var mappedType = income_type_1.otherIncomeMapping[value];
+                        var mappedType = enum_mappings_1.otherIncomeMapping[value];
                         if ((0, is_income_type_1.isOtherIncomeWithDesc)(value)) {
-                            (0, lodash_1.set)(partialApplication, "".concat(application_paths_1.paths.OtherIncome, ".@Description"), mappedType);
+                            (0, lodash_1.set)(partialApplication, application_paths_1.paths.OtherIncome + ".@Description", mappedType);
                             (0, lodash_1.set)(partialApplication, incomeMapping[key], lixi_internal_request_1.OtherIncomeTypeList.OtherIncome);
                         }
                         else {
@@ -169,7 +170,7 @@ function generateIncome(payload, applicantId) {
                     }
                     break;
                 case 'benefitType':
-                    (0, lodash_1.set)(partialApplication, incomeMapping[key], government_benefits_1.governmentBenefitsMapping[value]);
+                    (0, lodash_1.set)(partialApplication, incomeMapping[key], enum_mappings_1.governmentBenefitsMapping[value]);
                     break;
                 case 'incomes':
                     var sortedIncomeList = value
@@ -185,7 +186,7 @@ function generateIncome(payload, applicantId) {
     }
     return partialApplication;
 }
-exports.generateIncome = generateIncome;
+exports.transformIncome = transformIncome;
 /**
  * Creates Rental Income array.
  * @param amount Amount
@@ -203,7 +204,7 @@ function createRentalIncome(amount, frequency, ownership) {
         var percent = owner.percent, applicantId = owner.applicantId;
         var ownerAmount = amount * percent;
         rentalIncome.push({
-            '@Frequency': alieo_frequency_1.rentalIncomeFrequencyMapping[frequency],
+            '@Frequency': enum_mappings_1.rentalIncomeFrequencyMapping[frequency],
             '@RentalAmount': ownerAmount,
             '@x_Owner': applicantId
         });
@@ -219,7 +220,7 @@ var selfEmploymentIncomeMapping = {
         interest: 'Addback.@Interest',
         lease: 'Addback.@Lease',
         nonRecurringExpenses: 'Addback.@NonRecurringExpenses',
-        other: 'Addback.@Other',
+        other: 'Addback.OtherAddback[0].@Amount',
         salary: 'Addback.@Salary',
         superannuationExcess: 'Addback.@SuperannuationExcess'
     },
@@ -239,11 +240,14 @@ function generateIncomeBusinessDetails(data) {
             if (key === 'addback') {
                 for (var _c = 0, _d = Object.entries(value); _c < _d.length; _c++) {
                     var _e = _d[_c], addbackKey = _e[0], addbackValue = _e[1];
+                    if (addbackKey === 'other') {
+                        (0, lodash_1.set)(income, 'Addback.OtherAddback[0].@Description', 'other');
+                    }
                     (0, lodash_1.set)(income, addbackMapping[addbackKey], addbackValue);
                 }
             }
             else if (key === 'year') {
-                (0, lodash_1.set)(income, dateAndIncomeMapping[key], value.toString());
+                (0, lodash_1.set)(income, dateAndIncomeMapping[key], value + "-01-01");
             }
             else {
                 (0, lodash_1.set)(income, dateAndIncomeMapping[key], value);

package/lib/transform-events/{generate-lixi-percentowned.d.ts → transform-percent-owned.d.ts}

@@ -6,4 +6,4 @@ import { PercentOwned as LIXIPercentOwned } from '@lendi/integrations-protocol/l
  * @param percentOwned PercentOwned for an asset or liability on public liability event.
  * @returns {LIXIPercentOwned} transformed Lixi PercentOwned.
  */
-export declare function generateLIXIPercentOwned({ owners }: PercentOwned): LIXIPercentOwned;
+export declare function transformPercentOwned({ owners }: PercentOwned): LIXIPercentOwned;

package/lib/transform-events/{generate-lixi-percentowned.js → transform-percent-owned.js}

@@ -1,13 +1,13 @@
 "use strict";
 exports.__esModule = true;
-exports.generateLIXIPercentOwned = void 0;
+exports.transformPercentOwned = void 0;
 /**
  * Transform percentOwned to lixi's format.
  *
  * @param percentOwned PercentOwned for an asset or liability on public liability event.
  * @returns {LIXIPercentOwned} transformed Lixi PercentOwned.
  */
-function generateLIXIPercentOwned(_a) {
+function transformPercentOwned(_a) {
     var _b = _a.owners, owners = _b === void 0 ? [] : _b;
     if (owners.length === 0)
         return null;
@@ -21,4 +21,4 @@ function generateLIXIPercentOwned(_a) {
         })
     };
 }
-exports.generateLIXIPercentOwned = generateLIXIPercentOwned;
+exports.transformPercentOwned = transformPercentOwned;

package/lib/types/enum-mappings/asset-type.d.ts

@@ -0,0 +1,3 @@
+import { NonRealEstateAssetTypeList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { AssetType } from '../events/public-asset';
+export declare const assetTypeMapping: Record<AssetType, NonRealEstateAssetTypeList | null>;

package/lib/types/enum-mappings/asset-type.js

@@ -0,0 +1,18 @@
+"use strict";
+var _a;
+exports.__esModule = true;
+exports.assetTypeMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+var public_asset_1 = require("../events/public-asset");
+exports.assetTypeMapping = (_a = {},
+    _a[public_asset_1.AssetType.Gifts] = lixi_internal_request_1.NonRealEstateAssetTypeList.Other,
+    _a[public_asset_1.AssetType.HomeContents] = lixi_internal_request_1.NonRealEstateAssetTypeList.Other,
+    _a[public_asset_1.AssetType.ManagedFunds] = lixi_internal_request_1.NonRealEstateAssetTypeList.FinancialAsset,
+    _a[public_asset_1.AssetType.OtherAsset] = lixi_internal_request_1.NonRealEstateAssetTypeList.Other,
+    _a[public_asset_1.AssetType.Property] = null,
+    _a[public_asset_1.AssetType.SavingCheckAccount] = lixi_internal_request_1.NonRealEstateAssetTypeList.FinancialAsset,
+    _a[public_asset_1.AssetType.Shares] = lixi_internal_request_1.NonRealEstateAssetTypeList.FinancialAsset,
+    _a[public_asset_1.AssetType.Superannuation] = lixi_internal_request_1.NonRealEstateAssetTypeList.FinancialAsset,
+    _a[public_asset_1.AssetType.TermDeposit] = lixi_internal_request_1.NonRealEstateAssetTypeList.FinancialAsset,
+    _a[public_asset_1.AssetType.Vehicle] = lixi_internal_request_1.NonRealEstateAssetTypeList.MotorVehicleAndTransport,
+    _a);

package/lib/types/enum-mappings/index.d.ts

@@ -0,0 +1,26 @@
+export * from './alieo-frequency';
+export * from './asset-type';
+export * from './country-code';
+export * from './employment-basis';
+export * from './expense-frequency';
+export * from './funding-position';
+export * from './government-benefits';
+export * from './housing-status';
+export * from './income-type';
+export * from './liability-payment-type';
+export * from './liability-type';
+export * from './living-expense';
+export * from './marital-status';
+export * from './postcode';
+export * from './preferred-repayment';
+export * from './proof-of-identity';
+export * from './public-financial-asset';
+export * from './public-primary-purpose';
+export * from './public-property-status';
+export * from './public-property-type';
+export * from './residency-status';
+export * from './title-gender';
+export * from './title';
+export * from './to-be-purchased';
+export * from './to-be-used-as-security';
+export * from './transaction-type';

package/lib/types/enum-mappings/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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);
+};
+exports.__esModule = true;
+__exportStar(require("./alieo-frequency"), exports);
+__exportStar(require("./asset-type"), exports);
+__exportStar(require("./country-code"), exports);
+__exportStar(require("./employment-basis"), exports);
+__exportStar(require("./expense-frequency"), exports);
+__exportStar(require("./funding-position"), exports);
+__exportStar(require("./government-benefits"), exports);
+__exportStar(require("./housing-status"), exports);
+__exportStar(require("./income-type"), exports);
+__exportStar(require("./liability-payment-type"), exports);
+__exportStar(require("./liability-type"), exports);
+__exportStar(require("./living-expense"), exports);
+__exportStar(require("./marital-status"), exports);
+__exportStar(require("./postcode"), exports);
+__exportStar(require("./preferred-repayment"), exports);
+__exportStar(require("./proof-of-identity"), exports);
+__exportStar(require("./public-financial-asset"), exports);
+__exportStar(require("./public-primary-purpose"), exports);
+__exportStar(require("./public-property-status"), exports);
+__exportStar(require("./public-property-type"), exports);
+__exportStar(require("./residency-status"), exports);
+__exportStar(require("./title-gender"), exports);
+__exportStar(require("./title"), exports);
+__exportStar(require("./to-be-purchased"), exports);
+__exportStar(require("./to-be-used-as-security"), exports);
+__exportStar(require("./transaction-type"), exports);

package/lib/types/enum-mappings/to-be-purchased.d.ts

@@ -0,0 +1,5 @@
+import { AssetTransactionList } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
+export interface ToBePurchasedMapping {
+    [key: string]: AssetTransactionList;
+}
+export declare const toBePurchasedMapping: ToBePurchasedMapping;

package/lib/types/enum-mappings/to-be-purchased.js

@@ -0,0 +1,8 @@
+"use strict";
+exports.__esModule = true;
+exports.toBePurchasedMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
+exports.toBePurchasedMapping = {
+    "true": lixi_internal_request_1.AssetTransactionList.Purchasing,
+    "false": lixi_internal_request_1.AssetTransactionList.Owns
+};

package/lib/types/enum-mappings/to-be-used-as-security.d.ts

@@ -0,0 +1,5 @@
+import { YesNoList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+export interface ToBeUsedAsSecurityMapping {
+    [key: string]: YesNoList;
+}
+export declare const toBeUsedAsSecurityMapping: ToBeUsedAsSecurityMapping;

package/lib/types/enum-mappings/to-be-used-as-security.js

@@ -0,0 +1,8 @@
+"use strict";
+exports.__esModule = true;
+exports.toBeUsedAsSecurityMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+exports.toBeUsedAsSecurityMapping = {
+    "true": lixi_internal_request_1.YesNoList.Yes,
+    "false": lixi_internal_request_1.YesNoList.No
+};

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

@@ -1,18 +1,18 @@
 /**
- * Create, update or delete
+ * Create or update
  */
 export interface PublicAsset {
-    payload: AssetDefinition;
-    type: Type;
+    payload: Payload;
     /**
      * schema version
      */
+    type: Type;
     version: string;
 }
 /**
- * create/update Asset payload
+ * create Asset payload
  */
-export interface AssetDefinition {
+export interface Payload {
     applicationId: string;
     asset: Asset;
     /**
@@ -26,9 +26,12 @@ export interface Asset {
     constructionDetails?: ConstructionDetails;
     contractDetails?: ContractDetails;
     contractPriceAmount?: number;
+    dataType?: string;
     description?: string;
     estimatedValue?: number;
     financialInstitution?: string;
+    financialInstitutionAccountNumber?: string;
+    financialInstitutionBsb?: string;
     financialInstitutionShortName?: string;
     knockDownToRebuild?: boolean;
     make?: string;
@@ -37,6 +40,7 @@ export interface Asset {
     primaryPurpose?: PrimaryPurpose;
     propertyStatus?: PropertyStatus;
     propertyType?: PropertyType;
+    relationId?: string;
     toBePurchased?: boolean;
     toBeSold?: boolean;
     toBeUsedAsSecurity?: boolean;
@@ -46,7 +50,7 @@ export interface Asset {
 }
 export interface Address {
     /**
-     * The city / suburb name
+     * The suburb name
      */
     city?: string;
     country?: Countries;
@@ -55,12 +59,12 @@ export interface Address {
      */
     formatted?: string;
     /**
-     * N digit postcode (for AU addresses, usually 4)
+     * A 4 digit postcode
      */
     postcode?: string;
     standard?: AddressStandard;
     /**
-     * The state name
+     * One our great nation's states
      */
     state?: string;
 }
@@ -310,10 +314,6 @@ export interface AddressStandard {
      * The building name
      */
     buildingName?: string;
-    /**
-     * Postal address, usually a PO Box or Locked Bag
-     */
-    deliveryAddress?: string;
     /**
      * The level of the unit/apartment
      */
@@ -330,10 +330,6 @@ export interface AddressStandard {
      * The street number
      */
     streetNumber?: string;
-    /**
-     * The street suffix
-     */
-    streetSuffix?: string;
     /**
      * The type of the street i.e. road
      */
@@ -370,7 +366,7 @@ export interface ContractDetails {
     estimatedSettlementDate?: string;
 }
 export interface PercentOwned {
-    owners?: ApplicantOwnership[];
+    owners: ApplicantOwnership[];
     /**
      * Indicate whether ownership proportions are equal, specified individually for each one or
      * not specified.
@@ -463,6 +459,9 @@ export declare enum ActionedByRole {
     Customer = "customer",
     Team = "team"
 }
+/**
+ * schema version
+ */
 export declare enum Type {
     AssetCreated = "AssetCreated",
     AssetUpdated = "AssetUpdated"

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

@@ -312,6 +312,9 @@ var ActionedByRole;
     ActionedByRole["Customer"] = "customer";
     ActionedByRole["Team"] = "team";
 })(ActionedByRole = exports.ActionedByRole || (exports.ActionedByRole = {}));
+/**
+ * schema version
+ */
 var Type;
 (function (Type) {
     Type["AssetCreated"] = "AssetCreated";

package/lib/utils/address-tools.d.ts

@@ -2,7 +2,7 @@
  * A set of tools for manipulating addresses in LIXI applications.
  */
 import { AddressType, CurrentAddress, PreviousAddress } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
-import { CommonAddressProperties, PreviousAddress as InternalPreviousAddress } from '../types/events/public-applicant';
+import { Address, CommonAddressProperties, Countries, PreviousAddress as InternalPreviousAddress } from '../types/events/public-applicant';
 /**
  * Type definition for functions used to transform types while mapping from event values to LIXI values.
  */
@@ -25,6 +25,7 @@ export interface MappedTransform {
  */
 export declare type PathMappedTransform = Record<string, MappedTransform>;
 export declare const lixiContactAddressMapping: PathMappedTransform;
+export declare const australianStates: string[];
 /**
  * The transform map used for the LIXI address
  */
@@ -66,4 +67,16 @@ export declare function isMissingCountry(addressEvent: EventAddressType): boolea
  * @param address
  */
 export declare function setCountry(address: EventAddressType): EventAddressType;
+/**
+ * @description Extract a country from a formatted address.
+ * @param {string} formatted - A formatted Address.
+ * @returns {Countries} The country extracted from the Address.
+ */
+export declare function extractCountryFromFormatted(formatted?: string): Countries;
+/**
+ * @description If the address has an overseas country or state, it returns true, defaults to false if no country and state found.
+ * @param {Address} address - Asset Address
+ * @returns {boolean} - Returns true if overseas address.
+ */
+export declare function isOverseasAddress({ country, formatted, state }?: Address): boolean;
 export {};

package/lib/utils/address-tools.js

@@ -3,7 +3,8 @@
  * A set of tools for manipulating addresses in LIXI applications.
  */
 exports.__esModule = true;
-exports.setCountry = exports.isMissingCountry = exports.rebuildPreviousAddress = exports.rebuildAddress = exports.mapTransform = exports.lixiAddressMapping = exports.lixiContactAddressMapping = void 0;
+exports.isOverseasAddress = exports.extractCountryFromFormatted = exports.setCountry = exports.isMissingCountry = exports.rebuildPreviousAddress = exports.rebuildAddress = exports.mapTransform = exports.lixiAddressMapping = exports.australianStates = exports.lixiContactAddressMapping = void 0;
+var lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
 var lodash_1 = require("lodash");
 var country_code_1 = require("../types/enum-mappings/country-code");
 var housing_status_1 = require("../types/enum-mappings/housing-status");
@@ -24,6 +25,7 @@ exports.lixiContactAddressMapping = {
         path: '@EndDate'
     }
 };
+exports.australianStates = Object.values(lixi_internal_request_1.AuStateList);
 /**
  * The transform map used for the LIXI address
  */
@@ -136,11 +138,41 @@ exports.isMissingCountry = isMissingCountry;
  * @param address
  */
 function setCountry(address) {
-    var _a;
     var formatted = (0, lodash_1.get)(address, 'residentialAddress.formatted');
     if (formatted && !address.residentialAddress.country) {
-        address.residentialAddress.country = (_a = formatted.split(',').pop()) === null || _a === void 0 ? void 0 : _a.trim();
+        address.residentialAddress.country = extractCountryFromFormatted(formatted);
     }
     return address;
 }
 exports.setCountry = setCountry;
+/**
+ * @description Extract a country from a formatted address.
+ * @param {string} formatted - A formatted Address.
+ * @returns {Countries} The country extracted from the Address.
+ */
+function extractCountryFromFormatted(formatted) {
+    var _a;
+    if (formatted === void 0) { formatted = ''; }
+    return (_a = formatted === null || formatted === void 0 ? void 0 : formatted.split(',').pop()) === null || _a === void 0 ? void 0 : _a.trim();
+}
+exports.extractCountryFromFormatted = extractCountryFromFormatted;
+/**
+ * @description If the address has an overseas country or state, it returns true, defaults to false if no country and state found.
+ * @param {Address} address - Asset Address
+ * @returns {boolean} - Returns true if overseas address.
+ */
+function isOverseasAddress(_a) {
+    var _b = _a === void 0 ? {} : _a, country = _b.country, formatted = _b.formatted, state = _b.state;
+    if (country) {
+        return country !== public_applicant_1.Countries.Australia;
+    }
+    if (formatted) {
+        var lastPast = extractCountryFromFormatted(formatted);
+        return lastPast !== public_applicant_1.Countries.Australia;
+    }
+    if (state) {
+        return !exports.australianStates.includes(state);
+    }
+    return false;
+}
+exports.isOverseasAddress = isOverseasAddress;

package/lib/utils/generate-address.d.ts

@@ -4,10 +4,9 @@ export declare const StreetNumberMaxLength = 16;
 export declare const StreetTypeArray: StreetTypeList[];
 /**
  * Generates an address for an asset.
-
- * @param address: An address object.
- * @param id: Id of asset object.
- * @return A transformed address object.
+ * @param {Address} address - An address object.
+ * @param {string} id - Id of asset object.
+ * @return {Partial<AddressType>} A transformed address object.
  */
 export declare function generateAddress(address: Address, id: string): Partial<AddressType>;
 /**

package/lib/utils/generate-address.js

@@ -6,7 +6,9 @@ var lodash_1 = require("lodash");
 var country_code_1 = require("..//types/enum-mappings/country-code");
 var postcode_1 = require("../types/enum-mappings/postcode");
 var public_asset_1 = require("../types/events/public-asset");
+var address_tools_1 = require("./address-tools");
 exports.StreetNumberMaxLength = 16;
+exports.StreetTypeArray = Object.values(lixi_internal_request_1.StreetTypeList);
 var addressMapping = {
     country: '@Country',
     city: '@Suburb',
@@ -21,21 +23,18 @@ var standardMapping = {
     level: '@Level',
     unit: '@Unit'
 };
-exports.StreetTypeArray = Object.values(lixi_internal_request_1.StreetTypeList);
 /**
  * Generates an address for an asset.
-
- * @param address: An address object.
- * @param id: Id of asset object.
- * @return A transformed address object.
+ * @param {Address} address - An address object.
+ * @param {string} id - Id of asset object.
+ * @return {Partial<AddressType>} A transformed address object.
  */
 function generateAddress(address, id) {
-    var _a;
     var transformedAddress = {
         '@Country': lixi_internal_request_1.CountryCodeList.Au,
         '@UniqueID': id
     };
-    var country = (((_a = address.formatted) === null || _a === void 0 ? void 0 : _a.split(',').pop()) || '').trim();
+    var country = (0, address_tools_1.extractCountryFromFormatted)(address.formatted);
     if (!address.country && country.length > 0) {
         address.country = country;
     }
@@ -50,8 +49,8 @@ function generateAddress(address, id) {
             transformedAddress['@AustralianPostCode'] = postcode_1.postcodeMapping[address.state];
         }
     }
-    for (var _i = 0, _b = Object.entries(address); _i < _b.length; _i++) {
-        var _c = _b[_i], key = _c[0], value = _c[1];
+    for (var _i = 0, _a = Object.entries(address); _i < _a.length; _i++) {
+        var _b = _a[_i], key = _b[0], value = _b[1];
         if (addressMapping[key]) {
             switch (key) {
                 case 'standard':

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

@@ -0,0 +1,25 @@
+import { Asset } from '../types/events/public-asset';
+/**
+ * @description Checks if the asset is of financial type.
+ * @param {Asset} asset asset payload.
+ * @returns {boolean} returns true if asset is a financial asset.
+ */
+export declare function isFinancialAsset(asset: Asset): boolean;
+/**
+ * @description Is Asset a Real Estate Asset.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if Asset is a Real Estate Asset.
+ */
+export declare function isRealEstateAsset(asset: Asset): boolean;
+/**
+ * @description Is Asset a Motor Vehicle.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if an Asset is a vehicle.
+ */
+export declare function isMotorVehicle(asset: Asset): boolean;
+/**
+ * @description Is Asset of LIXI type `OtherAsset`.
+ * @param {Asset} asset An Asset.
+ * @returns {boolean} returns true if asset is `OtherAsset`.
+ */
+export declare function isOtherAsset(asset: Asset): boolean;