Class ShippingService

Service responsible for handling shipping logic. Calculates shipping costs, creates fake deliveries and sends fake track & trace emails.

File

apps/api/src/services/ShippingService.ts

Hierarchy (View Summary)

IShippingService
- ShippingService

Index

Constructors

Properties

_databaseService FREE_SHIPPING_THRESHOLD SHIPPING_COST

Methods

_generateTrackAndTrace _getEstimatedDeliveryDate calculateShippingCost createDelivery getDeliveriesForUser sendTrackAndTraceEmail

Constructors

constructor

new ShippingService(): ShippingService
Returns ShippingService
Inherited from IShippingService.constructor

Properties

`Private` `Readonly`_databaseService

_databaseService: DatabaseService = ...

`Private` `Static` `Readonly`FREE_SHIPPING_THRESHOLD

FREE_SHIPPING_THRESHOLD: number = 50

`Private` `Static` `Readonly`SHIPPING_COST

SHIPPING_COST: number = 4.99

Methods

`Private`_generateTrackAndTrace

_generateTrackAndTrace(): string
Generates a fake track & trace code. starting with "TT".

Returns string
A random track & trace string.
- Defined in apps/api/src/services/ShippingService.ts:143

`Private`_getEstimatedDeliveryDate

_getEstimatedDeliveryDate(): string
Calculates an estimated delivery date 3 business days from now.

Returns string
A date string in Dutch format.
- Defined in apps/api/src/services/ShippingService.ts:158

calculateShippingCost

calculateShippingCost(orderTotal: number): IShippingCostResult
Calculates the shipping cost based on the order total. Orders above €50 get free shipping.
Parameters
- orderTotal: number
  The total price of the order.
Returns IShippingCostResult
The shipping cost and total including shipping.
Overrides IShippingService.calculateShippingCost
- Defined in apps/api/src/services/ShippingService.ts:39

createDelivery

createDelivery(userId: number, orderTotal: number): Promise<IDeliveryResult>
Creates a fake delivery for a user and returns a track & trace code. Also sends a track & trace email to the customer.
Parameters
- userId: number
  The ID of the user placing the order.
- orderTotal: number
  The total price of the order.
Returns Promise<IDeliveryResult>
A DeliveryResult with track & trace and cost details.
Overrides IShippingService.createDelivery
- Defined in apps/api/src/services/ShippingService.ts:57

getDeliveriesForUser

getDeliveriesForUser(userId: number): Promise<IUserDelivery[]>
Retrieves all deliveries for a given user, ordered by creation date descending.
Parameters
- userId: number
  The ID of the user.
Returns Promise<IUserDelivery[]>
An array of UserDelivery objects.
Overrides IShippingService.getDeliveriesForUser
- Defined in apps/api/src/services/ShippingService.ts:108

sendTrackAndTraceEmail

sendTrackAndTraceEmail(
    email: string,
    trackAndTrace: string,
    estimatedDelivery: string,
): void
Sends a fake track & trace email to the customer (logs to console).
Parameters
- email: string
  The customer's email address.
- trackAndTrace: string
  The track & trace code.
- estimatedDelivery: string
  The estimated delivery date.
Returns void
Overrides IShippingService.sendTrackAndTraceEmail
- Defined in apps/api/src/services/ShippingService.ts:132