train

apps/edr-freight-api/src/modules/trains/dto/assign-train-wagons.dto.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ArrayMinSize, IsArray, IsUUID } from 'class-validator';
+
+export class AssignTrainWagonsDto {
+  @ApiProperty({
+    type: [String],
+    format: 'uuid',
+    description: 'Wagons to append to the consist, in order. Each must be AVAILABLE in the train\'s yard.',
+  })
+  @IsArray()
+  @ArrayMinSize(1)
+  @IsUUID('all', { each: true })
+  wagonIds!: string[];
+}

apps/edr-freight-api/src/modules/trains/dto/build-train.dto.ts

@@ -0,0 +1,51 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  ArrayMinSize,
+  IsArray,
+  IsOptional,
+  IsString,
+  IsUUID,
+  MaxLength,
+} from 'class-validator';
+
+export class BuildTrainDto {
+  @ApiProperty({ example: '81001', description: 'Operator-assigned train code (unique)' })
+  @IsString()
+  @MaxLength(32)
+  code!: string;
+
+  @ApiProperty({ format: 'uuid', description: 'Yard the train is built in' })
+  @IsUUID()
+  currentYardId!: string;
+
+  @ApiProperty({
+    type: [String],
+    format: 'uuid',
+    description: 'Locomotives pulling the train (minimum 2 — front and back), in consist order',
+  })
+  @IsArray()
+  @ArrayMinSize(2, { message: 'A train must be pulled by at least two locomotives' })
+  @IsUUID('all', { each: true })
+  locomotiveIds!: string[];
+
+  @ApiPropertyOptional({
+    type: [String],
+    format: 'uuid',
+    description: 'Wagons to attach at build time, in consist order (must sit in the same yard)',
+  })
+  @IsOptional()
+  @IsArray()
+  @IsUUID('all', { each: true })
+  wagonIds?: string[];
+
+  @ApiPropertyOptional({ maxLength: 100 })
+  @IsOptional()
+  @IsString()
+  @MaxLength(100)
+  trainName?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  notes?: string;
+}

apps/edr-freight-api/src/modules/trains/dto/list-built-trains-query.dto.ts

@@ -0,0 +1,22 @@
+import { Freight } from '@edr/types';
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { IsEnum, IsIn, IsOptional, IsUUID } from 'class-validator';
+
+import { PaginationQueryDto } from '../../../common/dto/pagination-query.dto';
+
+export class ListBuiltTrainsQueryDto extends PaginationQueryDto {
+  @ApiPropertyOptional({ enum: Freight.TrainStatus })
+  @IsOptional()
+  @IsEnum(Freight.TrainStatus)
+  status?: Freight.TrainStatus;
+
+  @ApiPropertyOptional({ format: 'uuid', description: 'Only trains sitting in this yard' })
+  @IsOptional()
+  @IsUUID()
+  currentYardId?: string;
+
+  @ApiPropertyOptional({ enum: ['code', 'trainName', 'status', 'createdAt'] })
+  @IsOptional()
+  @IsIn(['code', 'trainName', 'status', 'createdAt'])
+  sortBy?: 'code' | 'trainName' | 'status' | 'createdAt';
+}

apps/edr-freight-api/src/modules/trains/dto/reorder-train-wagons.dto.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ArrayMinSize, IsArray, IsUUID } from 'class-validator';
+
+export class ReorderTrainWagonsDto {
+  @ApiProperty({
+    type: [String],
+    format: 'uuid',
+    description: 'Every wagon of the train, in the new consist order',
+  })
+  @IsArray()
+  @ArrayMinSize(1)
+  @IsUUID('all', { each: true })
+  wagonIds!: string[];
+}

apps/edr-freight-api/src/modules/trains/dto/update-train-locomotives.dto.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ArrayMinSize, IsArray, IsUUID } from 'class-validator';
+
+export class UpdateTrainLocomotivesDto {
+  @ApiProperty({
+    type: [String],
+    format: 'uuid',
+    description: 'Full replacement locomotive set (minimum 2), in consist order',
+  })
+  @IsArray()
+  @ArrayMinSize(2, { message: 'A train must be pulled by at least two locomotives' })
+  @IsUUID('all', { each: true })
+  locomotiveIds!: string[];
+}