@fiado/type-kit 1.0.4 → 1.0.6

package/bin/card/validations/IsPhoneNumberConstraint.js

@@ -0,0 +1,36 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsPhoneNumberFiado = exports.IsPhoneNumberConstraint = void 0;
+const class_validator_1 = require("class-validator");
+const regex_1 = require("../../helpers/constans/regex");
+let IsPhoneNumberConstraint = class IsPhoneNumberConstraint {
+    validate(phoneNumber, args) {
+        return regex_1.regexPhoneNumber.test(phoneNumber);
+    }
+    defaultMessage(args) {
+        return "The phone number is not valid. The expected format is +############.";
+    }
+};
+exports.IsPhoneNumberConstraint = IsPhoneNumberConstraint;
+exports.IsPhoneNumberConstraint = IsPhoneNumberConstraint = __decorate([
+    (0, class_validator_1.ValidatorConstraint)({ async: true })
+], IsPhoneNumberConstraint);
+// Decorador que usaremos en nuestras clases DTO
+function IsPhoneNumberFiado(validationOptions) {
+    return function (object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            target: object.constructor,
+            propertyName: propertyName,
+            options: validationOptions,
+            constraints: [],
+            validator: IsPhoneNumberConstraint,
+        });
+    };
+}
+exports.IsPhoneNumberFiado = IsPhoneNumberFiado;

package/bin/country/enums/Country.d.ts

@@ -0,0 +1,4 @@
+export declare enum Country {
+    MEX = "MEX",
+    USA = "USA"
+}

package/bin/country/enums/Country.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Country = void 0;
+var Country;
+(function (Country) {
+    Country["MEX"] = "MEX";
+    Country["USA"] = "USA";
+})(Country || (exports.Country = Country = {}));

package/bin/country/enums/CountryId.js

@@ -1,4 +1,5 @@
 "use strict";
+//*
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CountryId = void 0;
 var CountryId;

package/bin/country/index.d.ts

@@ -1 +1,2 @@
 export * from './enums/CountryId';
+export * from './enums/Country';

package/bin/country/index.js

@@ -1,4 +1,5 @@
 "use strict";
+//dto
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,4 +15,6 @@ 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);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+//enums
 __exportStar(require("./enums/CountryId"), exports);
+__exportStar(require("./enums/Country"), exports);

package/bin/directory/enums/TypeOfDirectoryId.d.ts

@@ -0,0 +1,5 @@
+export declare enum TypeOfDirectoryId {
+    USER = "USER",
+    BACKOFFICE = "BACKOFFICE",
+    AGENT = "AGENT"
+}

package/bin/directory/enums/TypeOfDirectoryId.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeOfDirectoryId = void 0;
+var TypeOfDirectoryId;
+(function (TypeOfDirectoryId) {
+    TypeOfDirectoryId["USER"] = "USER";
+    TypeOfDirectoryId["BACKOFFICE"] = "BACKOFFICE";
+    TypeOfDirectoryId["AGENT"] = "AGENT";
+})(TypeOfDirectoryId || (exports.TypeOfDirectoryId = TypeOfDirectoryId = {}));

package/bin/directory/index.d.ts

@@ -0,0 +1 @@
+export * from './enums/TypeOfDirectoryId';

package/bin/directory/index.js

@@ -0,0 +1,19 @@
+"use strict";
+//dtos
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//enums
+__exportStar(require("./enums/TypeOfDirectoryId"), exports);

package/bin/helpers/constans/regex.d.ts

@@ -1,2 +1,3 @@
 export declare const regexUuidV4: RegExp;
 export declare const regexIso8601: RegExp;
+export declare const regexPhoneNumber: RegExp;

package/bin/helpers/constans/regex.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.regexIso8601 = exports.regexUuidV4 = void 0;
+exports.regexPhoneNumber = exports.regexIso8601 = exports.regexUuidV4 = void 0;
 // Expresión regular para validar UUID v4
 exports.regexUuidV4 = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
 // Expresión regular para validar fecha ISO 8601
 exports.regexIso8601 = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$/;
+// Expresión regular para validar un número de teléfono
+exports.regexPhoneNumber = /^\+\d{12}$/;

package/bin/index.d.ts

