@lendi/integrations-transform 1.6.3 → 1.6.6

package/lib/index.d.ts

@@ -5,6 +5,6 @@ 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/generate-required-document';
+export * from './transform-events/transform-required-document';
 export * from './transform-events/transform-funding-position';
 export * from './update-application/merge-application';

package/lib/index.js

@@ -22,6 +22,6 @@ __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/generate-required-document"), 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/transform-events/transform-asset.d.ts

@@ -1,4 +1,4 @@
-import { LivingExpense, PropertyExpense as LIXIPropertyExpense, OccupancyList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { LivingExpense, OccupancyList, PropertyExpense as LIXIPropertyExpense } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
 import { PropertyType as LixiPropertyType, Residential } from '@lendi/integrations-protocol/lib/types/lixi-internal-request';
 import { Asset, Payload, PercentOwned, PropertyExpense, PropertyType } from '../types/events/public-asset';
 import { PartialApplication } from '../types/partial-application';

package/lib/transform-events/transform-asset.js

@@ -4,10 +4,13 @@ exports.normalizeAmounts = exports.determineOccupancy = exports.generateProperty
 const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
 const application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
 const lixi_internal_request_2 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
-const uuid_1 = require("uuid");
 const lodash_1 = require("lodash");
+const uuid_1 = require("uuid");
+const __1 = require("..");
 const logger_1 = require("../logger");
 const enum_mappings_1 = require("../types/enum-mappings");
+const builder_type_1 = require("../types/enum-mappings/builder-type");
+const construction_type_1 = require("../types/enum-mappings/construction-type");
 const public_asset_1 = require("../types/events/public-asset");
 const public_expense_1 = require("../types/events/public-expense");
 const get_financial_institution_1 = require("../utils/get-financial-institution");
@@ -15,9 +18,6 @@ const is_asset_type_1 = require("../utils/is-asset-type");
 const round_decimal_1 = require("../utils/round-decimal");
 const transform_asset_address_1 = require("./transform-asset-address");
 const transform_percent_owned_1 = require("./transform-percent-owned");
-const builder_type_1 = require("../types/enum-mappings/builder-type");
-const construction_type_1 = require("../types/enum-mappings/construction-type");
-const __1 = require("..");
 exports.propertyTypeNameList = Object.values(lixi_internal_request_2.Custom2PropertyTypeNameList);
 exports.residentialTypeList = Object.values(lixi_internal_request_1.ResidentialTypeList);
 // will add this path to protocol
@@ -80,9 +80,11 @@ function transformAsset({ asset, applicationId, id }) {
         if (assetMapping[key]) {
             switch (key) {
                 case 'contractDetails':
-                    const { contractDate } = value;
+                    const { contractDate, estimatedSettlementDate } = value;
                     if (contractDate)
                         (0, lodash_1.set)(partialApplication, assetMapping.contractDate, contractDate);
+                    if (estimatedSettlementDate)
+                        (0, lodash_1.set)(partialApplication, assetMapping.estimatedSettlementDate, estimatedSettlementDate);
                     break;
                 case 'primaryPurpose':
                     (0, lodash_1.set)(partialApplication, assetMapping[key], enum_mappings_1.primaryPurposeMapping[value]);
@@ -224,6 +226,7 @@ function getAssetMapping(asset) {
             address: application_paths_1.paths.Address,
             contractDetails: 'contractDetails',
             contractDate: `${application_paths_1.paths.RealEstateAsset}.ContractDetails.@ContractDate`,
+            estimatedSettlementDate: `${application_paths_1.paths.RealEstateAsset}.ContractDetails.@EstimatedSettlementDate`,
             estimatedValue,
             percentOwned,
             primaryPurpose: `${application_paths_1.paths.RealEstateAsset}.@PrimaryPurpose`,

package/lib/transform-events/transform-required-document.d.ts

@@ -0,0 +1,67 @@
+import { PersonApplicantPrivacy, ProofOfIdentity } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { EConsent, Identification, Payload as RequiredDocumentPayload, Status } from '../types/events/public-required-document';
+import { PartialApplication } from '../types/partial-application';
+interface TransformRequiredDocumentOptions {
+    readonly secondIDEnabled?: boolean;
+}
+/**
+ * Gets the applicant gender from the identification data
+ *
+ * @param {Identification} identification Identification data
+ *
+ * @returns The gender of the applicant
+ */
+export declare const getApplicantGenderFromIdentification: (identification: Identification) => string;
+/**
+ * Gets full name on document from the identification data
+ *
+ * @param {Identification} identification Identification data
+ *
+ * @returns {string} The full name on document
+ */
+export declare const getNameOnDocument: (identification: Identification) => string;
+/**
+ * Transforms issued location data of an ID document
+ *
+ * @param {Identification} identification Identification data
+ * @param {boolean} secondIDEnabled Whether or not second Id functionality is enabled
+ *
+ * @returns {Partial<ProofOfIdentity>} Partial proof of identity object
+ */
+export declare const transformIDIssuedLocation: (identification: Identification, secondIDEnabled?: boolean) => Partial<ProofOfIdentity>;
+/**
+ * Transforms the verification status data of the ID document
+ *
+ * @param {Status} status Verification status of the ID document
+ * @param {boolean} secondIDEnabled Whether or not secondID mapping is enabled
+ *
+ * @returns {Partial<ProofOfIdentity>} Partial proof of identity
+ */
+export declare const transformVerificationStatus: (status: Status | undefined, secondIDEnabled?: boolean) => Partial<ProofOfIdentity>;
+/**
+ * Generates a partial proof of identity object
+ *
+ * @param {RequiredDocumentPayload} requiredDocumentEventPayload RequiredDocumentCreated/RequiredDocumentUpdated event payload
+ * @param {TransformRequiredDocumentOptions} options - Options from generating partial proof of identity
+ *
+ * @returns {Partial<ProofOfIdentity>} Partial proof of identity document object
+ */
+export declare const generateProofOfIdentity: (requiredDocumentEventPayload: RequiredDocumentPayload, options?: TransformRequiredDocumentOptions) => Partial<ProofOfIdentity>;
+/**
+ * Generates an applicants disclosure details mapping for the partial application
+ *
+ * @param {EConsent} eConsent E-Consent detials from the RequiredDocumentCreated/RequqiredDocumentUpdated event payload
+ *
+ * @returns {PersonApplicantPrivacy} Applicant disclosure details for partial application
+ */
+export declare const generatePersonApplicantPrivacy: (eConsent: EConsent) => PersonApplicantPrivacy;
+/**
+ * Transforms a RequiredDocumentCreated/RequiredDocumentUpdated event payload into a partial application
+ *
+ * @param {RequiredDocumentPayload} requiredDocEventPayload A RequiredDocumentCreated/RequiredDocumentUpdated event payload
+ * @param {TransformRequiredDocumentOptions} options Required document event transformation options
+ *
+ * @returns {PartialApplication} A partial application
+ */
+export declare const transformRequiredDocument: (requiredDocEventPayload: RequiredDocumentPayload, options?: TransformRequiredDocumentOptions) => PartialApplication;
+export {};

package/lib/transform-events/transform-required-document.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformRequiredDocument = exports.generatePersonApplicantPrivacy = exports.generateProofOfIdentity = exports.transformVerificationStatus = exports.transformIDIssuedLocation = exports.getNameOnDocument = exports.getApplicantGenderFromIdentification = void 0;
+const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
+const application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
+const lodash_1 = require("lodash");
+const enum_mappings_1 = require("../types/enum-mappings");
+const enum_mappings_2 = require("../types/enum-mappings");
+const enum_mappings_3 = require("../types/enum-mappings");
+const verification_1 = require("../types/enum-mappings/verification");
+const public_required_document_1 = require("../types/events/public-required-document");
+const formatYesNo_1 = require("../utils/formatYesNo");
+const iso_date_1 = require("../utils/iso-date");
+/**
+ * Gets the applicant gender from the identification data
+ *
+ * @param {Identification} identification Identification data
+ *
+ * @returns The gender of the applicant
+ */
+const getApplicantGenderFromIdentification = (identification) => {
+    const { gender, idTitle } = identification;
+    return gender ? (0, lodash_1.capitalize)(gender) : enum_mappings_3.titleGenderMapping[idTitle || public_required_document_1.IDTitle.Unknown];
+};
+exports.getApplicantGenderFromIdentification = getApplicantGenderFromIdentification;
+/**
+ * Gets full name on document from the identification data
+ *
+ * @param {Identification} identification Identification data
+ *
+ * @returns {string} The full name on document
+ */
+const getNameOnDocument = (identification) => {
+    const { idFirstName, idMiddleName, idLastName } = identification;
+    return [idFirstName, idMiddleName, idLastName].reduce((fullName, nameComponent) => {
+        let newFullName = fullName;
+        const nameSubstring = nameComponent === null || nameComponent === void 0 ? void 0 : nameComponent.trim();
+        if (nameSubstring) {
+            newFullName += `${fullName ? ' ' : ''}${nameSubstring}`;
+        }
+        return newFullName;
+    }, '');
+};
+exports.getNameOnDocument = getNameOnDocument;
+/**
+ * Transforms issued location data of an ID document
+ *
+ * @param {Identification} identification Identification data
+ * @param {boolean} secondIDEnabled Whether or not second Id functionality is enabled
+ *
+ * @returns {Partial<ProofOfIdentity>} Partial proof of identity object
+ */
+const transformIDIssuedLocation = (identification, secondIDEnabled = false) => {
+    const { australianState, idType, issuingCountry = public_required_document_1.IssuingCountry.Australia } = identification;
+    let transformedIssuedLocation = {};
+    if (idType === public_required_document_1.IDType.Passport && issuingCountry !== public_required_document_1.IssuingCountry.Australia) {
+        const foreignCountryOfIssue = enum_mappings_1.countryCodeMapping[issuingCountry];
+        transformedIssuedLocation = Object.assign({ '@DocumentType': lixi_internal_request_1.DocumentTypeList.InternationalPassport, '@CountryOfIssue': foreignCountryOfIssue, '@PlaceOfIssue': foreignCountryOfIssue }, (secondIDEnabled && { '@ResidentialAddressVerified': lixi_internal_request_1.YesNoList.No }));
+    }
+    else {
+        transformedIssuedLocation = {
+            '@CountryOfIssue': lixi_internal_request_1.CountryCodeList.Au,
+            '@PlaceOfIssue': australianState || lixi_internal_request_1.CountryCodeList.Au,
+            '@DocumentType': enum_mappings_2.proofOfIdentityMapping[idType],
+        };
+    }
+    return transformedIssuedLocation;
+};
+exports.transformIDIssuedLocation = transformIDIssuedLocation;
+/**
+ * Transforms the verification status data of the ID document
+ *
+ * @param {Status} status Verification status of the ID document
+ * @param {boolean} secondIDEnabled Whether or not secondID mapping is enabled
+ *
+ * @returns {Partial<ProofOfIdentity>} Partial proof of identity
+ */
+const transformVerificationStatus = (status, secondIDEnabled = false) => {
+    let transformedVerification = {};
+    if (status) {
+        const verificationStatus = verification_1.verificationMapping[status];
+        transformedVerification = Object.assign({ '@PhotographVerified': verificationStatus }, (secondIDEnabled && {
+            '@DOBVerified': verificationStatus,
+            '@NameVerified': verificationStatus,
+            '@SignatureVerified': verificationStatus,
+            '@ResidentialAddressVerified': verificationStatus,
+        }));
+    }
+    return transformedVerification;
+};
+exports.transformVerificationStatus = transformVerificationStatus;
+/**
+ * Generates a partial proof of identity object
+ *
+ * @param {RequiredDocumentPayload} requiredDocumentEventPayload RequiredDocumentCreated/RequiredDocumentUpdated event payload
+ * @param {TransformRequiredDocumentOptions} options - Options from generating partial proof of identity
+ *
+ * @returns {Partial<ProofOfIdentity>} Partial proof of identity document object
+ */
+const generateProofOfIdentity = (requiredDocumentEventPayload, options = {}) => {
+    const { secondIDEnabled = false } = options;
+    const { id, status, expiryDate, identification } = requiredDocumentEventPayload;
+    const nameOnDocument = (0, exports.getNameOnDocument)(identification);
+    const { idNumber } = identification;
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ '@UniqueID': id }, (expiryDate && { '@ExpiryDate': (0, iso_date_1.isoDate)(expiryDate) })), (0, exports.transformVerificationStatus)(status, secondIDEnabled)), (nameOnDocument && { '@NameOnDocument': nameOnDocument })), (idNumber && { '@DocumentNumber': idNumber })), (0, exports.transformIDIssuedLocation)(identification, secondIDEnabled)), (secondIDEnabled && {
+        '@DocumentCategory': lixi_internal_request_1.DocumentCategoryList.Photographic,
+        '@Original': lixi_internal_request_1.YesNoList.Yes,
+    }));
+};
+exports.generateProofOfIdentity = generateProofOfIdentity;
+/**
+ * Generates an applicants disclosure details mapping for the partial application
+ *
+ * @param {EConsent} eConsent E-Consent detials from the RequiredDocumentCreated/RequqiredDocumentUpdated event payload
+ *
+ * @returns {PersonApplicantPrivacy} Applicant disclosure details for partial application
+ */
+const generatePersonApplicantPrivacy = (eConsent) => {
+    const { hasConsented, consentedAt = new Date() } = eConsent;
+    return {
+        '@CreditAuthoritySigned': (0, formatYesNo_1.formatYesNo)(hasConsented),
+        '@DateSigned': (0, iso_date_1.isoDate)(consentedAt),
+    };
+};
+exports.generatePersonApplicantPrivacy = generatePersonApplicantPrivacy;
+/**
+ * Transforms a RequiredDocumentCreated/RequiredDocumentUpdated event payload into a partial application
+ *
+ * @param {RequiredDocumentPayload} requiredDocEventPayload A RequiredDocumentCreated/RequiredDocumentUpdated event payload
+ * @param {TransformRequiredDocumentOptions} options Required document event transformation options
+ *
+ * @returns {PartialApplication} A partial application
+ */
+const transformRequiredDocument = (requiredDocEventPayload, options) => {
+    const partialApplication = {};
+    const { applicantId, applicationId, identification, eConsent } = requiredDocEventPayload;
+    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@UniqueID`, applicantId);
+    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
+    if (identification) {
+        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Gender`, (0, exports.getApplicantGenderFromIdentification)(identification));
+        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.ProofOfIdentity}`, (0, exports.generateProofOfIdentity)(requiredDocEventPayload, options));
+    }
+    if (eConsent) {
+        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Privacy}`, (0, exports.generatePersonApplicantPrivacy)(eConsent));
+    }
+    return partialApplication;
+};
+exports.transformRequiredDocument = transformRequiredDocument;

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

