uaxi-shared-entities 1.0.0

package/src/entities/vehicle.entity.ts

@@ -0,0 +1,154 @@
+// =============================================
+// VEHICLE MODEL
+// =============================================
+
+import {
+  BelongsTo,
+  Column,
+  CreatedAt,
+  DataType,
+  DeletedAt,
+  ForeignKey,
+  HasMany,
+  Model,
+  Table,
+  UpdatedAt,
+} from 'sequelize-typescript';
+import { DriverProfile } from './driver.entity';
+import { Trip } from './trips.entity';
+import { Brand } from './brand.entity';
+import { VehicleModel } from './vehicle-model.entity';
+import { VehicleStatus } from '../enums';
+export interface ICreateVehicleDto {
+  driverId: string;
+  brandId: string;
+  modelId: string;
+  year: number;
+  licensePlate: string;
+  color: string;
+  vehicleType: string;
+  seatingCapacity: number;
+  status?: VehicleStatus;
+  registrationDocument?: string;
+  insuranceDocument?: string;
+  insuranceExpiryDate?: Date;
+  isDocumentVerified?: boolean;
+}
+@Table({
+  tableName: 'vehicles',
+  timestamps: true,
+  paranoid: true, // Soft deletes
+})
+export class Vehicle extends Model<Vehicle, ICreateVehicleDto> {
+  @Column({
+    type: DataType.UUID,
+    defaultValue: DataType.UUIDV4,
+    primaryKey: true,
+  })
+  declare id: string;
+
+  @ForeignKey(() => DriverProfile)
+  @Column({
+    type: DataType.UUID,
+    allowNull: false,
+  })
+  driverId: string;
+
+  // NUEVO: Referencias a Brand y Model
+  @ForeignKey(() => Brand)
+  @Column({
+    type: DataType.UUID,
+    allowNull: false,
+  })
+  brandId: string;
+
+  @ForeignKey(() => VehicleModel)
+  @Column({
+    type: DataType.UUID,
+    allowNull: false,
+  })
+  modelId: string;
+
+  @Column({
+    type: DataType.INTEGER,
+    allowNull: false,
+  })
+  year: number;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false,
+    unique: true,
+  })
+  licensePlate: string;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false,
+  })
+  color: string;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false,
+  })
+  vehicleType: string; // sedan, suv, compact, etc.
+
+  @Column({
+    type: DataType.INTEGER,
+    allowNull: false,
+  })
+  seatingCapacity: number;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(VehicleStatus)),
+    defaultValue: VehicleStatus.ACTIVE,
+  })
+  status: VehicleStatus;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: true,
+  })
+  registrationDocument: string;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: true,
+  })
+  insuranceDocument: string;
+
+  @Column({
+    type: DataType.DATE,
+    allowNull: true,
+  })
+  insuranceExpiryDate: Date;
+
+  @Column({
+    type: DataType.BOOLEAN,
+    defaultValue: false,
+  })
+  isDocumentVerified: boolean;
+
+  @CreatedAt
+  declare createdAt: Date;
+
+  @UpdatedAt
+  declare updatedAt: Date;
+
+  @DeletedAt
+  declare deletedAt: Date;
+
+  // Associations
+  @BelongsTo(() => DriverProfile)
+  driver: DriverProfile;
+
+  @BelongsTo(() => Brand)
+  brand: Brand;
+
+  @BelongsTo(() => VehicleModel)
+  model: VehicleModel;
+
+  @HasMany(() => Trip, 'vehicleId')
+  trips: Trip[];
+}

package/src/entities/wallet.entity.ts