@@ -1,15 +1,5 @@
-export * from './card/dtos/CardActivateRequestDto';
-export * from './card/dtos/CardApplicationRequestDto';
-export * from './card/dtos/CreateCardRequestDto';
-export * from './card/dtos/CardUpdateRequestDto';
-export * from './card/enums/CardType';
-export * from './card/enums/CardUpdateKey';
-export * from './card/enums/IssuanceType';
-export * from './card/enums/Status';
-export * from './card/enums/IssuanceType';
-export * from './card/enums/OwnershipType';
-export * from './card/enums/Brand';
-export * from './card/enums/UpdateKey';
-export * from './card/enums/Status';
-export * from './card/enums/CardType';
-export * from './card/enums/OwnershipType';
+export * as Account from './account';
+export * as Address from './address';
+export * as Card from './card';
+export * as Country from './country';
+export * as Directory from './directory';

package/bin/index.js

@@ -10,22 +10,22 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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);
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./card/dtos/CardActivateRequestDto"), exports);
-__exportStar(require("./card/dtos/CardApplicationRequestDto"), exports);
-__exportStar(require("./card/dtos/CreateCardRequestDto"), exports);
-__exportStar(require("./card/dtos/CardUpdateRequestDto"), exports);
-__exportStar(require("./card/enums/CardType"), exports);
-__exportStar(require("./card/enums/CardUpdateKey"), exports);
-__exportStar(require("./card/enums/IssuanceType"), exports);
-__exportStar(require("./card/enums/Status"), exports);
-__exportStar(require("./card/enums/IssuanceType"), exports);
-__exportStar(require("./card/enums/OwnershipType"), exports);
-__exportStar(require("./card/enums/Brand"), exports);
-__exportStar(require("./card/enums/UpdateKey"), exports);
-__exportStar(require("./card/enums/Status"), exports);
-__exportStar(require("./card/enums/CardType"), exports);
-__exportStar(require("./card/enums/OwnershipType"), exports);
+exports.Directory = exports.Country = exports.Card = exports.Address = exports.Account = void 0;
+exports.Account = __importStar(require("./account"));
+exports.Address = __importStar(require("./address"));
+exports.Card = __importStar(require("./card"));
+exports.Country = __importStar(require("./country"));
+exports.Directory = __importStar(require("./directory"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/type-kit",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/src/account/dtos/AccountResponse.ts

@@ -0,0 +1,60 @@
+
+
+import { IsEnum, IsNumber, IsOptional, IsString, IsDateString } from 'class-validator';
+import { Provider } from '../../provider/enums/Provider';
+import { Country } from '../../country/enums/Country';
+import { AccountStatus } from '../enums/AccountStatus';
+import { TypeOfDirectoryId } from '../../directory/enums/TypeOfDirectoryId';
+
+
+export class AccountResponse {
+    @IsString()
+    id: string;
+
+    @IsOptional()
+    @IsString()
+    typeOfAccountId: string;
+
+    @IsOptional()
+    @IsString()
+    externalAccountId: string;
+
+    @IsOptional()
+    @IsString()
+    externalSubAccountId: string | null;
+
+    @IsEnum(Provider)
+    provider: Provider;
+
+    @IsString()
+    directoryId: string;
+
+    @IsEnum(TypeOfDirectoryId)
+    typeOfDirectoryId: TypeOfDirectoryId;
+
+    @IsNumber()
+    currentBalance: number;
+
+    @IsNumber()
+    balanceLock: number;
+
+    @IsEnum(Country)
+    countryId: Country;
+
+    @IsDateString()
+    createDate: string;
+
+    @IsDateString()
+    lastUpdateDate: string;
+
+    @IsOptional()
+    @IsString()
+    accountNumber: string
+
+    @IsOptional()
+    @IsString()
+    routingNumber: string;
+
+    @IsEnum(AccountStatus)
+    status: AccountStatus;
+}

package/src/account/dtos/CreateAccountRequest.ts

@@ -0,0 +1,45 @@
+import { IsEmail, IsEnum, IsString, ValidateNested, IsDateString, Matches, Length } from 'class-validator';
+import { AddressResponse } from "../../address/dtos/AddressResponse";
+import { Country } from "../../country/enums/Country";
+import { regexUuidV4 } from '../../helpers/constans/regex';
+import { TypeOfDirectoryId } from '../../directory/enums/TypeOfDirectoryId';
+import { IsPhoneNumberFiado } from '../../card/validations/IsPhoneNumberConstraint';
+
+export class CreateAccountRequest {
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'directoryId must be a valid UUID v4',
+        })
+    directoryId: string;
+
+    @IsEnum(TypeOfDirectoryId)
+    typeOfDirectoryId: string;
+
+    @IsString()
+    firstName: string;
+
+    @IsString()
+
+    lastName: string;
+
+    @IsPhoneNumberFiado()
+    phoneNumber: string;
+
+    @ValidateNested()
+    address: AddressResponse;
+
+    @IsEmail()
+    email: string;
+
+    @IsDateString()
+    dob: string;
+
+    @IsString()
+    @Length(1, 30)
+    documentNumber: string;
+
+    @IsEnum(Country)
+    countryId: Country;
+}

