Referência de Hooks

Os hooks permitem que os plugins interceptem e modifiquem o comportamento do EmDash em pontos específicos do ciclo de vida de conteúdo, mídia, e-mail, comentários e páginas.

Visão geral dos hooks

A tabela a seguir lista cada hook, o que o aciona, o que ele pode modificar e se é exclusivo:

Hooks de Conteúdo

content:beforeSave

Executado antes de salvar o conteúdo no banco de dados. Use para validar, transformar ou enriquecer o conteúdo.

import { definePlugin } from "emdash";

export default definePlugin({
	id: "my-plugin",
	version: "1.0.0",
	hooks: {
		"content:beforeSave": async (event, ctx) => {
			const { content, collection, isNew } = event;

			// Add timestamps
			if (isNew) {
				content.createdBy = "system";
			}
			content.modifiedAt = new Date().toISOString();

			// Return modified content
			return content;
		},
	},
});

Event

interface ContentHookEvent {
	content: Record<string, unknown>; // Content data
	collection: string; // Collection slug
	isNew: boolean; // True for creates, false for updates
}

Valor de retorno

• Retornar objeto de conteúdo modificado para aplicar alterações
• Retornar void para passar sem alterações

content:afterSave

Executado depois de salvar o conteúdo. Use para efeitos colaterais como notificações, invalidação de cache ou sincronização externa.

hooks: {
  "content:afterSave": async (event, ctx) => {
    const { content, collection, isNew } = event;

    if (collection === "posts" && content.status === "published") {
      // Notify external service
      await ctx.http?.fetch("https://api.example.com/notify", {
        method: "POST",
        body: JSON.stringify({ postId: content.id }),
      });
    }
  },
}

Valor de retorno

Nenhum valor de retorno esperado.

content:beforeDelete

Executado antes de excluir o conteúdo. Use para validar a exclusão ou impedi-la.

hooks: {
  "content:beforeDelete": async (event, ctx) => {
    const { id, collection } = event;

    // Prevent deletion of protected content
    const item = await ctx.content?.get(collection, id);
    if (item?.data.protected) {
      return false; // Cancel deletion
    }

    // Allow deletion
    return true;
  },
}

Event

interface ContentDeleteEvent {
	id: string; // Entry ID
	collection: string; // Collection slug
}

Valor de retorno

• Retornar false para cancelar a exclusão
• Retornar true ou void para permitir

content:afterDelete

Executado depois de excluir o conteúdo. Use para tarefas de limpeza.

hooks: {
  "content:afterDelete": async (event, ctx) => {
    const { id, collection } = event;

    // Clean up related data
    await ctx.storage.relatedItems.delete(`${collection}:${id}`);
  },
}

Hooks de Mídia

media:beforeUpload

Executado antes de fazer upload de um arquivo. Use para validar, renomear ou rejeitar arquivos.

hooks: {
  "media:beforeUpload": async (event, ctx) => {
    const { file } = event;

    // Reject files over 10MB
    if (file.size > 10 * 1024 * 1024) {
      throw new Error("File too large");
    }

    // Rename file
    return {
      name: `${Date.now()}-${file.name}`,
      type: file.type,
      size: file.size,
    };
  },
}

Event

interface MediaUploadEvent {
	file: {
		name: string; // Original filename
		type: string; // MIME type
		size: number; // Size in bytes
	};
}

Valor de retorno

• Retornar metadados de arquivo modificados para aplicar alterações
• Retornar void para passar sem alterações
• Lançar exceção para rejeitar o upload

media:afterUpload

Executado depois de fazer upload de um arquivo. Use para processamento, miniaturas ou extração de metadados.

hooks: {
  "media:afterUpload": async (event, ctx) => {
    const { media } = event;

    if (media.mimeType.startsWith("image/")) {
      // Store image metadata
      await ctx.kv.set(`media:${media.id}:analyzed`, {
        processedAt: new Date().toISOString(),
      });
    }
  },
}

Event

interface MediaAfterUploadEvent {
	media: {
		id: string;
		filename: string;
		mimeType: string;
		size: number | null;
		url: string;
		createdAt: string;
	};
}

Hooks de Ciclo de Vida

plugin:install

Executado quando um plugin é instalado pela primeira vez. Use para configuração inicial, criação de coleções de armazenamento ou dados de semente.

hooks: {
  "plugin:install": async (event, ctx) => {
    // Initialize default settings
    await ctx.kv.set("settings:enabled", true);
    await ctx.kv.set("settings:threshold", 100);

    ctx.log.info("Plugin installed successfully");
  },
}

plugin:activate

Executado quando um plugin é habilitado (após instalação ou reativação).

hooks: {
  "plugin:activate": async (event, ctx) => {
    ctx.log.info("Plugin activated");
  },
}

plugin:deactivate

Executado quando um plugin é desabilitado.