@@ -0,0 +1,104 @@
+import {
+  BelongsTo,
+  Column,
+  DataType,
+  ForeignKey,
+  HasMany,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { User } from './user.entity';
+import { WalletTransaction } from './walletTransaction.entity';
+import { WalletStatus } from '../enums';
+
+export interface CreateWalletData {
+  userId: string;
+  balance?: number;
+  frozenBalance?: number;
+  walletNumber?: string;
+  status?: WalletStatus;
+  currency?: string;
+  dailyLimit?: number;
+  dailySpent?: number;
+  lastTransactionAt?: Date;
+}
+
+@Table({
+  tableName: 'wallets',
+  timestamps: true,
+})
+export class Wallet extends Model<Wallet, CreateWalletData> {
+  @Column({
+    type: DataType.UUID,
+    defaultValue: DataType.UUIDV4,
+    primaryKey: true,
+  })
+  declare id: string;
+
+  @ForeignKey(() => User)
+  @Column({
+    type: DataType.UUID,
+    allowNull: false,
+    unique: true,
+  })
+  userId: string;
+
+  @Column({
+    type: DataType.DECIMAL(12, 2),
+    defaultValue: 0.0,
+    allowNull: false,
+  })
+  balance: number;
+
+  @Column({
+    type: DataType.DECIMAL(12, 2),
+    defaultValue: 0.0,
+    allowNull: false,
+  })
+  frozenBalance: number; // Balance congelado por transacciones pendientes
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false,
+    unique: true,
+  })
+  walletNumber: string; // Número único de wallet para identificación
+
+  @Column({
+    type: DataType.ENUM(...Object.values(WalletStatus)),
+    defaultValue: WalletStatus.ACTIVE,
+  })
+  status: WalletStatus;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false,
+    defaultValue: 'MXN', // Moneda por defecto
+  })
+  currency: string;
+
+  @Column({
+    type: DataType.DECIMAL(10, 2),
+    defaultValue: 0.0,
+  })
+  dailyLimit: number;
+
+  @Column({
+    type: DataType.DECIMAL(10, 2),
+    defaultValue: 0.0,
+  })
+  dailySpent: number;
+
+  @Column({
+    type: DataType.DATE,
+    allowNull: true,
+  })
+  lastTransactionAt: Date;
+
+  // Associations
+  @BelongsTo(() => User)
+  user: User;
+
+  @HasMany(() => WalletTransaction, 'walletId')
+  transactions: WalletTransaction[];
+}

package/src/entities/walletTransaction.entity.ts

@@ -0,0 +1,103 @@
+// =============================================
+// WALLET TRANSACTION MODEL - Solo movimientos internos de wallet
+// =============================================
+
+import {
+  BelongsTo,
+  Column,
+  DataType,
+  ForeignKey,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { Wallet } from './wallet.entity';
+import { Trip } from './trips.entity';
+import {
+  TransactionCategory,
+  TransactionStatus,
+  TransactionType,
+} from '../enums';
+
+export interface CreateWalletTransactionData {
+  walletId: string;
+  tripId?: string;
+  type: TransactionType;
+  category: TransactionCategory;
+  amount: number;
+  description: string;
+  referenceId?: string; // Solo para recargas externas
+  metadata?: any;
+}
+
+@Table({
+  tableName: 'wallet_transactions',
+  timestamps: true,
+})
+export class WalletTransaction extends Model<
+  WalletTransaction,
+  CreateWalletTransactionData
+> {
+  @Column({
+    type: DataType.UUID,
+    defaultValue: DataType.UUIDV4,
+    primaryKey: true,
+  })
+  declare id: string;
+
+  @ForeignKey(() => Wallet)
+  @Column({
+    type: DataType.UUID,
+    allowNull: false,
+  })
+  walletId: string;
+
+  @ForeignKey(() => Trip)
+  @Column({
+    type: DataType.UUID,
+    allowNull: true,
+  })
+  tripId: string; // Solo para pagos de viajes
+
+  @Column({
+    type: DataType.ENUM(...Object.values(TransactionType)),
+    allowNull: false,
+  })
+  type: TransactionType; // DEBIT, CREDIT
+
+  @Column({
+    type: DataType.ENUM(...Object.values(TransactionCategory)),
+    allowNull: false,
+  })
+  category: TransactionCategory; // TRIP_PAYMENT, REFUND, TOP_UP
+
+  @Column({
+    type: DataType.DECIMAL(12, 2),
+    allowNull: false,
+  })
+  amount: number;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false,
+  })
+  description: string;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: true,
+  })
+  referenceId: string; // Solo para recargas externas (PayPal, Stripe, etc.)
+
+  @Column({
+    type: DataType.JSON,
+    allowNull: true,
+  })
+  metadata: any;
+
+  // Associations
+  @BelongsTo(() => Wallet)
+  wallet: Wallet;
+
+  @BelongsTo(() => Trip)
+  trip: Trip;
+}