package/src/account/dtos/CreatePockeRequest.ts

@@ -0,0 +1,19 @@
+import { IsString, Matches } from "class-validator";
+import { regexUuidV4 } from "../../helpers/constans/regex";
+
+export class CreatePocketRequest {
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'beneficiaryDirectoryId must be a valid UUID v4',
+        })
+    beneficiaryDirectoryId?: string;
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'accountId must be a valid UUID v4',
+        })
+    accountId: string;
+}

package/src/account/enums/AccountStatus.ts

@@ -0,0 +1,7 @@
+
+
+export enum AccountStatus {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    BLOCKED = "BLOCKED"
+}

package/src/account/index.ts

@@ -0,0 +1,11 @@
+
+//dtos
+export * from './dtos/AccountResponse';
+export * from './dtos/CreateAccountRequest';
+export * from './dtos/CreatePockeRequest';
+
+
+//enums
+export * from './enums/AccountStatus';
+
+

package/src/address/dtos/AddressBase.ts

@@ -0,0 +1,131 @@
+
+
+
+import { IsBoolean, IsEnum, IsNumber, IsOptional, IsString, Length, Matches, ValidateNested } from 'class-validator';
+import { TypeOfDirectoryId } from "../../directory/enums/TypeOfDirectoryId";
+import { AddressProvider } from "../enums/AddressProvider";
+import { AddressStatus } from "../enums/AddressStatus";
+import { Place } from "./Place";
+import { CountryId } from '../../country/enums/CountryId';
+import { regexIso8601, regexUuidV4 } from '../../helpers/constans/regex';
+
+export class AddressBase {
+
+    @IsOptional()
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'id must be a valid UUID v4',
+        })
+    id?: string;
+
+    @IsNumber()
+    @IsOptional()
+    distance?: number;
+
+    @IsEnum(TypeOfDirectoryId)
+    createdBy: TypeOfDirectoryId;
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'directoryId must be a valid UUID v4',
+        })
+    directoryId: string;
+
+    @IsBoolean()
+    isPrincipal: boolean;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 100)
+    tag?: string;
+
+    @IsString()
+    @Length(1, 100)
+    tenantId: string;
+
+    @IsString()
+    typeOfAddressId: string;
+
+    @IsEnum(TypeOfDirectoryId)
+    typeOfDirectoryId: TypeOfDirectoryId;
+
+    @IsEnum(AddressProvider)
+    provider: AddressProvider;
+
+    @ValidateNested()
+    place: Place;
+
+    @IsString()
+    @Matches(regexIso8601,
+        {
+            message: 'validFrom must be a valid ISO 8601 date string',
+        })
+    validFrom: string;
+
+    @IsOptional()
+    @IsString()
+    @Matches(regexIso8601,
+        {
+            message: 'validUntil must be a valid ISO 8601 date string',
+        })
+    validUntil?: string;
+
+    @IsEnum(AddressStatus)
+    addressStatus: AddressStatus;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 200)
+    additionalInformation?: string;
+
+    @IsBoolean()
+    helpNeeded: boolean;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 10)
+    internalNumber?: string;
+
+    @IsEnum(CountryId)
+    countryId: CountryId;
+
+    @IsString()
+    @Length(1, 100)
+    street?: string;
+
+    @IsString()
+    @Length(1, 10)
+    addressNumber?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    municipality?: string;
+
+    @IsOptional()
+    @IsString()
+    subMunicipality?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    neighborhood?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    subRegion?: string;
+
+    @IsString()
+    @Length(5, 10)
+    region?: string;
+
+    @IsString()
+    @Length(5, 10)
+    postalCode?: string;
+
+    @IsEnum(CountryId)
+    country: string;
+}

