feature: vehicle preferences

[Jun4928]

Goals

• Create endpoints to retrieve and update a user's saved vehicles.
• Simply use in-memory data

API Spec

below APIs need user authentication first,

• GET /users/vehicles, retrieve all the stored items
• GET /users/vehicles/:vehicleId, retrieve the specific stored item
• POST /users/vehicles, create one
• PUT /users/vehicles/:vehicleId, replace entire stored item with the new body
• DELETE /users/vehicles/:vehicleId, delete one

Types

type Vehicle = {
  id: number
  brand: string
  model: string
  year: number
}

Service Interfaces

get-users-vehicles.service

type Input = {
  userId: number
  vehicleId: number | null // when null retrieve all
}

type Output = Promise<Vehicle[]>

create-users-vehicles.service

type Input = {
  userId: number
  vehicle: CreateVehicleData
} 

type Output = Promise<Vehicle>

update-users-vehicles.service

type Input = {
  userId: number
  vehicleId: number
  vehicle: UpdateVehicleData
}

type Output = Promise<Vehicle>

delete-users-vehicles.service

type Input = {
  userId: number
  vehicleId: number
}

type Output = Promise<void>

In-memory database

• in-memory database implements this interface

export type UserVehicle = {
  userId: number;
  vehicle: Vehicle;
};

export type CreateVehicleData = Omit<Vehicle, "id">;

export type UpdateVehicleData = Omit<Vehicle, "id">;

type Result = {
  succeed: boolean;
  reason: string | null;
};

export interface VehicleDatabase {
  getAll(userId: number): Promise<UserVehicle[]>;

  getOne(userId: number, vehicleId: number): Promise<UserVehicle | null>;

  create(userId: number, vehicle: CreateVehicleData): Promise<UserVehicle>;

  updateOne(
    userId: number,
    vehicleId: number,
    vehicle: UpdateVehicleData,
  ): Promise<UserVehicle | Result>;

  deleteOne(userId: number, vehicleId: number): Promise<Result>;

  clear(): Promise<void>;
}

Tests

• get-users-vehicles.service.test
• create-users-vehicles.service.test
• update-users-vehicles.service.test
• delete-users-vehicles.service.test