Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
295 changes: 107 additions & 188 deletions backend/package-lock.json

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions backend/src/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { TypeOrmModule } from '@nestjs/typeorm';
import { WebSocketModule } from './websocket/websocket.module';
import { NotificationModule } from './notifications/notifications.module';
import { FreightJobsModule } from './freight-jobs/freight-jobs.module';
import { CarrierModule } from './carriers/carrier.module';


@Module({
Expand All @@ -30,6 +31,7 @@ import { FreightJobsModule } from './freight-jobs/freight-jobs.module';
WebSocketModule,
NotificationModule,
FreightJobsModule,
CarrierModule,
],
controllers: [AppController],
providers: [AppService],
Expand Down
134 changes: 134 additions & 0 deletions backend/src/carriers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Carrier Management Module

## Overview
The Carrier Management Module handles carrier profiles, vehicle fleets, driver information, and carrier performance metrics.

## Features
- Carrier profile management (CRUD operations)
- Fleet management (vehicle CRUD operations)
- Driver assignment tracking
- Rating and performance calculation
- Service area management
- Verification workflow

## Entities

### Carrier
- `id` (UUID) - Unique identifier
- `userId` (UUID) - Associated user ID
- `companyName` (string) - Carrier company name
- `licenseNumber` (string) - Unique license number
- `insurancePolicy` (string) - Insurance policy information
- `serviceAreas` (JSONB array) - Geographic service areas
- `averageRating` (decimal) - Average rating score
- `totalDeliveries` (integer) - Total completed deliveries
- `onTimePercentage` (decimal) - Percentage of on-time deliveries
- `isVerified` (boolean) - Verification status
- `isActive` (boolean) - Active status

### Vehicle
- `id` (UUID) - Unique identifier
- `carrierId` (UUID) - Associated carrier ID
- `vehicleType` (enum) - Type of vehicle (truck, van, cargo_ship, car, motorcycle, trailer)
- `licensePlate` (string) - License plate number
- `capacityWeight` (decimal) - Maximum weight capacity
- `capacityVolume` (decimal) - Maximum volume capacity
- `year` (integer) - Manufacturing year
- `make` (string) - Vehicle make
- `model` (string) - Vehicle model
- `isActive` (boolean) - Active status

### Carrier Rating
- `id` (UUID) - Unique identifier
- `carrierId` (UUID) - Associated carrier ID
- `ratedBy` (UUID) - ID of the rater
- `freightJobId` (UUID) - Associated freight job (optional)
- `rating` (integer) - Rating score (1-5)
- `review` (text) - Review text (optional)

## API Endpoints

### Carriers
- `POST /api/v1/carriers` - Create a new carrier
- `GET /api/v1/carriers` - Get all carriers (with optional filters)
- `GET /api/v1/carriers/:id` - Get a specific carrier
- `PATCH /api/v1/carriers/:id` - Update a carrier
- `DELETE /api/v1/carriers/:id` - Delete a carrier

### Vehicles
- `POST /api/v1/carriers/:id/vehicles` - Add a vehicle to a carrier
- `GET /api/v1/carriers/:id/vehicles` - Get all vehicles for a carrier
- `PATCH /api/v1/carriers/vehicles/:vehicleId` - Update a vehicle
- `DELETE /api/v1/carriers/vehicles/:vehicleId` - Delete a vehicle

### Performance & Ratings
- `GET /api/v1/carriers/:id/performance` - Get carrier performance metrics
- `POST /api/v1/carriers/:id/rate` - Rate a carrier

## Business Logic

### Average Rating Calculation
- The average rating is automatically recalculated after each new rating
- Formula: Sum of all ratings / Total number of ratings

### On-Time Percentage Updates
- On-time percentage is updated after job completion
- Formula: (Total on-time deliveries / Total deliveries) * 100

### Verification Requirements
- Only verified carriers can accept freight jobs
- Carriers must have at least one active vehicle

### Search and Filtering
- Filter by service area
- Filter by minimum rating
- Filter by verification status
- Search by company name or license number

## Authorization
- Carriers can only edit their own profiles
- Admins have full access to all carrier data

## Usage Examples

### Create a Carrier
```bash
curl -X POST http://localhost:3000/carriers \
-H "Content-Type: application/json" \
-d '{
"userId": "user-id-123",
"companyName": "ABC Logistics",
"licenseNumber": "LIC123456",
"insurancePolicy": "POL123",
"serviceAreas": ["New York", "New Jersey"]
}'
```

### Add a Vehicle to a Carrier
```bash
curl -X POST http://localhost:3000/carriers/123/vehicles \
-H "Content-Type: application/json" \
-d '{
"vehicleType": "truck",
"licensePlate": "ABC123",
"capacityWeight": 10000,
"capacityVolume": 500
}'
```

### Rate a Carrier
```bash
curl -X POST http://localhost:3000/carriers/123/rate \
-H "Content-Type: application/json" \
-d '{
"ratedBy": "customer-id-456",
"freightJobId": "job-id-789",
"rating": 5,
"review": "Excellent service!"
}'
```

## Error Handling
- `404 Not Found` - Resource does not exist
- `409 Conflict` - Duplicate license number or rating already exists
- `400 Bad Request` - Cannot delete carrier with active vehicles
17 changes: 17 additions & 0 deletions backend/src/carriers/carrier.module.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { Carrier } from './entities/carrier.entity';
import { Vehicle } from './entities/vehicle.entity';
import { CarrierRating } from './entities/carrier-rating.entity';
import { CarrierService } from './services/carrier.service';
import { CarrierController } from './controllers/carrier.controller';

@Module({
imports: [
TypeOrmModule.forFeature([Carrier, Vehicle, CarrierRating]),
],
controllers: [CarrierController],
providers: [CarrierService],
exports: [CarrierService],
})
export class CarrierModule {}
112 changes: 112 additions & 0 deletions backend/src/carriers/carrier.service.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
import { Test, TestingModule } from '@nestjs/testing';
import { getRepositoryToken } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { CarrierService } from './services/carrier.service';
import { Carrier } from './entities/carrier.entity';
import { Vehicle } from './entities/vehicle.entity';
import { CarrierRating } from './entities/carrier-rating.entity';
import { CreateCarrierDto } from './dto/create-carrier.dto';
import { ConflictException, NotFoundException } from '@nestjs/common';

describe('CarrierService', () => {
let service: CarrierService;
let carrierRepository: Repository<Carrier>;
let vehicleRepository: Repository<Vehicle>;
let ratingRepository: Repository<CarrierRating>;

beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
CarrierService,
{
provide: getRepositoryToken(Carrier),
useClass: Repository,
},
{
provide: getRepositoryToken(Vehicle),
useClass: Repository,
},
{
provide: getRepositoryToken(CarrierRating),
useClass: Repository,
},
],
}).compile();

