@fiado/type-kit 1.2.0 → 1.2.2

package/README.md

@@ -1,70 +1,70 @@
-# fiado-type-kit
-
-## Descripción
-**fiado-type-kit** es una biblioteca TypeScript diseñada para facilitar el desarrollo de funciones AWS Lambda al proporcionar un conjunto estructurado de Data Transfer Objects (DTOs), enumeraciones y constantes. Está organizada por dominios específicos (`card`, `account`, `directory`, `otros`) para mejorar la modularidad y la reutilización del código en proyectos de AWS Lambda.
-
-## Estructura del Proyecto
-
-**fiado-type-kit/**  
-📁 `/src` - Contiene el código fuente TypeScript, organizado por dominios.
-  - 📁 `card` - Funciones y tipos relacionados con tarjetas.
-    - 📁 `dtos` - Data Transfer Objects para `card`.
-      - 📄 `cardRequest.dto.ts`
-      - 📄 `cardResponse.dto.ts`
-    - 📁 `enums` - Enumeraciones específicas de `card`.
-      - 📄 `cardType.enum.ts`
-    - 📁 `constants` - Constantes de `card`.
-      - 📄 `cardConstants.ts`
-    - 📄 `index.ts` - Exporta los elementos de `card`.
-  - 📁 `account` - Funciones y tipos relacionados con cuentas.
-    - [Repita la estructura similar a `card`]
-  - 📁 `user` - Funciones y tipos relacionados con usuarios.
-    - [Repita la estructura similar a `card`]
-📁 `/bin` - Contiene los archivos transpilados y listos para producción.
-📁 `/test` - Incluye pruebas para los distintos componentes de la biblioteca.
-📄 `package.json`
-📄 `tsconfig.json`
-📄 `README.md`
-
-## Convenciones de Nombres y Validaciones
-### Convenciones de Nombres para DTOs
-Para mantener la coherencia y claridad en nuestros DTOs (Data Transfer Objects), seguimos una convención de nombres estricta. Los nombres de los archivos DTO deben reflejar claramente su propósito y el dominio al que pertenecen. Por ejemplo, para **card**:
-
-- **Solicitudes**: El nombre debe comenzar con la entidad a la que pertenece, seguir con la acción y terminar con Request. Ejemplo: **CardActivateRequest.ts**, **CardCreateRequest.ts**, **CardUpdateRequest.ts**, **CardDeleteRequest.ts**.
-- **Respuestas**: Debe comenzar con la entidad y terminar con Response. Ejemplo: **CardBalanceResponse.ts**. **CardResponse.ts**
-
-### Uso de class-validator en DTOs
-Al definir DTOs de solicitud, es esencial aplicar validaciones a todas las propiedades de la clase para garantizar que los datos recibidos cumplan con nuestras expectativas y restricciones. Usamos **class-validator** para este propósito:
-
-- **Solicitudes**: Todas las propiedades de las clases de solicitud deben tener decoradores de **class-validator** para validar la entrada.
-- **Respuestas**: Las clases de respuesta no deben incluir validaciones de **class-validator**, ya que son utilizadas solo para enviar datos al cliente.
-
-#### Ejemplo de un DTO de Solicitud con class-validator:
-
-```typescript
-import { IsNotEmpty, IsString, IsNumber } from 'class-validator';
-
-export class CardActivateRequest {
-  @IsNotEmpty()
-  @IsString()
-  readonly userId: string;
-
-  @IsNotEmpty()
-  @IsNumber()
-  readonly cardId: number;
-}
-```
-## Uso
-Para utilizar **fiado-type-kit** en tu proyecto, asegúrate de importar los componentes específicos que necesitas de cada dominio. Por ejemplo:
-
-```typescript
-import { AccountResponse, AccountCreateRequest } from "@fiado/type-kit/bin/account";
-import { CardRequest } from 'fiado-type-kit/dist/card/dtos/cardRequest.dto';
-import { AccountType } from 'fiado-type-kit/dist/account/enums/accountType.enum';
-```
-
-### Instalación 
-Para instalar la biblioteca fiado-type-kit en tu proyecto, ejecuta el siguiente comando usando npm:
-
-npm i @fiado/type-kit
-
+# fiado-type-kit
+
+## Descripción
+**fiado-type-kit** es una biblioteca TypeScript diseñada para facilitar el desarrollo de funciones AWS Lambda al proporcionar un conjunto estructurado de Data Transfer Objects (DTOs), enumeraciones y constantes. Está organizada por dominios específicos (`card`, `account`, `directory`, `otros`) para mejorar la modularidad y la reutilización del código en proyectos de AWS Lambda.
+
+## Estructura del Proyecto
+
+**fiado-type-kit/**  
+📁 `/src` - Contiene el código fuente TypeScript, organizado por dominios.
+  - 📁 `card` - Funciones y tipos relacionados con tarjetas.
+    - 📁 `dtos` - Data Transfer Objects para `card`.
+      - 📄 `cardRequest.dto.ts`
+      - 📄 `cardResponse.dto.ts`
+    - 📁 `enums` - Enumeraciones específicas de `card`.
+      - 📄 `cardType.enum.ts`
+    - 📁 `constants` - Constantes de `card`.
+      - 📄 `cardConstants.ts`
+    - 📄 `index.ts` - Exporta los elementos de `card`.
+  - 📁 `account` - Funciones y tipos relacionados con cuentas.
+    - [Repita la estructura similar a `card`]
+  - 📁 `user` - Funciones y tipos relacionados con usuarios.
+    - [Repita la estructura similar a `card`]
+📁 `/bin` - Contiene los archivos transpilados y listos para producción.
+📁 `/test` - Incluye pruebas para los distintos componentes de la biblioteca.
+📄 `package.json`
+📄 `tsconfig.json`
+📄 `README.md`
+
+## Convenciones de Nombres y Validaciones
+### Convenciones de Nombres para DTOs
+Para mantener la coherencia y claridad en nuestros DTOs (Data Transfer Objects), seguimos una convención de nombres estricta. Los nombres de los archivos DTO deben reflejar claramente su propósito y el dominio al que pertenecen. Por ejemplo, para **card**:
+
+- **Solicitudes**: El nombre debe comenzar con la entidad a la que pertenece, seguir con la acción y terminar con Request. Ejemplo: **CardActivateRequest.ts**, **CardCreateRequest.ts**, **CardUpdateRequest.ts**, **CardDeleteRequest.ts**.
+- **Respuestas**: Debe comenzar con la entidad y terminar con Response. Ejemplo: **CardBalanceResponse.ts**. **CardResponse.ts**
+
+### Uso de class-validator en DTOs
+Al definir DTOs de solicitud, es esencial aplicar validaciones a todas las propiedades de la clase para garantizar que los datos recibidos cumplan con nuestras expectativas y restricciones. Usamos **class-validator** para este propósito:
+
+- **Solicitudes**: Todas las propiedades de las clases de solicitud deben tener decoradores de **class-validator** para validar la entrada.
+- **Respuestas**: Las clases de respuesta no deben incluir validaciones de **class-validator**, ya que son utilizadas solo para enviar datos al cliente.
+
+#### Ejemplo de un DTO de Solicitud con class-validator:
+
+```typescript
+import { IsNotEmpty, IsString, IsNumber } from 'class-validator';
+
+export class CardActivateRequest {
+  @IsNotEmpty()
+  @IsString()
+  readonly userId: string;
+
+  @IsNotEmpty()
+  @IsNumber()
+  readonly cardId: number;
+}
+```
+## Uso
+Para utilizar **fiado-type-kit** en tu proyecto, asegúrate de importar los componentes específicos que necesitas de cada dominio. Por ejemplo:
+
+```typescript
+import { AccountResponse, AccountCreateRequest } from "@fiado/type-kit/bin/account";
+import { CardRequest } from 'fiado-type-kit/dist/card/dtos/cardRequest.dto';
+import { AccountType } from 'fiado-type-kit/dist/account/enums/accountType.enum';
+```
+
+### Instalación 
+Para instalar la biblioteca fiado-type-kit en tu proyecto, ejecuta el siguiente comando usando npm:
+
+npm i @fiado/type-kit
+

package/package.json

@@ -1,24 +1,24 @@
-{
-	"name": "@fiado/type-kit",
-	"version": "1.2.0",
-	"description": "",
-	"main": "bin/index.js",
-	"types": "bin/index.d.ts",
-	"scripts": {
-		"test": "jest",
-		"build": "tsc"
-	},
-	"keywords": [],
-	"author": "Fiado Inc",
-	"license": "ISC",
-	"devDependencies": {
-		"@types/node": "^20.11.20",
-		"install": "^0.13.0",
-		"npm": "^10.4.0",
-		"typescript": "^5.3.3"
-	},
-	"dependencies": {
-		"class-transformer": "^0.5.1",
-		"class-validator": "^0.14.1"
-	}
+{
+	"name": "@fiado/type-kit",
+	"version": "1.2.2",
+	"description": "",
+	"main": "bin/index.js",
+	"types": "bin/index.d.ts",
+	"scripts": {
+		"test": "jest",
+		"build": "tsc"
+	},
+	"keywords": [],
+	"author": "Fiado Inc",
+	"license": "ISC",
+	"devDependencies": {
+		"@types/node": "^20.11.20",
+		"install": "^0.13.0",
+		"npm": "^10.4.0",
+		"typescript": "^5.3.3"
+	},
+	"dependencies": {
+		"class-transformer": "^0.5.1",
+		"class-validator": "^0.14.1"
+	}
 }

package/src/account/dtos/AccountCreateRequest.ts

@@ -1,79 +1,79 @@
-import { IsBoolean, IsDateString, IsEmail, IsEnum, IsOptional, IsString, Length, Matches, ValidateNested } from 'class-validator';
-import { AddressResponse } from "../../address";
-import { CountryId } from "../../country";
-import { regexUuidV4 } from '../../helpers/constans/regex';
-import { TypeOfDirectoryId } from '../../directory';
-import { IsPhoneNumberFiado } from '../../card/validations/IsPhoneNumberConstraint';
-import { SexDocument } from '../../identity';
-import { Profile } from "../../directory/enums/Profile";
-import {AccountLevelEnum} from "../enums/AccountLevelEnum";
-
-export class AccountCreateRequest {
-
-    @IsString()
-    @Matches(regexUuidV4,
-        {
-            message: 'directoryId must be a valid UUID v4',
-        })
-    directoryId: string;
-    
-
-    @IsString()
-    @Matches(regexUuidV4,
-        {
-            message: 'directoryId must be a valid UUID v4',
-        })
-    ownerDirectoryId: string;
-
-    @IsString()
-    @Matches(regexUuidV4,
-        {
-            message: 'peopleId must be a valid UUID v4',
-        })
-    peopleId: string;
-
-    @IsEnum(AccountLevelEnum)
-    accountLevel: AccountLevelEnum;
-
-    @IsEnum(TypeOfDirectoryId)
-    typeOfDirectoryId: string;
-
-    @IsString()
-    firstName: string;
-
-    @IsString()
-    lastName: string;
-
-    @IsPhoneNumberFiado()
-    phoneNumber: string;
-
-    @ValidateNested()
-    address: AddressResponse;
-
-    @IsEmail()
-    email: string;
-
-    @IsDateString()
-    dob: string;
-
-    @IsBoolean()
-    isHost?: boolean;
-
-    @IsString()
-    @Length(1, 30)
-    documentNumber: string;
-
-    @IsString()
-    @Length(1, 30)
-    documentType: string;
-
-    @IsOptional()
-    @IsEnum(SexDocument)
-    gender: SexDocument;
-
-    @IsEnum(CountryId)
-    countryId: CountryId;
-
-    @IsEnum(Profile)
-    userProfile: Profile;
-}
+import { IsBoolean, IsDateString, IsEmail, IsEnum, IsOptional, IsString, Length, Matches, ValidateNested } from 'class-validator';
+import { AddressResponse } from "../../address";
+import { CountryId } from "../../country";
+import { regexUuidV4 } from '../../helpers/constans/regex';
+import { TypeOfDirectoryId } from '../../directory';
+import { IsPhoneNumberFiado } from '../../card/validations/IsPhoneNumberConstraint';
+import { SexDocument } from '../../identity';
+import { Profile } from "../../directory/enums/Profile";
+import {AccountLevelEnum} from "../enums/AccountLevelEnum";
+
+export class AccountCreateRequest {
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'directoryId must be a valid UUID v4',
+        })
+    directoryId: string;
+    
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'directoryId must be a valid UUID v4',
+        })
+    ownerDirectoryId: string;
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'peopleId must be a valid UUID v4',
+        })
+    peopleId: string;
+
+    @IsEnum(AccountLevelEnum)
+    accountLevel: AccountLevelEnum;
+
+    @IsEnum(TypeOfDirectoryId)
+    typeOfDirectoryId: string;
+
+    @IsString()
+    firstName: string;
+
+    @IsString()
+    lastName: string;
+
+    @IsPhoneNumberFiado()
+    phoneNumber: string;
+
+    @ValidateNested()
+    address: AddressResponse;
+
+    @IsEmail()
+    email: string;
+
+    @IsDateString()
+    dob: string;
+
+    @IsBoolean()
+    isHost?: boolean;
+
+    @IsString()
+    @Length(1, 30)
+    documentNumber: string;
+
+    @IsString()
+    @Length(1, 30)
+    documentType: string;
+
+    @IsOptional()
+    @IsEnum(SexDocument)
+    gender: SexDocument;
+
+    @IsEnum(CountryId)
+    countryId: CountryId;
+
+    @IsEnum(Profile)
+    userProfile: Profile;
+}

package/src/account/dtos/AccountCreateResponse.ts

@@ -1,8 +1,8 @@
-export class AccountCreateResponse{
-    id: string;
-    externalId: string;
-    externalUserId: string;
-    directoryId:string;
-    typeOfDirectoryId:string
-    countryId:string
+export class AccountCreateResponse{
+    id: string;
+    externalId: string;
+    externalUserId: string;
+    directoryId:string;
+    typeOfDirectoryId:string
+    countryId:string
 }

package/src/account/dtos/AccountInfo.ts

@@ -1,40 +1,40 @@
-import {IsEnum, IsNumber, IsString, Matches} from "class-validator";
-import {regexUuidV4} from "../../helpers/constans/regex";
-import {AccountEntityStatusEnum} from "../enums/AccountEntityStatusEnum";
-
-export default class AccountInfo {
-    @IsString()
-    @Matches(regexUuidV4,
-        {
-            message: 'directoryId must be a valid UUID v4',
-        })
-    id: string;
-
-    @IsString()
-    @Matches(regexUuidV4,
-        {
-            message: 'directoryId must be a valid UUID v4',
-        })
-    directoryId: string;
-
-    @IsString()
-    currencyId: string;
-
-    @IsNumber()
-    currentBalance: number;
-
-    @IsNumber()
-    availableBalance: number;
-
-    @IsNumber()
-    lockedBalance: number;
-
-    @IsString()
-    accountNumber: string;
-
-    @IsString()
-    routingNumber: string;
-
-    @IsEnum(AccountEntityStatusEnum)
-    status: AccountEntityStatusEnum;
+import {IsEnum, IsNumber, IsString, Matches} from "class-validator";
+import {regexUuidV4} from "../../helpers/constans/regex";
+import {AccountEntityStatusEnum} from "../enums/AccountEntityStatusEnum";
+
+export default class AccountInfo {
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'directoryId must be a valid UUID v4',
+        })
+    id: string;
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'directoryId must be a valid UUID v4',
+        })
+    directoryId: string;
+
+    @IsString()
+    currencyId: string;
+
+    @IsNumber()
+    currentBalance: number;
+
+    @IsNumber()
+    availableBalance: number;
+
+    @IsNumber()
+    lockedBalance: number;
+
+    @IsString()
+    accountNumber: string;
+
+    @IsString()
+    routingNumber: string;
+
+    @IsEnum(AccountEntityStatusEnum)
+    status: AccountEntityStatusEnum;
 }

package/src/account/dtos/AccountUpdateBalanceRequest.ts

@@ -1,7 +1,7 @@
-import {UpdateBalanceOperation} from "./UpdateBalanceOperation";
-import {IsArray} from "class-validator";
-
-export class AccountUpdateBalanceRequest {
-    @IsArray()
-    operations: UpdateBalanceOperation[];
+import {UpdateBalanceOperation} from "./UpdateBalanceOperation";
+import {IsArray} from "class-validator";
+
+export class AccountUpdateBalanceRequest {
+    @IsArray()
+    operations: UpdateBalanceOperation[];
 }

package/src/account/dtos/BankAccountExternalAddress.ts

@@ -1,18 +1,18 @@
-export class BankAccountExternalAddress {
-    // TERN
-    address1?: string;
-    address2?: string;
-    province?: string;
-    postalCode?: string;
-    // POMELO
-    streetName?: string;
-    streetNumber?: string;
-    apartment?: string;
-    region?: string;
-    zipCode?: string;
-    neighborhood?: string;
-    additionalInfo?: string;
-    // COMMON PARAMETERS
-    city?: string;
-    country?: string;
+export class BankAccountExternalAddress {
+    // TERN
+    address1?: string;
+    address2?: string;
+    province?: string;
+    postalCode?: string;
+    // POMELO
+    streetName?: string;
+    streetNumber?: string;
+    apartment?: string;
+    region?: string;
+    zipCode?: string;
+    neighborhood?: string;
+    additionalInfo?: string;
+    // COMMON PARAMETERS
+    city?: string;
+    country?: string;
 }

package/src/account/dtos/BankAccountP2pTransferRequest.ts

@@ -1,8 +1,8 @@
-import {BankAccountP2pTransferType} from "../enums/BankAccountP2pTransferType";
-
-export class BankAccountP2pTransferRequest {
-    transfer_type: BankAccountP2pTransferType;
-    from_account_id: number;
-    to_account_id: number;
-    amount: number;
+import {BankAccountP2pTransferType} from "../enums/BankAccountP2pTransferType";
+
+export class BankAccountP2pTransferRequest {
+    transfer_type: BankAccountP2pTransferType;
+    from_account_id: number;
+    to_account_id: number;
+    amount: number;
 }

package/src/account/dtos/CreateBankAccountRequest.ts

@@ -1,11 +1,11 @@
-import { BankAccountTypeEnum } from "../enums/BankAccountTypeEnum";
-
-export class CreateBankAccountRequest {
-    externalClientId?: string;
-    externalUserId?: string;
-    name: string;
-    lastName: string;
-    type: BankAccountTypeEnum;
-}  
-
-
+import { BankAccountTypeEnum } from "../enums/BankAccountTypeEnum";
+
+export class CreateBankAccountRequest {
+    externalClientId?: string;
+    externalUserId?: string;
+    name: string;
+    lastName: string;
+    type: BankAccountTypeEnum;
+}  
+
+

package/src/account/dtos/CreateBankAccountResponse.ts

@@ -1,8 +1,8 @@
-import { Provider } from "../../provider";
-
-export class CreateBankAccountResponse {
-    externalAccountId: string
-    provider: Provider
-}
-
-
+import { Provider } from "../../provider";
+
+export class CreateBankAccountResponse {
+    externalAccountId: string
+    provider: Provider
+}
+
+

package/src/account/dtos/CreateBankAccountUserRequest.ts

@@ -1,17 +1,17 @@
-import {AddressBase} from "../../address/dtos/AddressBase";
-
-export class CreateBankAccountUserRequest {
-    directoryId: string;
-    typeOfDirectoryId: string;
-    firstName: string;
-    lastName: string;
-    phoneNumber: string;
-    address: AddressBase;
-    email: string;
-    dob: string;
-    documentNumber: string;
-    documentType?: string;
-    gender?: "M" | "F";
-}  
-
-
+import {AddressBase} from "../../address/dtos/AddressBase";
+
+export class CreateBankAccountUserRequest {
+    directoryId: string;
+    typeOfDirectoryId: string;
+    firstName: string;
+    lastName: string;
+    phoneNumber: string;
+    address: AddressBase;
+    email: string;
+    dob: string;
+    documentNumber: string;
+    documentType?: string;
+    gender?: "M" | "F";
+}  
+
+

package/src/account/dtos/CreateBankAccountUserResponse.ts

@@ -1,11 +1,11 @@
-import { Provider } from "../../provider";
-
-export class CreateBankAccountUserResponse {
-    externalUserId:string
-    externalAccountId?:string
-    provider:Provider
-    accountNumber?:string
-    routingNumber?:string
-}
-
-
+import { Provider } from "../../provider";
+
+export class CreateBankAccountUserResponse {
+    externalUserId:string
+    externalAccountId?:string
+    provider:Provider
+    accountNumber?:string
+    routingNumber?:string
+}
+
+

package/src/account/dtos/ExchangeInfo.ts

@@ -1,9 +1,9 @@
-import {IsNumber, IsString} from "class-validator";
-
-export default class ExchangeInfo {
-    @IsString()
-    currencyId: string;
-
-    @IsNumber()
-    rate: number;
+import {IsNumber, IsString} from "class-validator";
+
+export default class ExchangeInfo {
+    @IsString()
+    currencyId: string;
+
+    @IsNumber()
+    rate: number;
 }

package/src/account/dtos/ExecuteP2pOperationRequest.ts

@@ -1,8 +1,8 @@
-import {CountryId} from "../../country";
-
-export class ExecuteP2pOperationRequest {
-    sourceDirectoryId: string;
-    targetDirectoryId: string;
-    amount: number;
-    currencyId: CountryId;
+import {CountryId} from "../../country";
+
+export class ExecuteP2pOperationRequest {
+    sourceDirectoryId: string;
+    targetDirectoryId: string;
+    amount: number;
+    currencyId: CountryId;
 }

package/src/account/dtos/ExecutePocketOperationRequest.ts

@@ -1,6 +1,6 @@
-import {IsNumber} from "class-validator";
-
-export class ExecutePocketOperationRequest {
-    @IsNumber()
-    amount: number;
+import {IsNumber} from "class-validator";
+
+export class ExecutePocketOperationRequest {
+    @IsNumber()
+    amount: number;
 }