@@ -1,7 +1,3 @@
 import { Status } from '../events/public-required-document';
 import { YesNoList } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
-declare type VerificationMapping = {
-    [key in Status]: YesNoList;
-};
-export declare const verificationMapping: VerificationMapping;
-export {};
+export declare const verificationMapping: Record<Status, YesNoList>;

package/lib/update-application/merge-application.d.ts

@@ -1,8 +1,14 @@
+interface DeepMergeOptions {
+    readonly secondIDEnabled?: boolean;
+}
 /**
  * Deep merges the application and custom handles specific arrays
  *
- * @param newApplication new application coming from events.
  * @param existingApplication a saved dynamo application.
+ * @param newApplication new application coming from events.
+ * @param {DeepMergeOptions} options Deep merge options
+ *
  * @returns merged application.
  */
-export declare function deepMergeApplication(existingApplication: object | undefined, newApplication: object): any;
+export declare function deepMergeApplication(existingApplication: object | undefined, newApplication: object, options?: DeepMergeOptions): any;
+export {};

package/lib/update-application/merge-application.js

@@ -6,11 +6,17 @@ const cleanDeep = require('clean-deep');
 /**
  * Deep merges the application and custom handles specific arrays
  *
- * @param newApplication new application coming from events.
  * @param existingApplication a saved dynamo application.
+ * @param newApplication new application coming from events.
+ * @param {DeepMergeOptions} options Deep merge options
+ *
  * @returns merged application.
  */
