feat(api): GET/POST /api/v1/yachts

Add yacht list + create routes, export RouteHandler type and inner
handlers so tests can invoke them directly with a mock AuthContext.
New tests/helpers/route-tester.ts provides makeMockCtx/makeMockRequest
reusable by subsequent Task 3.x routes.
This commit is contained in:
Matt Ciaccio
2026-04-24 12:35:25 +02:00
parent f743169354
commit a5036c6358
4 changed files with 192 additions and 16 deletions

View File

@@ -0,0 +1,47 @@
import { NextResponse } from 'next/server';
import { withAuth, withPermission, type RouteHandler } from '@/lib/api/helpers';
import { parseQuery, parseBody } from '@/lib/api/route-helpers';
import { errorResponse } from '@/lib/errors';
import { listYachts, createYacht } from '@/lib/services/yachts.service';
import { listYachtsSchema, createYachtSchema } from '@/lib/validators/yachts';
export const listHandler: RouteHandler = async (req, ctx) => {
try {
const query = parseQuery(req, listYachtsSchema);
const result = await listYachts(ctx.portId, query);
const { page, limit } = query;
const totalPages = Math.ceil(result.total / limit);
return NextResponse.json({
data: result.data,
pagination: {
page,
pageSize: limit,
total: result.total,
totalPages,
hasNextPage: page < totalPages,
hasPreviousPage: page > 1,
},
});
} catch (error) {
return errorResponse(error);
}
};
export const createHandler: RouteHandler = async (req, ctx) => {
try {
const body = await parseBody(req, createYachtSchema);
const yacht = await createYacht(ctx.portId, body, {
userId: ctx.userId,
portId: ctx.portId,
ipAddress: ctx.ipAddress,
userAgent: ctx.userAgent,
});
return NextResponse.json({ data: yacht }, { status: 201 });
} catch (error) {
return errorResponse(error);
}
};
export const GET = withAuth(withPermission('yachts', 'view', listHandler));
export const POST = withAuth(withPermission('yachts', 'create', createHandler));

View File