hooks: {
  "plugin:deactivate": async (event, ctx) => {
    ctx.log.info("Plugin deactivated");
  },
}

plugin:uninstall

Executado quando um plugin é removido. Use para limpeza.

hooks: {
  "plugin:uninstall": async (event, ctx) => {
    const { deleteData } = event;

    if (deleteData) {
      // Clean up all plugin data
      const items = await ctx.kv.list("settings:");
      for (const { key } of items) {
        await ctx.kv.delete(key);
      }
    }

    ctx.log.info("Plugin uninstalled");
  },
}

Event

interface UninstallEvent {
	deleteData: boolean; // User chose to delete data
}

Hook Cron

cron

Disparado quando uma tarefa agendada é executada. Agende tarefas com ctx.cron.schedule().

hooks: {
  "cron": async (event, ctx) => {
    if (event.name === "daily-sync") {
      const data = await ctx.http?.fetch("https://api.example.com/data");
      ctx.log.info("Sync complete");
    }
  },
}

Event

interface CronEvent {
	name: string;
	data?: Record<string, unknown>;
	scheduledAt: string;
}

Hooks de E-mail

Os hooks de e-mail são executados em ordem: email:beforeSend, depois email:deliver, depois email:afterSend.

email:beforeSend

Capacidade: hooks.email-events:register

Hook de middleware executado antes da entrega. Transforme mensagens ou cancele a entrega.

hooks: {
  "email:beforeSend": async (event, ctx) => {
    // Add footer to all emails
    return {
      ...event.message,
      text: event.message.text + "\n\n—Sent from My Site",
    };

    // Or return false to cancel delivery
  },
}

Event

interface EmailBeforeSendEvent {
	message: { to: string; subject: string; text: string; html?: string };
	source: string;
}

Valor de retorno

• Retornar mensagem modificada para transformar
• Retornar false para cancelar a entrega
• Retornar void para passar sem alterações

email:deliver

Capacidade: hooks.email-transport:register | Exclusivo: Sim

O provedor de transporte. Apenas um plugin pode entregar e-mails. Responsável por realmente enviar a mensagem via um serviço de e-mail.

hooks: {
  "email:deliver": {
    exclusive: true,
    handler: async (event, ctx) => {
      await sendViaSES(event.message);
    },
  },
}

email:afterSend

Capacidade: hooks.email-events:register

Hook fire-and-forget após entrega bem-sucedida. Erros são registrados mas não se propagam.

hooks: {
  "email:afterSend": async (event, ctx) => {
    await ctx.kv.set(`email:log:${Date.now()}`, {
      to: event.message.to,
      subject: event.message.subject,
    });
  },
}

Hooks de Comentários

Os hooks de comentários são executados em ordem: comment:beforeCreate, depois comment:moderate, depois comment:afterCreate. O hook comment:afterModerate dispara separadamente quando um admin altera o status de um comentário.

comment:beforeCreate

Capacidade: users:read

Hook de middleware antes de armazenar um comentário. Enriqueça, valide ou rejeite comentários.

hooks: {
  "comment:beforeCreate": async (event, ctx) => {
    // Reject comments with links
    if (event.comment.body.includes("http")) {
      return false;
    }
  },
}

Event

interface CommentBeforeCreateEvent {
	comment: {
		collection: string;
		contentId: string;
		parentId: string | null;
		authorName: string;
		authorEmail: string;
		authorUserId: string | null;
		body: string;
		ipHash: string | null;
		userAgent: string | null;
	};
	metadata: Record<string, unknown>;
}

Valor de retorno

• Retornar evento modificado para transformar
• Retornar false para rejeitar
• Retornar void para passar

comment:moderate

Capacidade: users:read | Exclusivo: Sim

Decidir se um comentário está aprovado, pendente ou é spam. Apenas um provedor de moderação está ativo.

hooks: {
  "comment:moderate": {
    exclusive: true,
    handler: async (event, ctx) => {
      const score = await checkSpam(event.comment);
      return {
        status: score > 0.8 ? "spam" : score > 0.5 ? "pending" : "approved",
        reason: `Spam score: ${score}`,
      };
    },
  },
}

Event

interface CommentModerateEvent {
	comment: { /* same as beforeCreate */ };
	metadata: Record<string, unknown>;
	collectionSettings: {
		commentsEnabled: boolean;
		commentsModeration: "all" | "first_time" | "none";
		commentsClosedAfterDays: number;
		commentsAutoApproveUsers: boolean;
	};
	priorApprovedCount: number;
}

Valor de retorno

{ status: "approved" | "pending" | "spam"; reason?: string }

comment:afterCreate

Capacidade: users:read

Hook fire-and-forget após armazenar um comentário. Use para notificações.

hooks: {
  "comment:afterCreate": async (event, ctx) => {
    if (event.comment.status === "approved") {
      await ctx.email?.send({
        to: event.contentAuthor?.email,
        subject: `New comment on "${event.content.title}"`,
        text: `${event.comment.authorName} commented: ${event.comment.body}`,
      });
    }
  },
}

