@lendi/integrations-transform 1.7.0 → 1.7.1-beta.0

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 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';

package/lib/index.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __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);

package/lib/schemas/public-applicant-event.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "http://json-schema.org/draft-07/schema#",
   "definitions": {
     "Payload": {
       "type": "object",

package/lib/schemas/public-create-applicant-event.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "http://json-schema.org/draft-07/schema#",
   "definitions": {
     "Payload": {
       "type": "object",

package/lib/schemas/public-employment-event.json

@@ -15,7 +15,7 @@
     "meta": {
       "type": "object",
       "additionalProperties": false,
-      "description": "The metadata of the alieo",
+      "description": "The metadata of the employment",
       "properties": {
         "actionedBy": {
           "description": "uuid of user who made the action (create/update/delete)",
@@ -57,6 +57,10 @@
       "type": "string",
       "enum": ["QLD", "NSW", "VIC", "WA", "SA", "TAS", "ACT", "NT"]
     },
+    "otherState": {
+      "type": "string",
+      "example": "Ohio"
+    },
     "employerAddress": {
       "type": "object",
       "additionalProperties": false,
@@ -65,6 +69,7 @@
           "type": "string"
         },
         "state": {
+          "example": "NSW",
           "$ref": "#/definitions/australianStates"
         },
         "city": {
@@ -152,10 +157,6 @@
         }
       }
     },
-    "foreignEmployed": {
-      "type": "boolean",
-      "example": false
-    },
     "maternityLeaveReturnBasis": {
       "type": "string",
       "description": "Employment basis after returning from maternity leave.",
@@ -171,7 +172,6 @@
     },
     "addressStandard": {
       "type": "object",
-      "description": "The address standard",
       "properties": {
         "buildingName": {
           "description": "The building name",
@@ -215,9 +215,9 @@
           "$ref": "#/definitions/id",
           "description": "uuid of applicant"
         },
-        "clientId": {
+        "companyId": {
           "$ref": "#/definitions/id",
-          "description": "uuid of client"
+          "description": "uuid of the related company"
         },
         "applicationId": {
           "$ref": "#/definitions/id",
@@ -235,30 +235,9 @@
         "employmentBasis": {
           "$ref": "#/definitions/employmentBasis"
         },
-        "businessName": {
-          "$ref": "#/definitions/businessName"
-        },
-        "abn": {
-          "$ref": "#/definitions/abn"
-        },
-        "abnVerified": {
-          "$ref": "#/definitions/abnVerified"
-        },
-        "companyType": {
-          "$ref": "#/definitions/companyType"
-        },
-        "employerAddress": {
-          "$ref": "#/definitions/employerAddress"
-        },
-        "businessStructure": {
-          "$ref": "#/definitions/businessStructure"
-        },
         "onProbation": {
           "$ref": "#/definitions/onProbation"
         },
-        "foreignEmployed": {
-          "$ref": "#/definitions/foreignEmployed"
-        },
         "startDate": {
           "$ref": "#/definitions/startDate"
         },
@@ -273,13 +252,10 @@
         },
         "maternityLeaveReturnBasis": {
           "$ref": "#/definitions/maternityLeaveReturnBasis"
-        },
-        "privateOrPublic": {
-          "$ref": "#/definitions/PrivateOrPublic"
         }
       },
       "required": ["id", "applicantId", "applicationId", "type"],
-      "description": "create employment payload"
+      "description": "create or update employment payload"
     }
   },
   "type": "object",
@@ -295,7 +271,7 @@
     },
     "type": {
       "type": "string",
-      "enum": ["EmploymentCreated", "EmploymentUpdated"]
+      "enum": ["EmploymentV2Created", "EmploymentV2Updated"]
     }
   },
   "required": ["version", "payload", "type"]

package/lib/schemas/public-update-applicant-event.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "http://json-schema.org/draft-07/schema#",
   "definitions": {
     "Payload": {
       "type": "object",

package/lib/transform-events/{generate-employment.d.ts → transform-employment.d.ts}

@@ -5,4 +5,4 @@ import { Payload } from '../types/events/public-employment';
  * @param employment a employment event payload.
  * @returns partialApplication an incomplete application.
  */
-export declare function generateEmployment(employment: Payload): {};
+export declare function transformEmployment(employment: Payload, isSelfEmployed: boolean): {};

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

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateEmployment = void 0;
+exports.transformEmployment = void 0;
 const lixi_internal_request_1 = require("@lendi/integrations-protocol/lib/types/lixi-internal-request");
 const lodash_1 = require("lodash");
-const application_paths_1 = require("@lendi/integrations-protocol/lib/utils/application-paths");
+const application_paths_1 = require("@lendi/integrations-credit-protocol/utils/application-paths");
 const logger_1 = require("../logger");
 const public_employment_1 = require("../types/events/public-employment");
 const enum_mappings_1 = require("../types/enum-mappings");
@@ -13,10 +13,10 @@ const enum_mappings_1 = require("../types/enum-mappings");
  * @param employment a employment event payload.
  * @returns partialApplication an incomplete application.
  */
-function generateEmployment(employment) {
+function transformEmployment(employment, isSelfEmployed) {
     const partialApplication = {};
     let employmentPath = application_paths_1.paths.PAYG;
-    let isEmployed = false;
+    const companyId = employment.companyId;
     const { applicationId } = employment;
     // Each one Employment object can only contain one of the three types. Set the three object to undefined so that the
     // other two types will be removed from the final result.
@@ -26,14 +26,17 @@ function generateEmployment(employment) {
     (0, lodash_1.set)(partialApplication, application_paths_1.paths.NotEmployed, undefined);
     switch (employment.employmentType) {
         case public_employment_1.EmploymentType.Employee:
-            isEmployed = true;
             employmentPath = application_paths_1.paths.PAYG;
             // Setting default for onProbation. If field exists in event value will get overwritten.
             (0, lodash_1.set)(partialApplication, `${employmentPath}.@OnProbation`, lixi_internal_request_1.YesNoList.No);
             break;
         case public_employment_1.EmploymentType.SelfEmployed:
-            isEmployed = true;
             employmentPath = application_paths_1.paths.SelfEmployed;
+            if (companyId && isSelfEmployed) {
+                (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.CompanyApplicant}.@UniqueID`, companyId);
+                (0, lodash_1.set)(partialApplication, `${employmentPath}.@x_Employer`, companyId);
+                break;
+            }
             break;
         case public_employment_1.EmploymentType.NotWorking:
             employmentPath = application_paths_1.paths.NotEmployed;
@@ -46,9 +49,8 @@ function generateEmployment(employment) {
     const employmentMapping = {
         applicationId: application_paths_1.paths.ApplicationId,
         applicantId: `${application_paths_1.paths.PersonApplicant}.@UniqueID`,
+        companyId: `${application_paths_1.paths.RelatedCompany}.@UniqueID`,
         id: `${employmentPath}.@UniqueID`,
-        abn: `${application_paths_1.paths.RelatedCompany}.@ABN`,
-        businessName: `${application_paths_1.paths.RelatedCompany}.@BusinessName`,
         type: `${employmentPath}.@Status`,
         employmentBasis: `${employmentPath}.@Basis`,
         startDate: `${employmentPath}.@StartDate`,
@@ -62,21 +64,13 @@ function generateEmployment(employment) {
                 case 'type':
                     (0, lodash_1.set)(partialApplication, employmentMapping[key], (0, lodash_1.capitalize)(value));
                     break;
-                case 'abn':
-                case 'businessName':
-                    // Only transform value in RelatedCompany for employed (self employed or employee) employment, otherwise RelatedCompany would missing UniqueID
-                    if (isEmployed) {
-                        (0, lodash_1.set)(partialApplication, employmentMapping[key], value.toString());
-                    }
-                    break;
                 case 'employmentBasis':
                     (0, lodash_1.set)(partialApplication, employmentMapping[key], enum_mappings_1.paygEmploymentBasisMapping[value]);
                     break;
-                case 'id':
-                    (0, lodash_1.set)(partialApplication, employmentMapping[key], value);
-                    if (isEmployed) {
-                        (0, lodash_1.set)(partialApplication, `${employmentPath}.@x_Employer`, `${value}-businessName`);
-                        (0, lodash_1.set)(partialApplication, `${application_paths_1.paths.RelatedCompany}.@UniqueID`, `${value}-businessName`);
+                case 'companyId':
+                    if (employment.employmentType === public_employment_1.EmploymentType.Employee) {
+                        (0, lodash_1.set)(partialApplication, `${employmentPath}.@x_Employer`, value);
+                        (0, lodash_1.set)(partialApplication, employmentMapping[key], value);
                     }
                     break;
                 case 'onProbation':
@@ -86,10 +80,13 @@ function generateEmployment(employment) {
                     }
                     break;
                 case 'role':
-                    const { anzsco = {} } = value;
+                    const { anzsco = {}, asco = {} } = value;
                     if (anzsco.code) {
                         (0, lodash_1.set)(partialApplication, `${employmentPath}.@ANZSCOOccupationCode`, anzsco.code.toString());
                     }
+                    if (asco.code) {
+                        (0, lodash_1.set)(partialApplication, `${employmentPath}.@OccupationCode`, asco.code);
+                    }
                     if (anzsco.occupation) {
                         (0, lodash_1.set)(partialApplication, employmentMapping[key], anzsco.occupation);
                     }
@@ -102,4 +99,4 @@ function generateEmployment(employment) {
     }
     return partialApplication;
 }
-exports.generateEmployment = generateEmployment;
+exports.transformEmployment = transformEmployment;

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

@@ -1,6 +1,6 @@
-import { AustralianStates } from '../events/public-employment';
+import { AustralianState } from '../events/public-required-document';
 declare type PostCodeMapping = {
-    [key in AustralianStates]: string;
+    [key in AustralianState]: string;
 };
 export declare const postcodeMapping: PostCodeMapping;
 export {};

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

@@ -2,14 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.postcodeMapping = void 0;
 // Mapping the postcode based on the state if not specified.
-const public_employment_1 = require("../events/public-employment");
+const public_required_document_1 = require("../events/public-required-document");
 exports.postcodeMapping = {
-    [public_employment_1.AustralianStates.Act]: '2600',
-    [public_employment_1.AustralianStates.Nsw]: '2000',
-    [public_employment_1.AustralianStates.NT]: '0800',
-    [public_employment_1.AustralianStates.Qld]: '4000',
-    [public_employment_1.AustralianStates.Sa]: '5000',
-    [public_employment_1.AustralianStates.Tas]: '7000',
-    [public_employment_1.AustralianStates.Vic]: '3000',
-    [public_employment_1.AustralianStates.Wa]: '6000',
+    [public_required_document_1.AustralianState.Act]: '2600',
+    [public_required_document_1.AustralianState.Nsw]: '2000',
+    [public_required_document_1.AustralianState.NT]: '0800',
+    [public_required_document_1.AustralianState.Qld]: '4000',
+    [public_required_document_1.AustralianState.Sa]: '5000',
+    [public_required_document_1.AustralianState.Tas]: '7000',
+    [public_required_document_1.AustralianState.Vic]: '3000',
+    [public_required_document_1.AustralianState.Wa]: '6000',
 };

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

@@ -10,11 +10,9 @@ export interface PublicEmployment {
     version: string;
 }
 /**
- * create employment payload
+ * create or update employment payload
  */
 export interface Payload {
-    abn?: number;
-    abnVerified?: boolean;
     /**
      * uuid of applicant
      */
@@ -23,18 +21,13 @@ export interface Payload {
      * uuid of application
      */
     applicationId: string;
-    businessName?: string;
-    businessStructure?: BusinessStructure;
     /**
-     * uuid of client
+     * uuid of the related company
      */
-    clientId?: string;
-    companyType?: CompanyType;
-    employerAddress?: EmployerAddress;
+    companyId?: string;
     employmentBasis?: EmploymentBasis;
     employmentType?: EmploymentType;
     endDate?: null | string;
-    foreignEmployed?: boolean;
     /**
      * uuid of employment
      */
@@ -43,72 +36,10 @@ export interface Payload {
     maternityLeaveReturnDate?: string;
     meta?: Meta;
     onProbation?: boolean;
-    privateOrPublic?: CompanyType;
     role?: Role;
     startDate?: string;
     type: PayloadType;
 }
-export declare enum BusinessStructure {
-    Company = "COMPANY",
-    Partnership = "PARTNERSHIP",
-    SoleTrader = "SOLE_TRADER",
-    Trust = "TRUST"
-}
-export declare enum CompanyType {
-    Private = "PRIVATE",
-    Public = "PUBLIC"
-}
-export interface EmployerAddress {
-    city?: string;
-    country?: string;
-    formatted?: string;
-    postcode?: string;
-    standard?: AddressStandard;
-    state?: AustralianStates;
-}
-/**
- * The address standard
- */
-export interface AddressStandard {
-    /**
-     * The building name
-     */
-    buildingName?: string;
-    /**
-     * The level of the unit/apartment
-     */
-    level?: string;
-    /**
-     * The lot number
-     */
-    lotSection?: string;
-    /**
-     * The street name
-     */
-    streetName?: string;
-    /**
-     * The street number
-     */
-    streetNumber?: string;
-    /**
-     * The type of the street i.e. road
-     */
-    streetType?: string;
-    /**
-     * The unit number
-     */
-    unit?: string;
-}
-export declare enum AustralianStates {
-    Act = "ACT",
-    NT = "NT",
-    Nsw = "NSW",
-    Qld = "QLD",
-    Sa = "SA",
-    Tas = "TAS",
-    Vic = "VIC",
-    Wa = "WA"
-}
 export declare enum EmploymentBasis {
     Casual = "CASUAL",
     Contractor = "CONTRACTOR",
@@ -131,7 +62,7 @@ export declare enum MaternityLeaveReturnBasis {
     PartTime = "PART_TIME"
 }
 /**
- * The metadata of the alieo
+ * The metadata of the employment
  */
 export interface Meta {
     /**
@@ -185,6 +116,6 @@ export declare enum PayloadType {
     Secondary = "SECONDARY"
 }
 export declare enum PublicEmploymentType {
-    EmploymentCreated = "EmploymentCreated",
-    EmploymentUpdated = "EmploymentUpdated"
+    EmploymentV2Created = "EmploymentV2Created",
+    EmploymentV2Updated = "EmploymentV2Updated"
 }

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

@@ -1,29 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PublicEmploymentType = exports.PayloadType = exports.ActionedByRole = exports.MaternityLeaveReturnBasis = exports.EmploymentType = exports.EmploymentBasis = exports.AustralianStates = exports.CompanyType = exports.BusinessStructure = void 0;
-var BusinessStructure;
-(function (BusinessStructure) {
-    BusinessStructure["Company"] = "COMPANY";
-    BusinessStructure["Partnership"] = "PARTNERSHIP";
-    BusinessStructure["SoleTrader"] = "SOLE_TRADER";
-    BusinessStructure["Trust"] = "TRUST";
-})(BusinessStructure = exports.BusinessStructure || (exports.BusinessStructure = {}));
-var CompanyType;
-(function (CompanyType) {
-    CompanyType["Private"] = "PRIVATE";
-    CompanyType["Public"] = "PUBLIC";
-})(CompanyType = exports.CompanyType || (exports.CompanyType = {}));
-var AustralianStates;
-(function (AustralianStates) {
-    AustralianStates["Act"] = "ACT";
-    AustralianStates["NT"] = "NT";
-    AustralianStates["Nsw"] = "NSW";
-    AustralianStates["Qld"] = "QLD";
-    AustralianStates["Sa"] = "SA";
-    AustralianStates["Tas"] = "TAS";
-    AustralianStates["Vic"] = "VIC";
-    AustralianStates["Wa"] = "WA";
-})(AustralianStates = exports.AustralianStates || (exports.AustralianStates = {}));
+exports.PublicEmploymentType = exports.PayloadType = exports.ActionedByRole = exports.MaternityLeaveReturnBasis = exports.EmploymentType = exports.EmploymentBasis = void 0;
 var EmploymentBasis;
 (function (EmploymentBasis) {
     EmploymentBasis["Casual"] = "CASUAL";
@@ -64,6 +41,6 @@ var PayloadType;
 })(PayloadType = exports.PayloadType || (exports.PayloadType = {}));
 var PublicEmploymentType;
 (function (PublicEmploymentType) {
-    PublicEmploymentType["EmploymentCreated"] = "EmploymentCreated";
-    PublicEmploymentType["EmploymentUpdated"] = "EmploymentUpdated";
+    PublicEmploymentType["EmploymentV2Created"] = "EmploymentV2Created";
+    PublicEmploymentType["EmploymentV2Updated"] = "EmploymentV2Updated";
 })(PublicEmploymentType = exports.PublicEmploymentType || (exports.PublicEmploymentType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.7.0",
+  "version": "1.7.1-beta.0",
   "description": "Library for kafka event data transforming",
   "author": "Integrations <integrations@lendi.com.au>",
   "homepage": "https://bitbucket.org/lendi-dev/integrations-shared-packages#readme",