feat(import-operations): record empty container return per booking

Container Returns only ever offered the last-mile path: a booking reached
the list once it had a truck assigned and warehouse inventory flagged as
returning. Bookings that ship WITH equipment return had no way in, so the
empties they owe were invisible until that path happened to fire.

Adds GET /import-operations/empty-return-bookings — the containers a
booking flagged is_return, carrying whichever of them already has an
empty return recorded, grouped one row per booking and dropped from the
list once nothing is pending. Covers both spellings of the booking's
equipment_return (WITH_RETURN and the older RETURN) and skips bookings
that never ship.

Backoffice grows a "Bookings With Empty Container Return" card above the
existing sections: pick the booking, tick the containers coming back,
say where they landed, and each tick becomes an empty container return
on that booking — which is what the Returned Containers table then
advances. The existing last-mile, standalone and bulk flows are
untouched.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
hager
2026-09-02 10:17:19 +00:00
parent 2e33e9aeb3
commit 2e51342d1e
8 changed files with 778 additions and 1 deletions

View File

@@ -0,0 +1,98 @@
import {
assembleEmptyReturnBookings,
type EmptyReturnBookingUnitRow,
} from './empty-return-bookings.util';
const booking = {
bookingId: 'b1',
bookingReference: 'BK-2026-000263',
bookingStatus: 'IN_TRANSIT',
equipmentReturn: 'WITH_RETURN',
customerId: 'c1',
companyName: 'Afri Software Solutions',
};
const unit = (
overrides: Partial<EmptyReturnBookingUnitRow> & { unitId: string; containerNumber: string },
): EmptyReturnBookingUnitRow => ({
...booking,
containerSize: '40ft',
containerType: '40FT',
returnId: null,
returnStatus: null,
...overrides,
});
describe('assembleEmptyReturnBookings', () => {
it('groups a bookings flagged containers onto one row, all pending', () => {
const rows = assembleEmptyReturnBookings([
unit({ unitId: 'u1', containerNumber: 'MSFH8596324' }),
unit({ unitId: 'u2', containerNumber: 'SDJU8596324' }),
]);
expect(rows).toHaveLength(1);
expect(rows[0].bookingReference).toBe('BK-2026-000263');
expect(rows[0].companyName).toBe('Afri Software Solutions');
expect(rows[0].containers.map((c) => c.containerNumber)).toEqual([
'MSFH8596324',
'SDJU8596324',
]);
expect(rows[0]).toMatchObject({ expectedCount: 2, recordedCount: 0, pendingCount: 2 });
});
it('keeps an already-recorded container visible but out of the pending count', () => {
const rows = assembleEmptyReturnBookings([
unit({
unitId: 'u1',
containerNumber: 'MSFH8596324',
returnId: 'r1',
returnStatus: 'ASSIGNED_STORAGE',
}),
unit({ unitId: 'u2', containerNumber: 'SDJU8596324' }),
]);
expect(rows[0]).toMatchObject({ expectedCount: 2, recordedCount: 1, pendingCount: 1 });
expect(rows[0].containers[0].returnStatus).toBe('ASSIGNED_STORAGE');
});
it('drops a booking once every container is recorded', () => {
const rows = assembleEmptyReturnBookings([
unit({
unitId: 'u1',
containerNumber: 'MSFH8596324',
returnId: 'r1',
returnStatus: 'RETURNED',
}),
unit({
unitId: 'u2',
containerNumber: 'SDJU8596324',
returnId: 'r2',
returnStatus: 'COMPLETED',
}),
]);
expect(rows).toEqual([]);
});
it('keeps each booking on its own row, in query order', () => {
const other = {
...booking,
bookingId: 'b2',
bookingReference: 'BK-2026-000286',
companyName: 'DE BE KE',
};
const rows = assembleEmptyReturnBookings([
unit({ unitId: 'u1', containerNumber: 'MSFH8596324' }),
{ ...unit({ unitId: 'u2', containerNumber: 'ASDS1234567' }), ...other },
unit({ unitId: 'u3', containerNumber: 'SDJU8596324' }),
]);
expect(rows.map((r) => r.bookingReference)).toEqual(['BK-2026-000263', 'BK-2026-000286']);
expect(rows[0].containers).toHaveLength(2);
expect(rows[1].containers).toHaveLength(1);
});
it('returns nothing when no booking owes an empty', () => {
expect(assembleEmptyReturnBookings([])).toEqual([]);
});
});

View File

