Rotas API | EmDash CMS Everything

Plugins podem expor rotas API para sua interface administrativa e integrações externas. As rotas são montadas sob /_emdash/api/plugins/<slug>/<route-name> (o <slug> é o campo slug de emdash-plugin.jsonc — exposto em tempo de execução como ctx.plugin.id) e executam dentro do runtime sandbox com o mesmo PluginContext que os hooks recebem.

Esta página cobre plugins sandboxed. A superfície da API para plugins nativos é a mesma; a única diferença é a assinatura do handler — veja a nota em Plugins nativos para detalhes.

Definindo rotas

Declare rotas na exportação padrão de src/plugin.ts:

import type { SandboxedPlugin } from "emdash/plugin";
import { z } from "astro/zod";

export default {
	routes: {
		status: {
			handler: async (_routeCtx, ctx) => {
				return { ok: true, plugin: ctx.plugin.id };
			},
		},

		submissions: {
			input: z.object({
				formId: z.string().optional(),
				limit: z.number().default(50),
				cursor: z.string().optional(),
			}),
			handler: async (routeCtx, ctx) => {
				const { formId, limit, cursor } = routeCtx.input;

				const result = await ctx.storage.submissions.query({
					where: formId ? { formId } : undefined,
					orderBy: { createdAt: "desc" },
					limit,
					cursor,
				});

				return result;
			},
		},
	},
} satisfies SandboxedPlugin;

satisfies SandboxedPlugin infere routeCtx e ctx — nenhuma anotação de parâmetro necessária. Handlers de rota sandboxed recebem dois argumentos: (routeCtx, ctx).

routeCtx carrega dados com formato de requisição: { input, request, requestMeta }.
ctx é o mesmo PluginContext que você obtém dentro de hooks — ctx.storage, ctx.kv, ctx.content, ctx.http, ctx.log, etc.

URLs de rotas

As rotas são montadas em /_emdash/api/plugins/<slug>/<route-name>. Nomes de rotas podem incluir barras para caminhos aninhados.

ID do plugin	Nome da rota	URL
`forms`	`status`	`/_emdash/api/plugins/forms/status`
`forms`	`submissions`	`/_emdash/api/plugins/forms/submissions`
`seo`	`settings/save`	`/_emdash/api/plugins/seo/settings/save`
`analytics`	`events/recent`	`/_emdash/api/plugins/analytics/events/recent`

Autenticação e CSRF

Rotas de plugin são autenticadas por padrão. O dispatcher requer uma sessão (ou um token com o escopo admin) antes de chamar seu handler:

Métodos de leitura (GET, HEAD, OPTIONS) requerem a permissão plugins:read.
Métodos de escrita (POST, PUT, PATCH, DELETE) requerem plugins:manage.
Métodos que alteram estado em rotas privadas também requerem o cabeçalho CSRF X-EmDash-Request: 1 (o hook usePluginAPI() da interface administrativa o envia automaticamente; chamadores externos autenticados por cookie precisam configurá-lo eles mesmos; requisições autenticadas por token estão isentas).

Para isentar uma rota de autenticação e CSRF, marque-a como public: true:

routes: {
	track: {
		public: true,
		input: z.object({ event: z.string() }),
		handler: async (routeCtx, ctx) => {
			ctx.log.info("Tracked", { event: routeCtx.input.event });
			return { ok: true };
		},
	},
},

Validação de entrada

input aceita um schema Zod. O dispatcher analisa o corpo da requisição (POST/PUT/PATCH) ou string de consulta (GET/DELETE), valida e passa o resultado tipado para seu handler como routeCtx.input. Entrada inválida retorna um 400 antes de seu handler executar.

routes: {
	create: {
		input: z.object({
			title: z.string().min(1).max(200),
			email: z.string().email(),
			priority: z.enum(["low", "medium", "high"]).default("medium"),
			tags: z.array(z.string()).optional(),
		}),
		handler: async (routeCtx, ctx) => {
			const { title, email, priority, tags } = routeCtx.input;

			await ctx.storage.items.put(`item_${Date.now()}`, {
				title,
				email,
				priority,
				tags: tags ?? [],
				createdAt: new Date().toISOString(),
			});

			return { success: true };
		},
	},
},

Valores de retorno

Retorne qualquer valor serializável em JSON. O dispatcher o envolve no envelope padrão do EmDash ({ success: true, data: <your value> }) e o serve como application/json.

return { id: "abc", count: 42 };  // wrapped to { success: true, data: { id, count } }
return [1, 2, 3];                 // wrapped to { success: true, data: [1, 2, 3] }

Erros

Lance para retornar uma resposta de erro. Qualquer coisa que não seja um erro de plugin conhecido retorna uma mensagem genérica — exceções internas são mascaradas ao invés de vazar stack traces ou erros de banco de dados:

handler: async (routeCtx, ctx) => {
	const item = await ctx.storage.items.get(routeCtx.input.id);
	if (!item) {
		throw new Error("Item not found");
	}
	return item;
},

Para um código de status específico, lance uma Response:

handler: async (routeCtx, ctx) => {
	const item = await ctx.storage.items.get(routeCtx.input.id);
	if (!item) {
		throw new Response(JSON.stringify({ error: "Not found" }), {
			status: 404,
			headers: { "Content-Type": "application/json" },
		});
	}
	return item;
},

Métodos HTTP

Rotas respondem a todos os métodos. Ramifique em routeCtx.request.method se precisar de comportamento por método:

routes: {
	item: {
		input: z.object({ id: z.string() }),
		handler: async (routeCtx, ctx) => {
			const { id } = routeCtx.input;

			switch (routeCtx.request.method) {
				case "GET":
					return await ctx.storage.items.get(id);
				case "DELETE":
					await ctx.storage.items.delete(id);
					return { deleted: true };
				default:
					throw new Response("Method not allowed", { status: 405 });
			}
		},
	},
},

Acessando a requisição

routeCtx.request é um SandboxedRequest: um registro portátil { url, method, headers } que se comporta de forma idêntica em processo e dentro de um isolado. headers é um Record<string, string> indexado por nome de cabeçalho em minúsculas — indexe pelo nome em minúsculas ou itere com Object.entries. url é uma string, então new URL(request.url) analisa parâmetros de consulta. routeCtx.requestMeta carrega IP, user agent e dados geo normalizados entre plataformas quando disponíveis.

handler: async (routeCtx, ctx) => {
	const { request, requestMeta } = routeCtx;

	const auth = request.headers["authorization"]; // lowercased key, no .get()
	const url = new URL(request.url);
	const page = url.searchParams.get("page");

	ctx.log.info("Request", { meta: requestMeta });

	if (request.method !== "POST") {
		throw new Response("POST required", { status: 405 });
	}
},

Padrões comuns

Configurações via KV

Plugins sandboxed leem e escrevem configurações através do armazenamento KV, convencionalmente sob um prefixo settings:. O formulário settingsSchema auto-gerado é apenas para nativos — para plugins sandboxed, exponha a leitura/escrita através de rotas e renderize o formulário em Block Kit.

routes: {
	settings: {
		handler: async (_routeCtx, ctx) => {
			const settings = await ctx.kv.list("settings:");
			const result: Record<string, unknown> = {};
			for (const entry of settings) {
				result[entry.key.replace("settings:", "")] = entry.value;
			}
			return result;
		},
	},

	"settings/save": {
		input: z.object({
			enabled: z.boolean().optional(),
			apiKey: z.string().optional(),
			maxItems: z.number().optional(),
		}),
		handler: async (routeCtx, ctx) => {
			for (const [key, value] of Object.entries(routeCtx.input)) {
				if (value !== undefined) {
					await ctx.kv.set(`settings:${key}`, value);
				}
			}
			return { success: true };
		},
	},
},

Lista paginada

Retorne paginação baseada em cursor de uma consulta de armazenamento — a forma da resposta corresponde ao que o resto do EmDash usa:

routes: {
	list: {
		input: z.object({
			limit: z.number().min(1).max(100).default(50),
			cursor: z.string().optional(),
			status: z.string().optional(),
		}),
		handler: async (routeCtx, ctx) => {
			const { limit, cursor, status } = routeCtx.input;

			const result = await ctx.storage.items.query({
				where: status ? { status } : undefined,
				orderBy: { createdAt: "desc" },
				limit,
				cursor,
			});

			return {
				items: result.items.map((item) => ({ id: item.id, ...item.data })),
				cursor: result.cursor,
				hasMore: result.hasMore,
			};
		},
	},
},

Proxy de API externa

Proxy uma requisição para um serviço externo através de ctx.http (requer capacidade network:request e uma entrada em allowedHosts):

routes: {
	forecast: {
		input: z.object({ city: z.string() }),
		handler: async (routeCtx, ctx) => {
			if (!ctx.http) throw new Error("Network capability not granted");

			const apiKey = await ctx.kv.get<string>("settings:apiKey");
			if (!apiKey) throw new Error("API key not configured");

			const response = await ctx.http.fetch(
				`https://api.weather.example.com/forecast?city=${routeCtx.input.city}`,
				{ headers: { "X-API-Key": apiKey } },
			);

			if (!response.ok) {
				throw new Error(`Weather API error: ${response.status}`);
			}
			return response.json();
		},
	},
},

Chamando rotas da interface administrativa

Use usePluginAPI() do pacote administrativo — ele adiciona automaticamente o cabeçalho CSRF X-EmDash-Request e o prefixo de ID do plugin:

import { usePluginAPI } from "@emdash-cms/admin";

function SettingsPage() {
	const api = usePluginAPI();

	const handleSave = async (settings) => {
		await api.post("settings/save", settings);
	};

	const loadSettings = async () => {
		return api.get("settings");
	};
}

Chamando rotas externamente

Rotas públicas são chamáveis diretamente:

curl -X POST https://your-site.com/_emdash/api/plugins/forms/track \
  -H "Content-Type: application/json" \
  -d '{"event": "pageview"}'

Rotas privadas precisam de credenciais de sessão ou um token API com o escopo admin:

curl -X POST https://your-site.com/_emdash/api/plugins/forms/create \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"title": "Hello", "email": "user@example.com"}'

Referência de contexto de rota

// O que os handlers de rota sandboxed recebem como seus dois argumentos

interface SandboxedRequest {
	url: string;
	method: string;
	headers: Record<string, string>; // lowercased keys
}

interface SandboxedRouteContext {
	input: unknown; // narrow with the `input` Zod schema at the route level
	request: SandboxedRequest;
	requestMeta?: unknown;
}

interface PluginContext {
	plugin: { id: string; version: string };
	storage: PluginStorage;
	kv: KVAccess;
	log: LogAccess;
	site: SiteInfo;
	url(path: string): string;
	cron?: CronAccess;
	content?: ContentAccess;       // when content:read or content:write declared
	media?: MediaAccess;           // when media:read or media:write declared
	http?: HttpAccess;             // when network:request declared
	users?: UserAccess;            // when users:read declared
	email?: EmailAccess;           // when email:send declared and provider configured
}

Plugins nativos recebem um único argumento RouteContext que combina os dois — veja Criando plugins nativos se você está indo por esse caminho.