@@ -3,12 +3,7 @@ import { NextRequest, NextResponse } from 'next/server';
import { auth } from '@/lib/auth'; import { auth } from '@/lib/auth';
import { db } from '@/lib/db'; import { db } from '@/lib/db';
import { import { portRoleOverrides, ports, userPortRoles, userProfiles } from '@/lib/db/schema';
portRoleOverrides,
ports,
userPortRoles,
userProfiles,
} from '@/lib/db/schema';
import { type RolePermissions } from '@/lib/db/schema/users'; import { type RolePermissions } from '@/lib/db/schema/users';
import { createAuditLog } from '@/lib/audit'; import { createAuditLog } from '@/lib/audit';
import { errorResponse } from '@/lib/errors'; import { errorResponse } from '@/lib/errors';
@@ -40,7 +35,7 @@ export interface AuthContext {
userAgent: string; userAgent: string;
} }
type RouteHandler<T = unknown> = ( export type RouteHandler<T = unknown> = (
req: NextRequest, req: NextRequest,
ctx: AuthContext, ctx: AuthContext,
params: Record<string, string>, params: Record<string, string>,
@@ -133,10 +128,7 @@ export function withAuth(
if (!profile.isSuperAdmin && portId) { if (!profile.isSuperAdmin && portId) {
const portRole = await db.query.userPortRoles.findFirst({ const portRole = await db.query.userPortRoles.findFirst({
where: and( where: and(eq(userPortRoles.userId, profile.userId), eq(userPortRoles.portId, portId)),
eq(userPortRoles.userId, profile.userId),
eq(userPortRoles.portId, portId),
),
with: { with: {
role: true, role: true,
port: true, port: true,
@@ -182,8 +174,7 @@ export function withAuth(
email: session.user.email, email: session.user.email,
name: session.user.name, name: session.user.name,
}, },
ipAddress: ipAddress: req.headers.get('x-forwarded-for')?.split(',')[0]?.trim() ?? 'unknown',
req.headers.get('x-forwarded-for')?.split(',')[0]?.trim() ?? 'unknown',
userAgent: req.headers.get('user-agent') ?? 'unknown', userAgent: req.headers.get('user-agent') ?? 'unknown',
}; };
@@ -213,9 +204,7 @@ export function withPermission(
): RouteHandler { ): RouteHandler {
return async (req, ctx, params) => { return async (req, ctx, params) => {
if (!ctx.isSuperAdmin) { if (!ctx.isSuperAdmin) {
const resourcePerms = ctx.permissions?.[resource] as const resourcePerms = ctx.permissions?.[resource] as Record<string, boolean> | undefined;
| Record<string, boolean>
| undefined;
if (!resourcePerms || !resourcePerms[action]) { if (!resourcePerms || !resourcePerms[action]) {
logger.warn({ userId: ctx.userId, resource, action }, 'Permission denied'); logger.warn({ userId: ctx.userId, resource, action }, 'Permission denied');

View File

@@ -0,0 +1,42 @@
/**
* Helper to invoke route inner-handlers directly, bypassing withAuth.
* Route files must export the inner handler (in addition to the withAuth-wrapped HTTP method).
*/
import { NextRequest } from 'next/server';
import type { AuthContext } from '@/lib/api/helpers';
import type { RolePermissions } from '@/lib/db/schema/users';
export interface MockCtxOptions {
portId: string;
isSuperAdmin?: boolean;
permissions?: RolePermissions | null;
userId?: string;
}
export function makeMockCtx(opts: MockCtxOptions): AuthContext {
return {
userId: opts.userId ?? 'test-user',
portId: opts.portId,
portSlug: 'test-port',
isSuperAdmin: opts.isSuperAdmin ?? false,
permissions: opts.permissions ?? null,
user: { email: 'test@example.com', name: 'Test User' },
ipAddress: '127.0.0.1',
userAgent: 'vitest/1.0',
};
}
export function makeMockRequest(
method: string,
url: string,
opts: { body?: unknown; headers?: Record<string, string> } = {},
): NextRequest {
const init: { method: string; headers: Record<string, string>; body?: string } = {
method,
headers: { 'content-type': 'application/json', ...(opts.headers ?? {}) },
};
if (opts.body !== undefined) {
init.body = JSON.stringify(opts.body);
}
return new NextRequest(url, init);
}

View File

@@ -0,0 +1,98 @@
import { describe, it, expect } from 'vitest';
import { listHandler, createHandler, POST } from '@/app/api/v1/yachts/route';
import { withPermission } from '@/lib/api/helpers';
import { makeMockCtx, makeMockRequest } from '../../helpers/route-tester';
import {
makePort,
makeClient,
makeYacht,
makeFullPermissions,
makeViewerPermissions,
} from '../../helpers/factories';
describe('POST /api/v1/yachts (createHandler)', () => {
it('creates a yacht and returns 201', async () => {
const port = await makePort();
const client = await makeClient({ portId: port.id });
const ctx = makeMockCtx({ portId: port.id, permissions: makeFullPermissions() });
const req = makeMockRequest('POST', 'http://localhost/api/v1/yachts', {
body: { name: 'Sea Breeze', owner: { type: 'client', id: client.id } },
});
const res = await createHandler(req, ctx, {});
expect(res.status).toBe(201);
const body = await res.json();
expect(body.data.name).toBe('Sea Breeze');
expect(body.data.currentOwnerId).toBe(client.id);
});
it('returns 400 on invalid body (empty name)', async () => {
const port = await makePort();
const client = await makeClient({ portId: port.id });
const ctx = makeMockCtx({ portId: port.id, permissions: makeFullPermissions() });
const req = makeMockRequest('POST', 'http://localhost/api/v1/yachts', {
body: { name: '', owner: { type: 'client', id: client.id } },
});
const res = await createHandler(req, ctx, {});
expect(res.status).toBe(400);
});
it('returns 400 when owner.id does not exist', async () => {
const port = await makePort();
const ctx = makeMockCtx({ portId: port.id, permissions: makeFullPermissions() });
const req = makeMockRequest('POST', 'http://localhost/api/v1/yachts', {
body: { name: 'Phantom', owner: { type: 'client', id: 'nonexistent' } },
});
const res = await createHandler(req, ctx, {});
expect(res.status).toBe(400);
});
});
describe('GET /api/v1/yachts (listHandler)', () => {
it('returns tenant-scoped yachts with pagination metadata', async () => {
const port = await makePort();
const client = await makeClient({ portId: port.id });
await makeYacht({
portId: port.id,
ownerType: 'client',
ownerId: client.id,
name: 'Listed',
});
const ctx = makeMockCtx({ portId: port.id, permissions: makeFullPermissions() });
const req = makeMockRequest('GET', 'http://localhost/api/v1/yachts?page=1&limit=20&order=desc');
const res = await listHandler(req, ctx, {});
expect(res.status).toBe(200);
const body = await res.json();
expect(body.data.some((y: { name: string }) => y.name === 'Listed')).toBe(true);
expect(body.pagination.page).toBe(1);
expect(body.pagination.pageSize).toBe(20);
expect(typeof body.pagination.total).toBe('number');
});
it('returns 400 for invalid query params (non-numeric page)', async () => {
const port = await makePort();
const ctx = makeMockCtx({ portId: port.id, permissions: makeFullPermissions() });
const req = makeMockRequest(
'GET',
'http://localhost/api/v1/yachts?page=abc&limit=20&order=desc',
);
const res = await listHandler(req, ctx, {});
expect(res.status).toBe(400);
});
});
describe('POST /api/v1/yachts — permission gate', () => {
it('viewer (no yachts.create) receives 403 through full pipeline', async () => {
const port = await makePort();
const client = await makeClient({ portId: port.id });
const gated = withPermission('yachts', 'create', createHandler);
const ctx = makeMockCtx({ portId: port.id, permissions: makeViewerPermissions() });
const req = makeMockRequest('POST', 'http://localhost/api/v1/yachts', {
body: { name: 'X', owner: { type: 'client', id: client.id } },
});
const res = await gated(req, ctx, {});
expect(res.status).toBe(403);
// Sanity check that the withAuth-wrapped HTTP export exists.
expect(POST).toBeDefined();
});
});