service = module.get<CarrierService>(CarrierService);
carrierRepository = module.get<Repository<Carrier>>(getRepositoryToken(Carrier));
vehicleRepository = module.get<Repository<Vehicle>>(getRepositoryToken(Vehicle));
ratingRepository = module.get<Repository<CarrierRating>>(getRepositoryToken(CarrierRating));
});

it('should be defined', () => {
expect(service).toBeDefined();
});

describe('create', () => {
it('should create a new carrier', async () => {
const createCarrierDto: CreateCarrierDto = {
userId: 'user-id',
companyName: 'Test Carrier',
licenseNumber: 'TEST123',
insurancePolicy: 'policy-123',
serviceAreas: ['area1', 'area2'],
};

jest.spyOn(carrierRepository, 'findOne').mockResolvedValue(null);
jest.spyOn(carrierRepository, 'create').mockReturnValue(new Carrier());
jest.spyOn(carrierRepository, 'save').mockResolvedValue({
id: 'carrier-id',
...createCarrierDto,
serviceAreas: createCarrierDto.serviceAreas,
averageRating: 0,
totalDeliveries: 0,
onTimePercentage: 0,
isVerified: false,
isActive: true,
createdAt: new Date(),
updatedAt: new Date(),
vehicles: [],
ratings: [],
} as Carrier);

const result = await service.create(createCarrierDto);

expect(result).toBeDefined();
expect(result.companyName).toBe('Test Carrier');
});

it('should throw ConflictException if license number already exists', async () => {
const createCarrierDto: CreateCarrierDto = {
userId: 'user-id',
companyName: 'Test Carrier',
licenseNumber: 'TEST123',
insurancePolicy: 'policy-123',
};

jest.spyOn(carrierRepository, 'findOne').mockResolvedValue(new Carrier());

await expect(service.create(createCarrierDto)).rejects.toThrow(ConflictException);
});
});

describe('findOne', () => {
it('should return a carrier if found', async () => {
const carrier = new Carrier();
carrier.id = 'carrier-id';
carrier.companyName = 'Test Carrier';

jest.spyOn(carrierRepository, 'findOne').mockResolvedValue(carrier);

const result = await service.findOne('carrier-id');

expect(result).toEqual(carrier);
});

it('should throw NotFoundException if carrier not found', async () => {
jest.spyOn(carrierRepository, 'findOne').mockResolvedValue(null);

await expect(service.findOne('carrier-id')).rejects.toThrow(NotFoundException);
});
});
});
Loading