feat(src): add tier 1 module

Author: vpinodev

env/.develop.env

@@ -1,7 +1,7 @@
 NODE_ENV=develop
 
 ## SERVER
-PORT=3001
+PORT=3007
 
 ## DATABASE
 POSTGRES_DATABASE=fuap_dev
@@ -11,7 +11,7 @@ POSTGRES_USER=fuap
 POSTGRES_PASSWORD=fuap_dev
 MODE=DEV
 SYNCHRONIZE=true
-LOGGING=error, query,
+LOGGING='error, query',
 
 ## JWT
 AUTH_EXPIRED=24h
@@ -22,3 +22,7 @@ THROTTLER_NAME=THROTTLER
 THROTTLER_TTL=60000
 THROTTLER_LIMIT=10
 
+## EQUIFAX
+EQUIFAX_BASE_URL=https://api.sandbox.equifax.com
+EQUIFAX_CLIENT_ID=185b5c5d9ada76aed787998acb9ac4f284c689993c6a24ff5249d4796717879ee1003eb44f5cfdf0c4049815ade39060
+EQUIFAX_CLIENT_SECRET=94cecd343affc1b67480c8e3b6e8819f9a9923c3d4f46c562193335deb871da9

env/.production.env

@@ -22,3 +22,7 @@ THROTTLER_NAME=THROTTLER
 THROTTLER_TTL=60000
 THROTTLER_LIMIT=10
 
+## EQUIFAX
+EQUIFAX_BASE_URL=https://api.sandbox.equifax.com
+EQUIFAX_CLIENT_ID=185b5c5d9ada76aed787998acb9ac4f284c689993c6a24ff5249d4796717879ee1003eb44f5cfdf0c4049815ade39060
+EQUIFAX_CLIENT_SECRET=94cecd343affc1b67480c8e3b6e8819f9a9923c3d4f46c562193335deb871da9

package.json

@@ -49,7 +49,8 @@
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "typeorm": "^0.3.20",
-    "uuid": "^10.0.0"
+    "uuid": "^10.0.0",
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.3.2",

src/app.module.ts

@@ -43,12 +43,20 @@ import { CreditCardModule } from './modules/credit-card/credit-card.module';
 import { HomeLoanModule } from './modules/home-loan/home-loan.module';
 import { BridgeLoanModule } from './modules/bridge-loan/bridge-loan.module';
 import { WebhookModule } from './modules/webhook/webhook.module';