package/src/enums/address.enum.ts

@@ -0,0 +1,6 @@
+export enum AddressType {
+  HOME = "home",
+  WORK = "work",
+  FAVORITE = "favorite",
+  OTHER = "other",
+}

package/src/enums/coupon.enum.ts

@@ -0,0 +1,39 @@
+// =============================================
+// COUPON ENUMS
+// =============================================
+
+export enum CouponType {
+  PERCENTAGE = "percentage",
+  FIXED_AMOUNT = "fixed_amount",
+  FREE_RIDE = "free_ride",
+  FIRST_RIDE = "first_ride",
+}
+
+export enum CouponStatus {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
+  EXPIRED = "expired",
+  EXHAUSTED = "exhausted",
+}
+
+export enum CouponApplicability {
+  ALL_USERS = "all_users",
+  NEW_USERS = "new_users",
+  SPECIFIC_USERS = "specific_users",
+  USER_SEGMENT = "user_segment",
+}
+
+export enum UsageStatus {
+  APPLIED = "applied",
+  REDEEMED = "redeemed",
+  REVERSED = "reversed",
+  EXPIRED_UNUSED = "expired_unused",
+}
+
+export enum CampaignStatus {
+  DRAFT = "draft",
+  ACTIVE = "active",
+  PAUSED = "paused",
+  COMPLETED = "completed",
+  CANCELLED = "cancelled",
+}

package/src/enums/driver.enum.ts

@@ -0,0 +1,10 @@
+// =============================================
+// DRIVER ENUMS
+// =============================================
+
+export enum DriverStatus {
+  OFFLINE = "offline",
+  ONLINE = "online",
+  BUSY = "busy",
+  BREAK = "break",
+}

package/src/enums/geofence.enum.ts

@@ -0,0 +1,12 @@
+// =============================================
+// GEOFENCE ENUMS
+// =============================================
+
+export enum GeofenceType {
+  CITY = "city",
+  NEIGHBORHOOD = "neighborhood",
+  AIRPORT = "airport",
+  COMMERCIAL_ZONE = "commercial_zone",
+  RESTRICTED_AREA = "restricted_area",
+  SURGE_ZONE = "surge_zone",
+}

package/src/enums/index.ts

@@ -0,0 +1,14 @@
+// =============================================
+// EXPORTACIONES DE ENUMS
+// =============================================
+
+export * from "./user.enum";
+export * from "./driver.enum";
+export * from "./vehicle.enum";
+export * from "./trip.enum";
+export * from "./payment.enum";
+export * from "./wallet.enum";
+export * from "./notification.enum";
+export * from "./coupon.enum";
+export * from "./geofence.enum";
+export * from "./address.enum";

package/src/enums/notification.enum.ts

@@ -0,0 +1,15 @@
+// =============================================
+// NOTIFICATION ENUMS
+// =============================================
+
+export enum NotificationType {
+  TRIP_REQUEST = "trip_request",
+  TRIP_ACCEPTED = "trip_accepted",
+  DRIVER_ARRIVED = "driver_arrived",
+  TRIP_STARTED = "trip_started",
+  TRIP_COMPLETED = "trip_completed",
+  TRIP_CANCELLED = "trip_cancelled",
+  PAYMENT_SUCCESSFUL = "payment_successful",
+  PAYMENT_FAILED = "payment_failed",
+  GENERAL = "general",
+}

package/src/enums/payment.enum.ts