package/src/address/dtos/AddressResponse.ts

@@ -0,0 +1,41 @@
+
+
+
+import { IsOptional, IsString, Length, Matches } from 'class-validator';
+
+import { regexIso8601, regexUuidV4 } from '../../helpers/constans/regex';
+import { AddressBase } from './AddressBase';
+
+export class AddressResponse extends AddressBase {
+
+    @IsString()
+    @Matches(regexUuidV4,
+        {
+            message: 'id must be a valid UUID v4',
+        })
+    id: string
+
+    @IsOptional()
+    @IsString()
+    @Matches(regexIso8601,
+        {
+            message: 'createDate must be a valid ISO 8601 date string',
+        })
+    createDate: string;
+
+    @IsOptional()
+    @IsString()
+    @Matches(regexIso8601,
+        {
+            message: 'updateDate must be a valid ISO 8601 date string',
+        })
+    updateDate?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 100)
+    updatedBy?: string;
+}
+
+
+

package/src/address/dtos/CreateAddressRequest.ts

@@ -0,0 +1,7 @@
+import { AddressBase } from "./AddressBase";
+
+
+export class CreateAddressRequest extends AddressBase {
+
+
+}

package/src/address/dtos/Geometry.ts

@@ -0,0 +1,5 @@
+
+
+export type Geometry = {
+    point: [number, number];
+}

package/src/address/dtos/Place.ts

@@ -0,0 +1,84 @@
+import { IsArray, IsBoolean, IsEnum, IsOptional, IsString, Length, ValidateNested } from 'class-validator';
+import { Geometry } from "./Geometry";
+import { Timezone } from "./Timezone";
+import { Country } from '../../country/enums/Country';
+
+export class Place {
+    @ValidateNested()
+    geometry: Geometry;
+
+    @IsOptional()
+    @IsString()
+    addressNumber?: string;
+
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    categories?: string[];
+
+    @IsOptional()
+    @IsEnum(Country)
+    country?: string;
+
+    @IsBoolean()
+    interpolated: boolean;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 300)
+    label?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 60)
+    municipality?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    neighborhood?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(5, 10)
+    postalCode?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(5, 10)
+    region?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 100)
+    street?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    subMunicipality?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    subRegion?: string;
+
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    supplementalCategories?: string[];
+
+    @IsOptional()
+    @ValidateNested()
+    timezone?: Timezone;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 10)
+    unitNumber?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 10)
+    unitType?: string;
+}

package/src/address/dtos/{AddressShippingDto.ts → Shipping.ts}

@@ -1,7 +1,7 @@
 import { IsString, Length, IsOptional } from 'class-validator';
 import { CountryId } from '../../country/enums/CountryId';
 
-export class ShippingAddressDto {
+export class Shipping {
   @IsString()
   @Length(2, 60)
   municipality: string;

package/src/address/dtos/Timezone.ts

@@ -0,0 +1,6 @@
+
+
+export type Timezone = {
+    name: string;
+    offset: string;
+}

package/src/address/enums/AddressProvider.ts

@@ -0,0 +1,10 @@
+
+/**
+ * AddressProvider enum
+ * @description AddressProvider enum is used to define the address provider
+ * @enum {string} AddressProvider
+ */
+export enum AddressProvider {
+    AWS = "AWS",
+    MANUAL = "MANUAL"
+}

package/src/address/enums/AddressStatus.ts

@@ -0,0 +1,10 @@
+
+/**
+ * AddressProvider Status
+ * @description AddressProvider Status is used to define the address provider status
+ * @enum {string} AddressStatus
+ */
+export enum AddressStatus {
+    VISIBLE = "VISIBLE",
+    NOT_VISIBLE = "NOT_VISIBLE"
+}