mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-08 00:19:42 +02:00
Point 1 of the v1.0 lock-in: commit to a stable HTTP API (the cleanest, fullest form).
Core (centralized):
- Every JSON /api response now uses ONE envelope via a Fastify preSerialization hook (src/web/server.ts): success -> { success:true, data:<payload> }; error -> { success:false, error, errorCode } with a conventional HTTP status. Non-JSON routes (file-raw, tail-file SSE, download, screenshots, /q redirect, WS) are skipped.
- Error-code -> HTTP status is a single source of truth (httpStatusForErrorCode in src/types/api.ts): 400/401/404/409/422/429/500. Expanded ApiErrorCode (added UNAUTHORIZED, CONFLICT, RATE_LIMITED). Errors are no longer HTTP 200.
- Versioned alias: /api/v1/* rewrites to /api/* (rewriteApiV1Url), so external clients pin to a stable surface while the bundled UI keeps using /api/*.
- Handlers stripped of manual 'success:true' (50 across 14 route files) so they return bare payloads the hook wraps uniformly; fixed the mux DELETE {success:<bool>} envelope collision (-> {killed}).
Frontend (48 call sites across 10 files):
- _apiJson() auto-unwraps { success:true, data } -> data (null on error), so most bare-shape readers are transparent. Raw-fetch sites relocate payload reads under .data; success/res.ok/error checks unchanged.
Docs: new docs/api-reference.md (envelope, status table, error codes, /api/v1, SSE); versioning-policy.md flipped — the HTTP/SSE API is now part of the stable, SemVer-covered surface.
Verification: full unit/route suite green (2680 passed) incl. ~166 updated assertions across 24 test files; typecheck/lint/format/frontend-syntax clean; a headless-chromium smoke loaded the migrated UI and drove the panels with 0 console/page errors; /api/status and /api/v1/status confirmed returning the uniform envelope live.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
50 lines
1.8 KiB
TypeScript
50 lines
1.8 KiB
TypeScript
/**
|
|
* @fileoverview Push notification routes.
|
|
* Manages VAPID keys, push subscriptions, and preference updates.
|
|
*/
|
|
|
|
import { FastifyInstance } from 'fastify';
|
|
import { v4 as uuidv4 } from 'uuid';
|
|
import { ApiErrorCode, createErrorResponse } from '../../types.js';
|
|
import { PushSubscribeSchema, PushPreferencesUpdateSchema } from '../schemas.js';
|
|
import { parseBody } from '../route-helpers.js';
|
|
import type { InfraPort } from '../ports/index.js';
|
|
|
|
export function registerPushRoutes(app: FastifyInstance, ctx: InfraPort): void {
|
|
app.get('/api/push/vapid-key', async () => {
|
|
return { success: true, data: { publicKey: ctx.pushStore.getPublicKey() } };
|
|
});
|
|
|
|
app.post('/api/push/subscribe', async (req) => {
|
|
const { endpoint, keys, userAgent, pushPreferences } = parseBody(PushSubscribeSchema, req.body);
|
|
const record = ctx.pushStore.addSubscription({
|
|
id: uuidv4(),
|
|
endpoint,
|
|
keys,
|
|
userAgent: userAgent ?? req.headers['user-agent'] ?? '',
|
|
createdAt: Date.now(),
|
|
pushPreferences: pushPreferences ?? {},
|
|
});
|
|
return { success: true, data: { id: record.id } };
|
|
});
|
|
|
|
app.put('/api/push/subscribe/:id', async (req) => {
|
|
const { id } = req.params as { id: string };
|
|
const { pushPreferences } = parseBody(PushPreferencesUpdateSchema, req.body);
|
|
const updated = ctx.pushStore.updatePreferences(id, pushPreferences);
|
|
if (!updated) {
|
|
return createErrorResponse(ApiErrorCode.NOT_FOUND, 'Subscription not found');
|
|
}
|
|
return {};
|
|
});
|
|
|
|
app.delete('/api/push/subscribe/:id', async (req) => {
|
|
const { id } = req.params as { id: string };
|
|
const removed = ctx.pushStore.removeSubscription(id);
|
|
if (!removed) {
|
|
return createErrorResponse(ApiErrorCode.NOT_FOUND, 'Subscription not found');
|
|
}
|
|
return {};
|
|
});
|
|
}
|