@@ -0,0 +1,18 @@
+// =============================================
+// PAYMENT ENUMS
+// =============================================
+
+export enum PaymentStatus {
+  PENDING = "pending",
+  COMPLETED = "completed",
+  FAILED = "failed",
+  REFUNDED = "refunded",
+}
+
+export enum PaymentMethod {
+  CREDIT_CARD = "credit_card",
+  DEBIT_CARD = "debit_card",
+  CASH = "cash",
+  WALLET = "wallet",
+  BANK_TRANSFER = "bank_transfer",
+}

package/src/enums/trip.enum.ts

@@ -0,0 +1,12 @@
+// =============================================
+// TRIP ENUMS
+// =============================================
+
+export enum TripStatus {
+  REQUESTED = "requested",
+  ACCEPTED = "accepted",
+  DRIVER_ARRIVED = "driver_arrived",
+  IN_PROGRESS = "in_progress",
+  COMPLETED = "completed",
+  CANCELLED = "cancelled",
+}

package/src/enums/user.enum.ts

@@ -0,0 +1,10 @@
+// =============================================
+// USER ENUMS
+// =============================================
+
+export enum UserStatus {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
+  SUSPENDED = "suspended",
+  PENDING_VERIFICATION = "pending_verification",
+}

package/src/enums/vehicle.enum.ts

@@ -0,0 +1,9 @@
+// =============================================
+// VEHICLE ENUMS
+// =============================================
+
+export enum VehicleStatus {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
+  MAINTENANCE = "maintenance",
+}

package/src/enums/wallet.enum.ts

@@ -0,0 +1,29 @@
+// =============================================
+// WALLET ENUMS
+// =============================================
+
+export enum WalletStatus {
+  ACTIVE = 'active',
+  SUSPENDED = 'suspended',
+  BLOCKED = 'blocked',
+}
+
+export enum TransactionType {
+  DEBIT = 'DEBIT', // Sale dinero de la wallet
+  CREDIT = 'CREDIT', // Entra dinero a la wallet
+}
+
+export enum TransactionCategory {
+  TRIP_PAYMENT = 'TRIP_PAYMENT', // Pago de viaje
+  REFUND = 'REFUND', // Devolución de dinero
+  TOP_UP = 'TOP_UP', // Recarga de wallet
+  CANCELLATION = 'CANCELLATION', // Cancelación de viaje
+  ADJUSTMENT = 'ADJUSTMENT', // Ajuste manual
+}
+
+export enum TransactionStatus {
+  PENDING = 'PENDING',
+  COMPLETED = 'COMPLETED',
+  FAILED = 'FAILED',
+  CANCELLED = 'CANCELLED',
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+// =============================================
+// EXPORTACIONES PRINCIPALES
+// =============================================
+
+// Exportar todas las entidades (incluyen sus enums)
+export * from "./entities";
+
+// Exportar enums adicionales que no están en entidades
+export * from "./enums";
+
+// Exportar configuraciones
+export * from "./config";
+
+// Exportar tipos y interfaces
+export * from "./types";

package/src/types/common.types.ts

@@ -0,0 +1,43 @@
+// =============================================
+// TIPOS COMUNES COMPARTIDOS
+// =============================================
+
+export interface GeoPoint {
+  longitude: number;
+  latitude: number;
+}
+
+export interface GeoPolygon {
+  coordinates: number[][][];
+}
+
+export interface GeoLineString {
+  coordinates: number[][];
+}
+
+export interface PaginationParams {
+  page?: number;
+  limit?: number;
+  offset?: number;
+}
+
+export interface PaginatedResponse<T> {
+  data: T[];
+  total: number;
+  currentPage: number;
+  limit: number;
+  totalPages: number;
+}
+
+export interface ApiResponse<T = any> {
+  success: boolean;
+  data?: T;
+  message?: string;
+  error?: string;
+}
+
+export interface BaseEntity {
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
+}

package/src/types/index.ts

@@ -0,0 +1,5 @@
+// =============================================
+// EXPORTACIONES DE TIPOS E INTERFACES
+// =============================================
+
+export * from "./common.types";

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "strictPropertyInitialization": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.spec.ts"]
+}