av-club keeps doing exactly what it did — sharp, ffmpeg and ffprobe behind one API, and the invariant that the caller never names a path. What changes is how it is reached and who decides who may reach it. `src/` is `sidecar/`, because that is the name the platform looks for: `sidecar/index.ts` present means "this plugin ships a process", and presence is the declaration for everything structural here. `manifest.ts` at the root is the other half of that rule. api/router.ts is a proxy and nothing else. the platform authenticates, checks the `av-club` permission, and forwards — so the sidecar now accepts a request carrying `X-Officer-User` and no longer demands its own bearer token from callers who came that way. it binds LOOPBACK to make that trustworthy, which is the same boundary caldav's DAV door already relies on. AV_CLUB_TOKEN stays, and still guards anything calling the port directly: fofos/platform is the stated first consumer and is not Officer. THREE THINGS HAD TO GO, and each one broke it in a way worth writing down. package.json and bun.lock: a package.json inside a plugin is a package boundary, so bun stops walking up for the platform's tsconfig and `@@/sidecar/connect` stops resolving. the sidecar died on its first import, fifteen times. npm dependencies go in the manifest instead, where npm-deps.ts intersects them across plugins into one plugins/node_modules — which is also how this surfaced a real conflict: sharp ^0.33.5 (atelier) and ^0.35.3 here do not overlap, since a 0.x caret pins the minor. atelier moved up; it calls one method. tsconfig.json: same failure one layer earlier, shadowing the platform's `@@/*` paths so api/router.ts would not mount. no other plugin has one. no screens, deliberately. this is an API and a body of documentation; its callers are a commander watching a folder, an agent, or curl. a dock tile would advertise a page with nothing on it. verified through /api/av-club with an agent key: a 3000x2000 jpeg uploaded, probed, and resized to a 1200x800 avif — 166 KB to 1 KB — without the caller ever holding av-club's own token. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Officer-Session: 656f5c85-e49a-4f1f-b9f3-042a04b4d043
57 lines
1.8 KiB
TypeScript
57 lines
1.8 KiB
TypeScript
/**
|
|
* One error envelope for every failure, because a client parses failures the same way it parses
|
|
* successes. A route that answers with a bare string does not return the wrong shape — it breaks
|
|
* the parse. `error` is always an object.
|
|
*/
|
|
|
|
export const ERROR_STATUS = {
|
|
invalid_request: 400,
|
|
unauthorized: 401,
|
|
not_found: 404,
|
|
payload_too_large: 413,
|
|
unprocessable: 422,
|
|
timeout: 504,
|
|
server_error: 500,
|
|
} as const;
|
|
|
|
export type ErrorType = keyof typeof ERROR_STATUS;
|
|
|
|
export class ApiError extends Error {
|
|
constructor(
|
|
readonly type: ErrorType,
|
|
message: string,
|
|
/** Dotted path to the offending field, e.g. `pipeline[1].resize.width`. */
|
|
readonly param?: string,
|
|
) {
|
|
super(message);
|
|
this.name = "ApiError";
|
|
}
|
|
|
|
toResponse(): Response {
|
|
return Response.json(
|
|
{ error: { message: this.message, type: this.type, param: this.param ?? null } },
|
|
{ status: ERROR_STATUS[this.type] },
|
|
);
|
|
}
|
|
}
|
|
|
|
export const invalid = (message: string, param?: string) => new ApiError("invalid_request", message, param);
|
|
export const notFound = (message = "No such asset") => new ApiError("not_found", message);
|
|
export const unprocessable = (message: string, param?: string) => new ApiError("unprocessable", message, param);
|
|
|
|
/**
|
|
* Turn anything thrown into a response.
|
|
*
|
|
* An unrecognised error is logged and answered with a generic 500 — the message may name a path or
|
|
* quote file contents, and neither belongs in a response body.
|
|
*/
|
|
export function toErrorResponse(error: unknown): Response {
|
|
if (error instanceof ApiError) return error.toResponse();
|
|
|
|
console.error("[av-club] unhandled:", error);
|
|
return Response.json(
|
|
{ error: { message: "Internal Server Error", type: "server_error", param: null } },
|
|
{ status: 500 },
|
|
);
|
|
}
|