@@ -0,0 +1,107 @@
import type { EmptyContainerReturnStatus } from './entities/empty-container-return.entity';
/**
* `WITH_RETURN` is the current value; `RETURN` is what older bookings were
* written with. Both mean the same thing — the booking owes empties back.
*/
export const WITH_RETURN_EQUIPMENT_VALUES = ['WITH_RETURN', 'RETURN'];
/** Bookings in these statuses never ship, so they never owe an empty back. */
export const EMPTY_RETURN_CLOSED_BOOKING_STATUSES = ['DRAFT', 'CANCELLED', 'REJECTED', 'EXPIRED'];
/**
* One flagged return container of a booking, as the query hands it over: the
* booking columns repeat on every row, and `returnId` is set when this exact
* container already has an empty return recorded against the booking.
*/
export interface EmptyReturnBookingUnitRow {
bookingId: string;
bookingReference: string;
bookingStatus: string;
equipmentReturn: string;
customerId: string | null;
companyName: string | null;
unitId: string;
containerNumber: string;
containerSize: string | null;
containerType: string | null;
returnId: string | null;
returnStatus: EmptyContainerReturnStatus | null;
}
/** One container a booking owes back empty. */
export interface EmptyReturnBookingContainer {
/** Stable row key — the booking container unit id. */
key: string;
unitId: string;
containerNumber: string;
containerSize: string | null;
containerType: string | null;
/** Set once the empty return for this container has been recorded. */
returnId: string | null;
returnStatus: EmptyContainerReturnStatus | null;
}
/** A booking that ships with empty-container return and still owes empties. */
export interface EmptyReturnBookingRow {
bookingId: string;
bookingReference: string;
bookingStatus: string;
equipmentReturn: string;
customerId: string | null;
companyName: string | null;
containers: EmptyReturnBookingContainer[];
expectedCount: number;
recordedCount: number;
pendingCount: number;
}
/**
* Groups a booking's flagged return containers onto one row per booking.
*
* A container whose empty return is already recorded keeps its row — the
* screen shows what has been done — but stops counting as pending, and a
* booking with nothing left pending drops off the list entirely.
*
* Row order follows the query (newest booking first, containers in booking
* order), so the caller decides the ordering, not this function.
*/
export function assembleEmptyReturnBookings(
units: EmptyReturnBookingUnitRow[],
): EmptyReturnBookingRow[] {
const rows = new Map<string, EmptyReturnBookingRow>();
for (const unit of units) {
const row = rows.get(unit.bookingId) ?? {
bookingId: unit.bookingId,
bookingReference: unit.bookingReference,
bookingStatus: unit.bookingStatus,
equipmentReturn: unit.equipmentReturn,
customerId: unit.customerId,
companyName: unit.companyName,
containers: [],
expectedCount: 0,
recordedCount: 0,
pendingCount: 0,
};
row.containers.push({
key: unit.unitId,
unitId: unit.unitId,
containerNumber: unit.containerNumber,
containerSize: unit.containerSize,
containerType: unit.containerType,
returnId: unit.returnId,
returnStatus: unit.returnStatus,
});
rows.set(unit.bookingId, row);
}
return [...rows.values()]
.map((row) => ({
...row,
expectedCount: row.containers.length,
recordedCount: row.containers.filter((container) => container.returnId).length,
pendingCount: row.containers.filter((container) => !container.returnId).length,
}))
.filter((row) => row.pendingCount > 0);
}

View File

@@ -119,6 +119,15 @@ export class ImportOperationsController {
return this.service.listEmptyReturns();
}
@Get('empty-return-bookings')
@BookingStaff(FREIGHT_PERMS.bookings.operations)
@ApiOperation({
summary: 'Bookings shipping with empty-container return that still owe empties, with their containers',
})
listEmptyReturnBookings() {
return this.service.listEmptyReturnBookings();
}
@Post('empty-container-returns')
@BookingStaff(FREIGHT_PERMS.bookings.operations)
@ApiOperation({ summary: 'Batch 16: create an empty container return record' })

View File

@@ -25,6 +25,13 @@ import {
type DjiboutiIncidentType,
} from './entities/djibouti-incident.entity';
import { assertWagonLoad } from './empty-container-wagon.util';
import {
assembleEmptyReturnBookings,
EMPTY_RETURN_CLOSED_BOOKING_STATUSES,
WITH_RETURN_EQUIPMENT_VALUES,
type EmptyReturnBookingRow,
type EmptyReturnBookingUnitRow,
} from './empty-return-bookings.util';
import {
EmptyContainerReturn,
type EmptyContainerReturnListItem,
@@ -207,6 +214,51 @@ export class ImportOperationsService {
return this.emptyReturns.find({ where: { bookingId }, order: { createdAt: 'DESC' } as never });
}
/**
* Bookings that ship WITH empty-container return and still owe empties, each
* with the containers that are to be returned — the ones the booking flagged
* `is_return`, carrying the empty return already recorded against each, if
* any.
*/
async listEmptyReturnBookings(): Promise<EmptyReturnBookingRow[]> {
const units: EmptyReturnBookingUnitRow[] = await this.emptyReturns.manager.query(
`SELECT b.id AS "bookingId",
b.reference AS "bookingReference",
b.status AS "bookingStatus",
b.equipment_return AS "equipmentReturn",
b.company_id AS "customerId",
c.name AS "companyName",
u.id AS "unitId",
u.container_number AS "containerNumber",
COALESCE(bc.container_size, ct.code) AS "containerSize",
ct.label AS "containerType",
r.id AS "returnId",
r.status AS "returnStatus"
FROM freight.booking_container_units u
JOIN freight.booking_container bc ON bc.id = u.booking_container_id AND bc.deleted_at IS NULL
JOIN freight.bookings b ON b.id = bc.booking_id AND b.deleted_at IS NULL
LEFT JOIN freight.companies c ON c.id = b.company_id
LEFT JOIN freight.container_types ct ON ct.id = bc.container_type_id
LEFT JOIN LATERAL (
SELECT er.id, er.status
FROM freight.empty_container_returns er
WHERE er.deleted_at IS NULL
AND er.booking_id = b.id
AND upper(er.container_number) = upper(u.container_number)
ORDER BY er.created_at DESC
LIMIT 1
) r ON TRUE
WHERE u.deleted_at IS NULL
AND u.is_return = true
AND b.equipment_return = ANY($1)
AND b.status <> ALL($2)
ORDER BY b.created_at DESC, u.sort_order ASC`,
[WITH_RETURN_EQUIPMENT_VALUES, EMPTY_RETURN_CLOSED_BOOKING_STATUSES],
);
return assembleEmptyReturnBookings(units);
}
async createEmptyReturn(dto: CreateEmptyContainerReturnDto) {
const returnDate = dto.returnDate ? new Date(dto.returnDate) : new Date();
const saved = await this.emptyReturns.save(