Files
ersatztv/web/src/api/templates.ts
T
timothyandClaude Opus 4.8 ef2bd65c27
Build ErsatzTV Image / decisions.md append-only (pull_request) Successful in 10s
Build ErsatzTV Image / Docs update reminder (pull_request) Successful in 10s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m12s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 3m4s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m17s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 10m36s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
feat(api): #286 — mount the whole /api surface at /api/v1
Version every /api route to /api/v1 (251 controller routes + ~24 Location
headers + the scanner callback URL + the Startup request-log literal),
uniform across the machine API, auth, scanner and scripted-build surfaces.

Add ApiVersionRewriteMiddleware: a legacy unversioned /api/* request is
rewritten (NOT redirected) to /api/v1/* in-pipeline — method, body, auth
headers and query survive — carrying RFC 8594 Deprecation/Sunset headers,
so curl / the future MCP server / bookmarks keep working. An already-
versioned path passes through; a future /api/v2 is never forced to v1.

Standardize the route convention (leading-slash absolute route per method,
no class-[Route] — except the two Scanner/Scripted controllers whose ~all
actions share a parametrized {id} prefix), enforced by ApiRouteVersioningTests
(^/api/v\d+/ over the whole Controllers.Api surface; browser-nav
/auth/oidc/login is out of scope).

Regenerate v1.json (160 paths, all /api/v1)/endpoint-index/v1.d.ts; sweep 945
SPA request literals + the test mocks (regex + positional URL parsers). /api/v1
is additive-only after freeze; the legacy-rewrite shim sunsets in ~2 releases
(owner decision) with removal tracked as a Phase-3 follow-up.

Docs: decisions.md 2026-07-13, api-conventions §1/§9, rest-api/spa-conventions/
blazor-route-parity/e2e-local/domain-model.

fixes #286
refs #197

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-13 00:30:20 +02:00

86 lines
3.2 KiB
TypeScript

import { ApiError, request, requestWithMeta, type ResponseWithMeta } from './client';
import type { components } from './generated/v1';
export type TemplateGroup = components['schemas']['TemplateGroupResponseModel'];
export type Template = components['schemas']['TemplateResponseModel'];
export type TemplateItem = components['schemas']['TemplateItemResponseModel'];
export type TemplateWithItems = components['schemas']['TemplateWithItemsResponseModel'];
export type CreateTemplateGroupRequest = components['schemas']['CreateTemplateGroupRequest'];
export type CreateTemplateRequest = components['schemas']['CreateTemplateRequest'];
export type ReplaceTemplateRequest = components['schemas']['ReplaceTemplateRequest'];
export type TemplateItemRequest = components['schemas']['TemplateItemRequest'];
export type CopyTemplateRequest = components['schemas']['CopyTemplateRequest'];
// Template groups
export function getTemplateGroups(): Promise<TemplateGroup[]> {
return request<TemplateGroup[]>('/api/v1/templates/groups');
}
export function createTemplateGroup(body: CreateTemplateGroupRequest): Promise<TemplateGroup> {
return request<TemplateGroup>('/api/v1/templates/groups', { body, method: 'POST' });
}
export function deleteTemplateGroup(id: number): Promise<void> {
return request<void>(`/api/v1/templates/groups/${id}`, { method: 'DELETE' });
}
// Templates
export function getTemplates(): Promise<Template[]> {
return request<Template[]>('/api/v1/templates');
}
export function getTemplate(id: number): Promise<Template> {
return request<Template>(`/api/v1/templates/${id}`);
}
export function createTemplate(body: CreateTemplateRequest): Promise<Template> {
return request<Template>('/api/v1/templates', { body, method: 'POST' });
}
export function deleteTemplate(id: number): Promise<void> {
return request<void>(`/api/v1/templates/${id}`, { method: 'DELETE' });
}
export function getTemplateItems(id: number): Promise<TemplateItem[]> {
return request<TemplateItem[]>(`/api/v1/templates/${id}/items`);
}
/** Load template items together with the template's concurrency ETag (issue #253). */
export function getTemplateItemsWithMeta(id: number): Promise<ResponseWithMeta<TemplateItem[]>> {
return requestWithMeta<TemplateItem[]>(`/api/v1/templates/${id}/items`);
}
/**
* Replace a template. Pass the last-seen ETag as `If-Match` to reject a stale overwrite with 412;
* the resolved value carries the new ETag for a subsequent save (issue #253).
*/
export function replaceTemplate(
id: number,
body: ReplaceTemplateRequest,
ifMatch?: string | null
): Promise<ResponseWithMeta<TemplateWithItems>> {
return requestWithMeta<TemplateWithItems>(`/api/v1/templates/${id}`, {
body,
method: 'PUT',
headers: ifMatch ? { 'If-Match': ifMatch } : undefined
});
}
export function copyTemplate(id: number, body: CopyTemplateRequest): Promise<Template> {
return request<Template>(`/api/v1/templates/${id}/copy`, { body, method: 'POST' });
}
export function messageFromTemplateError(error: unknown, fallback = 'Unable to load templates'): string {
if (error instanceof ApiError) {
return error.detail ?? error.message;
}
if (error instanceof Error) {
return error.message;
}
return fallback;
}