comment:afterModerate

Capacidade: users:read

Hook fire-and-forget quando um admin altera manualmente o status de um comentário.

Event

interface CommentAfterModerateEvent {
	comment: { id: string; /* ... */ };
	previousStatus: string;
	newStatus: string;
	moderator: { id: string; name: string | null };
}

Hooks de Página

Os hooks de página são executados ao renderizar páginas públicas. Eles permitem que os plugins injetem metadados e scripts.

page:metadata

Capacidade: Nenhuma necessária

Contribuir meta tags, propriedades Open Graph, dados estruturados JSON-LD ou tags de link para o head da página.

hooks: {
  "page:metadata": async (event, ctx) => {
    return [
      { kind: "meta", name: "generator", content: "EmDash" },
      { kind: "property", property: "og:site_name", content: event.page.siteName },
      { kind: "jsonld", graph: { "@type": "WebSite", name: event.page.siteName } },
    ];
  },
}

Tipos de Contribuição

type PageMetadataContribution =
	| { kind: "meta"; name: string; content: string; key?: string }
	| { kind: "property"; property: string; content: string; key?: string }
	| {
			kind: "link";
			rel: "canonical" | "alternate" | "author" | "license" | "nlweb" | "site.standard.document";
			href: string;
			hreflang?: string;
			key?: string;
	  }
	| {
			kind: "jsonld";
			id?: string;
			graph: Record<string, unknown> | Array<Record<string, unknown>>;
	  };

O campo key desduplicará as contribuições — apenas a última contribuição com uma chave dada é usada.

page:fragments

Capacidade: hooks.page-fragments:register

Injetar scripts ou HTML em páginas. Disponível apenas para plugins nativos.

hooks: {
  "page:fragments": async (event, ctx) => {
    return [
      {
        kind: "external-script",
        placement: "body:end",
        src: "https://analytics.example.com/script.js",
        async: true,
      },
      {
        kind: "inline-script",
        placement: "head",
        code: `window.siteId = "abc123";`,
      },
    ];
  },
}

Tipos de Contribuição

type PageFragmentContribution =
	| {
			kind: "external-script";
			placement: "head" | "body:start" | "body:end";
			src: string;
			async?: boolean;
			defer?: boolean;
			attributes?: Record<string, string>;
			key?: string;
		}
	| {
			kind: "inline-script";
			placement: "head" | "body:start" | "body:end";
			code: string;
			attributes?: Record<string, string>;
			key?: string;
		}
	| {
			kind: "html";
			placement: "head" | "body:start" | "body:end";
			html: string;
			key?: string;
		};

Configuração de Hook

Os hooks aceitam uma função handler ou um objeto de configuração:

hooks: {
  // Simple handler
  "content:afterSave": async (event, ctx) => { ... },

  // With configuration
  "content:beforeSave": {
    priority: 50,        // Lower runs first (default: 100)
    timeout: 10000,      // Max execution time in ms (default: 5000)
    dependencies: [],    // Run after these plugins
    errorPolicy: "abort", // "continue" or "abort" (default)
    handler: async (event, ctx) => { ... },
  },
}

Opções de Configuração

Contexto do Plugin

Todos os hooks recebem um objeto de contexto com acesso às APIs do plugin:

interface PluginContext {
	plugin: { id: string; version: string };
	storage: PluginStorage;
	kv: KVAccess;
	content?: ContentAccess;
	media?: MediaAccess;
	http?: HttpAccess;
	log: LogAccess;
	site: { name: string; url: string; locale: string };
	url(path: string): string;
	users?: UserAccess;
	cron?: CronAccess;
	email?: EmailAccess;
}

Veja Visão Geral do Plugin — Contexto do Plugin para requisitos de capacidade e detalhes do método.

Tratamento de Erros

Erros em hooks são registrados e tratados com base em errorPolicy:

• "abort" (padrão) — Parar a execução, reverter transação se aplicável
• "continue" — Registrar erro e continuar para o próximo hook

hooks: {
  "content:beforeSave": {
    errorPolicy: "continue", // Don't block save if this fails
    handler: async (event, ctx) => {
      try {
        await ctx.http?.fetch("https://api.example.com/validate");
      } catch (error) {
        ctx.log.warn("Validation service unavailable", error);
      }
    },
  },
}

Ordem de Execução

Os hooks são executados nesta ordem:

1. Ordenados por priority (crescente)
2. Plugins com dependencies são executados após suas dependências
3. Dentro da mesma prioridade, a ordem é determinística mas não especificada

// This runs first (priority 10)
{ priority: 10, handler: ... }

// This runs second (priority 50)
{ priority: 50, handler: ... }

// This runs last (default priority 100)
{ handler: ... }