-function deepMergeApplication(existingApplication, newApplication) {
+function deepMergeApplication(existingApplication, newApplication, options = {}) {
+    if (!existingApplication) {
+        return newApplication;
+    }
+    const { secondIDEnabled = false } = options;
     // Array fields with @UniqueIDs
     const listsWithUniqueIds = [
         'Attachment',
@@ -28,6 +34,9 @@ function deepMergeApplication(existingApplication, newApplication) {
         'RelatedCompany',
         'RelatedPerson',
     ];
+    if (secondIDEnabled) {
+        listsWithUniqueIds.push('ProofOfIdentity');
+    }
     // Array fields with @x_Party
     const listsWithXParty = ['Report'];
     // Array fields with @x_Owner
@@ -40,19 +49,16 @@ function deepMergeApplication(existingApplication, newApplication) {
     const listsWithXGuarantor = ['Guarantor'];
     // Curried function which takes a uniqueKey and returns a function which will either replace
     // or merge the item in the array based on the uniqueKey
-    if (!existingApplication) {
-        return newApplication;
-    }
     const mergeItems = (uniqueKey) => {
         return (existingItem, newItem) => {
             // if not array continue with merge
             if (!Array.isArray(newItem)) {
-                return merge(existingItem, newItem, options);
+                return merge(existingItem, newItem, mergeOptions);
             }
-            return findArrayItemAndMerge(existingItem, newItem, uniqueKey, options);
+            return findArrayItemAndMerge(existingItem, newItem, uniqueKey, mergeOptions);
         };
     };
-    const options = {
+    const mergeOptions = {
         customMerge: (key) => {
             if (listsWithUniqueIds.find((item) => item === key)) {
                 return mergeItems('@UniqueID');
@@ -75,7 +81,7 @@ function deepMergeApplication(existingApplication, newApplication) {
             return mergeItems(key);
         },
     };
-    const mergedApplication = merge(existingApplication, newApplication, options);
+    const mergedApplication = merge(existingApplication, newApplication, mergeOptions);
     // Default configurations of cleanDeep for reference.
     const params = {
         cleanValues: [],

package/lib/update-application/remove-ids-not-required.d.ts

@@ -0,0 +1,21 @@
+import { InternalRequest, PersonApplicant } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
+import { Payload as RequiredDocEventPayload } from '../types/events/public-required-document';
+import { RecursivePartial } from '../types/recursive-partial';
+/**
+ * Remove proof of identity document from a person applicant
+ *
+ * @param {PersonApplicant} personApplicant Person applicant to remove the id document from
+ * @param {string} id Proof of identity document
+ *
+ * @returns {PersonApplicant} Updated person applicant
+ */
+export declare const removeIDDocumentFromApplicant: (personApplicant: PersonApplicant, id: string) => PersonApplicant;
+/**
+ * Removes ProofOfIdentity ID document that is in status Not Required
+ *
+ * @param {RecursivePartial<InternalRequest>} application - Partial LIXI CAL application
+ * @param {RequiredDocEventPayload} eventPayload - Required Document event payload
+ *
+ * @returns {RecursivePartial<InternalRequest>} Updated application
+ */
+export declare const removeIdsNotRequired: (application: RecursivePartial<InternalRequest>, eventPayload: RequiredDocEventPayload) => RecursivePartial<InternalRequest>;

package/lib/update-application/remove-ids-not-required.js

@@ -0,0 +1,54 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeIdsNotRequired = exports.removeIDDocumentFromApplicant = void 0;
+const application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
+const lodash_1 = require("lodash");
+const public_required_document_1 = require("../types/events/public-required-document");
+/**
+ * Remove proof of identity document from a person applicant
+ *
+ * @param {PersonApplicant} personApplicant Person applicant to remove the id document from
+ * @param {string} id Proof of identity document
+ *
+ * @returns {PersonApplicant} Updated person applicant
+ */
+const removeIDDocumentFromApplicant = (personApplicant, id) => {
+    const { ProofOfIdentity = [] } = personApplicant, rest = __rest(personApplicant, ["ProofOfIdentity"]);
+    const updatedProofOfIdentity = ProofOfIdentity.filter((proofOfId) => proofOfId['@UniqueID'] !== id);
+    // If the updateProofOfIdentity is an empty array then we remove the ProofOfIdentity attribute from the person applicant
+    return Object.assign(Object.assign({}, rest), (updatedProofOfIdentity.length && { ProofOfIdentity: updatedProofOfIdentity }));
+};
+exports.removeIDDocumentFromApplicant = removeIDDocumentFromApplicant;
+/**
+ * Removes ProofOfIdentity ID document that is in status Not Required
+ *
+ * @param {RecursivePartial<InternalRequest>} application - Partial LIXI CAL application
+ * @param {RequiredDocEventPayload} eventPayload - Required Document event payload
+ *
+ * @returns {RecursivePartial<InternalRequest>} Updated application
+ */
+const removeIdsNotRequired = (application, eventPayload) => {
+    const { status: verificationStatus, id, applicantId } = eventPayload;
+    const personApplicants = (0, lodash_1.get)(application, application_paths_1.paths.PersonApplicants, []);
+    const updatedApplication = application;
+    if (verificationStatus === public_required_document_1.Status.NotRequired && personApplicants.length) {
+        const personApplicantIndex = personApplicants.findIndex((personApplicant) => personApplicant['@UniqueID'] === applicantId);
+        if (personApplicantIndex !== -1) {
+            const updatedPersonApplicant = (0, exports.removeIDDocumentFromApplicant)(personApplicants[personApplicantIndex], id);
+            (0, lodash_1.set)(updatedApplication, `${application_paths_1.paths.PersonApplicants}.[${personApplicantIndex}]`, updatedPersonApplicant);
+        }
+    }
+    return updatedApplication;
+};
+exports.removeIdsNotRequired = removeIdsNotRequired;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.6.3",
+  "version": "1.6.6",
   "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.17.3",
+    "@lendi/integrations-credit-protocol": "^1.17.5",
     "@lendi/integrations-protocol": "^2.6.4",
     "@lendi/logging": "^1.0.0",
     "clean-deep": "^3.4.0",

package/lib/transform-events/generate-required-document.d.ts

@@ -1,44 +0,0 @@
-import { PersonApplicantPrivacy, ProofOfIdentity } from '@lendi/integrations-credit-protocol/types/lixi-internal-request';
-import { EConsent, Identification, Payload as RequiredDocumentPayload } from '../types/events/public-required-document';
-/**
- * Gets the applicant gender from the identification data
- *
- * @param identification Identification data
- * @returns The gender of the applicant
- */
-export declare const getApplicantGenderFromIdentification: (identification: Identification) => string;
-/**
- * Gets full name on document from the identification data
- *
- * @param identification Identification data
- * @returns The full name on document
- */
-export declare const getNameOnDocument: (identification: Identification) => string;
-/**
- * Transforms identification data into a partial proof of identity document
- *
- * @param identification Identification data
- * @returns Partial proof of identity object
- */
-export declare const transformIdentification: (identification: Identification) => Partial<ProofOfIdentity>;
-/**
- * Generates partial details for document used to verify identity
- *
- * @param requiredDocument RequiredDocumentCreated/RequiredDocumentUpdated event payload
- * @returns Partial proof of identity document object
- */
-export declare const generateProofOfIdentity: (requiredDocument: RequiredDocumentPayload) => Partial<ProofOfIdentity>;
-/**
- * Generates an applicants disclosure details mapping for the partial application
- *
- * @param eConsent E-Consent detials from the RequiredDocumentCreated/RequqiredDocumentUpdated event payload
- * @returns Applicant disclosure details for partial application
- */
-export declare const generatePersonApplicantPrivacy: (eConsent: EConsent) => PersonApplicantPrivacy;
-/**
- * Transforms a RequiredDocumentCreated or RequiredDocumentUpdated event payload into a partial application
- *
- * @param requiredDocument A RequiredDocumentCreated or RequiredDocumentUpdated event payload
- * @returns A partial application
- */
-export declare function transformRequiredDocument(requiredDocument: RequiredDocumentPayload): {};

package/lib/transform-events/generate-required-document.js

@@ -1,106 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformRequiredDocument = exports.generatePersonApplicantPrivacy = exports.generateProofOfIdentity = exports.transformIdentification = exports.getNameOnDocument = exports.getApplicantGenderFromIdentification = void 0;
-const lixi_internal_request_1 = require("@lendi/integrations-credit-protocol/types/lixi-internal-request");
-const application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
-const lodash_1 = require("lodash");
-const enum_mappings_1 = require("../types/enum-mappings");
-const enum_mappings_2 = require("../types/enum-mappings");
-const enum_mappings_3 = require("../types/enum-mappings");
-const verification_1 = require("../types/enum-mappings/verification");
-const public_required_document_1 = require("../types/events/public-required-document");
-const formatYesNo_1 = require("../utils/formatYesNo");
-const iso_date_1 = require("../utils/iso-date");
-/**
- * Gets the applicant gender from the identification data
- *
- * @param identification Identification data
- * @returns The gender of the applicant
- */
-const getApplicantGenderFromIdentification = (identification) => {
-    const { gender, idTitle } = identification;
-    return gender ? (0, lodash_1.capitalize)(gender) : enum_mappings_3.titleGenderMapping[idTitle || public_required_document_1.IDTitle.Unknown];
-};
-exports.getApplicantGenderFromIdentification = getApplicantGenderFromIdentification;
-/**
- * Gets full name on document from the identification data
- *
- * @param identification Identification data
- * @returns The full name on document
- */
-const getNameOnDocument = (identification) => {
-    const { idFirstName, idMiddleName, idLastName } = identification;
-    return [idFirstName, idMiddleName, idLastName].reduce((fullName, nameComponent) => {
-        let newFullName = fullName;
-        const nameSubstring = nameComponent === null || nameComponent === void 0 ? void 0 : nameComponent.trim();
-        if (nameSubstring) {
-            newFullName += `${fullName ? ' ' : ''}${nameSubstring}`;
-        }
-        return newFullName;
-    }, '');
-};
-exports.getNameOnDocument = getNameOnDocument;
-/**
- * Transforms identification data into a partial proof of identity document
- *
- * @param identification Identification data
- * @returns Partial proof of identity object
- */
-const transformIdentification = (identification) => {
-    const { australianState, idNumber, idType, issuingCountry = public_required_document_1.IssuingCountry.Australia } = identification;
-    const nameOnDocument = (0, exports.getNameOnDocument)(identification);
-    return Object.assign(Object.assign(Object.assign(Object.assign({}, (nameOnDocument && { '@NameOnDocument': nameOnDocument })), (idNumber && { '@DocumentNumber': idNumber })), (australianState && { '@PlaceOfIssue': australianState })), (idType === public_required_document_1.IDType.Passport && issuingCountry !== public_required_document_1.IssuingCountry.Australia
-        ? {
-            '@DocumentType': lixi_internal_request_1.DocumentTypeList.InternationalPassport,
-            '@CountryOfIssue': enum_mappings_1.countryCodeMapping[issuingCountry],
-            '@PlaceOfIssue': enum_mappings_1.countryCodeMapping[issuingCountry],
-        }
-        : { '@DocumentType': enum_mappings_2.proofOfIdentityMapping[idType] }));
-};
-exports.transformIdentification = transformIdentification;
-/**
- * Generates partial details for document used to verify identity
- *
- * @param requiredDocument RequiredDocumentCreated/RequiredDocumentUpdated event payload
- * @returns Partial proof of identity document object
- */
-const generateProofOfIdentity = (requiredDocument) => {
-    const { id, status, expiryDate, identification } = requiredDocument;
-    return Object.assign(Object.assign(Object.assign({ '@UniqueID': id, '@CountryOfIssue': lixi_internal_request_1.CountryCodeList.Au, '@PlaceOfIssue': lixi_internal_request_1.CountryCodeList.Au }, (expiryDate && { '@ExpiryDate': (0, iso_date_1.isoDate)(expiryDate) })), (status && { '@PhotographVerified': verification_1.verificationMapping[status] })), (identification && (0, exports.transformIdentification)(identification)));
-};
-exports.generateProofOfIdentity = generateProofOfIdentity;
-/**
- * Generates an applicants disclosure details mapping for the partial application
- *
- * @param eConsent E-Consent detials from the RequiredDocumentCreated/RequqiredDocumentUpdated event payload
- * @returns Applicant disclosure details for partial application
- */
-const generatePersonApplicantPrivacy = (eConsent) => {
-    const { hasConsented, consentedAt = new Date() } = eConsent;
-    return {
-        '@CreditAuthoritySigned': (0, formatYesNo_1.formatYesNo)(hasConsented),
-        '@DateSigned': (0, iso_date_1.isoDate)(consentedAt),
-    };
-};
-exports.generatePersonApplicantPrivacy = generatePersonApplicantPrivacy;
-/**
- * Transforms a RequiredDocumentCreated or RequiredDocumentUpdated event payload into a partial application
- *
- * @param requiredDocument A RequiredDocumentCreated or RequiredDocumentUpdated event payload
- * @returns A partial application
- */
-function transformRequiredDocument(requiredDocument) {
-    const partialApplication = {};
-    const { applicantId, applicationId, identification, eConsent } = requiredDocument;
-    (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@UniqueID`, applicantId);
-    (0, lodash_1.set)(partialApplication, application_paths_1.paths.ApplicationId, applicationId);
-    if (identification) {
-        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.PersonApplicant}.@Gender`, (0, exports.getApplicantGenderFromIdentification)(identification));
-        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.ProofOfIdentity}`, (0, exports.generateProofOfIdentity)(requiredDocument));
-    }
-    if (eConsent) {
-        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.Privacy}`, (0, exports.generatePersonApplicantPrivacy)(eConsent));
-    }
-    return partialApplication;
-}
-exports.transformRequiredDocument = transformRequiredDocument;