+import equifaxConfig from './config/equifax.config';
+import { EquifaxModule } from './modules/equifax/equifax.module';
 
 @Module({
   imports: [
     ConfigModule.forRoot({
       envFilePath: `./env/.${process.env.NODE_ENV}.env`,
-      load: [serverConfig, databaseConfig, jwtConfig, throttlerConfig],
+      load: [
+        serverConfig,
+        databaseConfig,
+        jwtConfig,
+        throttlerConfig,
+        equifaxConfig,
+      ],
       isGlobal: true,
     }),
     TypeOrmModule.forRootAsync({
@@ -126,6 +134,7 @@ import { WebhookModule } from './modules/webhook/webhook.module';
     HomeLoanModule,
     BridgeLoanModule,
     WebhookModule,
+    EquifaxModule,
   ],
   providers: [
     {

src/common/adapters/axios.adapter.ts

@@ -12,7 +12,53 @@ export class AxiosAdapter implements HttpAdapter {
 
       return data;
     } catch (error) {
-      throw new Error(`error: ${error}`);
+      throw new Error(
+        `error: ${error?.response?.data ?? error?.message ?? error}`,
+      );
+    }
+  }
+
+  async post<T>(
+    url: string,
+    data?: any,
+    config?: AxiosRequestConfig,
+  ): Promise<T> {
+    try {
+      const { data: responseData } = await this.axios.post<T>(
+        url,
+        data,
+        config,
+      );
+      return responseData;
+    } catch (error) {
+      const err = `${error?.response?.data ?? error?.message ?? error}`;
+      throw new Error(`error: ${err}`);
+    }
+  }
+
+  async put<T>(
+    url: string,
+    data?: any,
+    config?: AxiosRequestConfig,
+  ): Promise<T> {
+    try {
+      const { data: responseData } = await this.axios.put<T>(url, data, config);
+      return responseData;
+    } catch (error) {
+      throw new Error(
+        `error: ${error?.response?.data ?? error?.message ?? error}`,
+      );
+    }
+  }
+
+  async delete<T>(url: string, config?: AxiosRequestConfig): Promise<T> {
+    try {
+      const { data } = await this.axios.delete<T>(url, config);
+      return data;
+    } catch (error) {
+      throw new Error(
+        `error: ${error?.response?.data ?? error?.message ?? error}`,
+      );
     }
   }
 }

src/common/constans/urls.ts

@@ -0,0 +1,41 @@
+export const URLs = {
+  equifax: {
+    oauth: {
+      token: '/v1/oauth/token',
+      tokenV2: '/v2/oauth/token',
+    },
+    business: {
+      asset: {
+        scope: '/business/asset-view/v1',
+        initiate: '/business/verification-of-assets/v1/initiate',
+        retrieve: '/business/asset-view/v1/retrieve',
+        refresh: '/business/asset-view/v1/refresh',
+      },
+      scoreAttributes: {
+        scope: 'https://api.equifax.com/business/scores-and-attributes/v2',
+        creditReport: '/business/scores-and-attributes/v2/credit-report',
+      },
+      bankTransactionData: {
+        scope: 'https://api.equifax.com/business/bankingandlending/v1',
+        userRegister: '/business/bankingandlending/v1/user-registrations',
+      },
+      oneView: {
+        scope: 'https://api.equifax.com/business/oneview/consumer-credit/v1',
+        consumerCredit:
+          '/business/oneview/consumer-credit/v1/reports/credit-report',
+      },
+      chexAdvisor: {
+        scope: '/business/datax/v1',
+        request: '/business/datax/v1/core',
+      },
+      preApprovalOne: {
+        scope: 'https://api.equifax.com/business/preapproval-of-one/v1',
+        reportRequest: '/business/preapproval-of-one/v1/report-requests',
+      },
+      preQualification: {
+        scope: 'https://api.equifax.com/business/prequal-of-one/v1',
+        reportRequest: '/business/prequal-of-one/v1/report-requests',
+      },
+    },
+  },
+};

src/common/functions/encryption.function.ts

@@ -0,0 +1,31 @@
+import * as crypto from 'crypto';
+
+export function encrypt(text: string, secretKey: string): string {
+  const cipher = crypto.createCipheriv(
+    this.algorithm,
+    Buffer.from(secretKey, 'hex'),
+    Buffer.from(this.iv, 'hex'),
+  );
+  const encrypted = Buffer.concat([cipher.update(text), cipher.final()]);
+  return encrypted.toString('hex');
+}
+
+export function decrypt(encryptedText: string): string {
+  const encryptedTextBuffer = Buffer.from(encryptedText, 'hex');
+  const decipher = crypto.createDecipheriv(
+    'aes-256-cbc',
+    Buffer.from(
+      'b41f7562df6b9a41d8dc1803d24cf4e3213d49cbf62317d1c674930dcaa02b0e',
+      'hex',
+    ),
+    Buffer.from('ff2f0a87a95e57eaaab63b7772d94d2a', 'hex'),
+  );
+  const decrypted = Buffer.concat([
+    decipher.update(encryptedTextBuffer),
+    decipher.final(),
+  ]);
+  return decrypted.toString();
+}
+
+// 'Encrypted Client ID:' '185b5c5d9ada76aed787998acb9ac4f284c689993c6a24ff5249d4796717879ee1003eb44f5cfdf0c4049815ade39060'
+// 'Encrypted Client Secret:' '94cecd343affc1b67480c8e3b6e8819f9a9923c3d4f46c562193335deb871da9'

src/common/interfaces/http-adapter.interface.ts

@@ -1,3 +1,8 @@
+import { AxiosRequestConfig } from 'axios';
+
 export interface HttpAdapter {
-  get<T>(url: string): Promise<T>;
+  get<T>(url: string, config?: AxiosRequestConfig): Promise<T>;
+  post<T>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+  put<T>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+  delete<T>(url: string, config?: AxiosRequestConfig): Promise<T>;
 }

src/config/equifax.config.ts

@@ -0,0 +1,7 @@
+import { registerAs } from '@nestjs/config';
+
+export default registerAs('equifax', () => ({
+  baseUrl: process.env.EQUIFAX_BASE_URL,
+  clientId: process.env.EQUIFAX_CLIENT_ID,
+  clientSecret: process.env.EQUIFAX_CLIENT_SECRET,
+}));

src/modules/equifax/dtos/asset-view/initiate-request.dto.ts

@@ -0,0 +1,149 @@
+import {
+  IsString,
+  IsEmail,
+  IsBoolean,
+  IsObject,
+  IsDateString,
+  IsNotEmpty,
+} from 'class-validator';
+import { Type } from 'class-transformer';
+import { ApiProperty } from '@nestjs/swagger';
+
+class AddressDTO {
+  @ApiProperty({ description: 'Primary address line' })
+  @IsString()
+  @IsNotEmpty()
+  address1: string;
+
+  @ApiProperty({ description: 'City of the address' })
+  @IsString()
+  @IsNotEmpty()
+  city: string;
+
+  @ApiProperty({ description: 'State of the address' })
+  @IsString()
+  @IsNotEmpty()
+  state: string;
+
+  @ApiProperty({ description: 'ZIP code of the address' })
+  @IsString()
+  @IsNotEmpty()
+  zipCode: string;
+
+  @ApiProperty({ description: 'Country of the address' })
+  @IsString()
+  @IsNotEmpty()
+  country: string;
+}
+
+class ConsumerDTO {
+  @ApiProperty({ description: 'Consumer identifier' })
+  @IsString()
+  @IsNotEmpty()
+  identifier: string;
+
+  @ApiProperty({ description: 'Consumer first name' })
+  @IsString()
+  @IsNotEmpty()
+  firstName: string;
+
+  @ApiProperty({ description: 'Consumer last name' })
+  @IsString()
+  @IsNotEmpty()
+  lastName: string;
+
+  @ApiProperty({ description: 'Consumer email' })
+  @IsEmail()
+  @IsNotEmpty()
+  email: string;
+
+  @ApiProperty({ description: 'Consumer date of birth' })
+  @IsDateString()
+  @IsNotEmpty()
+  dob: string;
+
+  @ApiProperty({ description: 'Consumer address', type: AddressDTO })
+  @IsObject()
+  @Type(() => AddressDTO)
+  address: AddressDTO;
+}
+
+class ResellerDTO {
+  @ApiProperty({ description: 'Is the reseller self?' })
+  @IsBoolean()
+  self: boolean;
+
+  @ApiProperty({ description: 'End user organization ID' })
+  @IsString()
+  @IsNotEmpty()
+  endUserOrganizationId: string;
+
+  @ApiProperty({ description: 'End user name' })
+  @IsString()
+  @IsNotEmpty()
+  endUserName: string;
+}
+
+class ConnectorDTO {
+  @ApiProperty({ description: 'Platform of the connector' })
+  @IsString()
+  @IsNotEmpty()
+  platform: string;
+
+  @ApiProperty({ description: 'Intermediary of the connector' })
+  @IsString()
+  @IsNotEmpty()
+  intermediary: string;
+
+  @ApiProperty({ description: 'End user of the connector' })
+  @IsString()
+  @IsNotEmpty()
+  endUser: string;
+}
+
+export class InitiateRequestDTO {
+  @ApiProperty({ description: 'Permissible purpose' })
+  @IsString()
+  @IsNotEmpty()
+  permissiblePurpose: string;
+
+  @ApiProperty({ description: 'Loan number' })
+  @IsString()
+  @IsNotEmpty()
+  loanNumber: string;
+
+  @ApiProperty({ description: 'Monitoring duration' })
+  @IsString()
+  @IsNotEmpty()
+  monitoringDuration: string;
+
+  @ApiProperty({ description: 'CC email' })
+  @IsEmail()
+  @IsNotEmpty()
+  ccEmail: string;
+
+  @ApiProperty({ description: 'Order start date' })
+  @IsDateString()
+  @IsNotEmpty()
+  orderStartDate: string;
+
+  @ApiProperty({ description: 'Order end date' })
+  @IsDateString()
+  @IsNotEmpty()
+  orderEndDate: string;
+
+  @ApiProperty({ description: 'Consumer details', type: ConsumerDTO })
+  @IsObject()
+  @Type(() => ConsumerDTO)
+  consumer: ConsumerDTO;
+
+  @ApiProperty({ description: 'Reseller details', type: ResellerDTO })
+  @IsObject()
+  @Type(() => ResellerDTO)
+  reseller: ResellerDTO;
+
+  @ApiProperty({ description: 'Connector details', type: ConnectorDTO })
+  @IsObject()
+  @Type(() => ConnectorDTO)
+  connector: ConnectorDTO;
+}