Riferimento Hook

Gli hook permettono ai plugin di intercettare e modificare il comportamento di EmDash in punti specifici del ciclo di vita di contenuti, media, email, commenti e pagine.

Panoramica degli hook

La seguente tabella elenca ogni hook, cosa lo attiva, cosa può modificare e se è esclusivo:

Hook di contenuto

content:beforeSave

Viene eseguito prima del salvataggio del contenuto nel database. Usalo per validare, trasformare o arricchire il contenuto.

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;

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

			return content;
		},
	},
});

Event

interface ContentHookEvent {
	content: Record<string, unknown>;
	collection: string;
	isNew: boolean;
}

Valore di ritorno

• Restituire l’oggetto contenuto modificato per applicare le modifiche
• Restituire void per passare senza modifiche

content:afterSave

Viene eseguito dopo il salvataggio del contenuto. Usalo per effetti collaterali come notifiche, invalidazione cache o sincronizzazione esterna.

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

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

Valore di ritorno

Nessun valore di ritorno atteso.

content:beforeDelete

Viene eseguito prima dell’eliminazione del contenuto. Usalo per validare o impedire l’eliminazione.

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

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

    return true;
  },
}

Event

interface ContentDeleteEvent {
	id: string;
	collection: string;
}

Valore di ritorno

• Restituire false per annullare l’eliminazione
• Restituire true o void per permettere

content:afterDelete

Viene eseguito dopo l’eliminazione del contenuto. Usalo per attività di pulizia.

hooks: {
  "content:afterDelete": async (event, ctx) => {
    const { id, collection } = event;
    await ctx.storage.relatedItems.delete(`${collection}:${id}`);
  },
}

content:afterRestore

Viene eseguito dopo il ripristino di contenuto eliminato. Richiede la capacità content:read.

hooks: {
  "content:afterRestore": async (event, ctx) => {
    ctx.log.info(`Restored ${event.collection}/${event.content.id}`);
  },
}

content:afterSchedule

Viene eseguito dopo la pianificazione di contenuto per pubblicazione futura. Richiede la capacità content:read.

hooks: {
  "content:afterSchedule": async (event, ctx) => {
    ctx.log.info(`Scheduled ${event.collection}/${event.content.id}`);
  },
}

content:afterUnschedule

Viene eseguito dopo la depianificazione di contenuto pianificato. Richiede la capacità content:read.

hooks: {
  "content:afterUnschedule": async (event, ctx) => {
    ctx.log.info(`Unscheduled ${event.collection}/${event.content.id}`);
  },
}

Event

interface ContentStateChangeEvent {
	content: Record<string, unknown>;
	collection: string;
}

Valore di ritorno

Nessun valore di ritorno atteso.

Hook di media

media:beforeUpload

Viene eseguito prima del caricamento di un file. Usalo per validare, rinominare o rifiutare file.

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

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

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

Event

interface MediaUploadEvent {
	file: {
		name: string;
		type: string;
		size: number;
	};
}

Valore di ritorno

• Restituire metadati file modificati per applicare le modifiche
• Restituire void per passare senza modifiche
• Lanciare un errore per rifiutare il caricamento

media:afterUpload

Viene eseguito dopo il caricamento di un file. Usalo per elaborazione, miniature o estrazione metadati.

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

    if (media.mimeType.startsWith("image/")) {
      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;
	};
}

Hook del ciclo di vita

plugin:install

Viene eseguito alla prima installazione di un plugin. Usalo per la configurazione iniziale, la creazione di collezioni di storage o il seeding dei dati.

hooks: {
  "plugin:install": async (event, ctx) => {
    await ctx.kv.set("settings:enabled", true);
    await ctx.kv.set("settings:threshold", 100);
    ctx.log.info("Plugin installed successfully");
  },
}

plugin:activate

Viene eseguito quando un plugin viene attivato (dopo l’installazione o la riattivazione).

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

plugin:deactivate

Viene eseguito quando un plugin viene disattivato.

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

plugin:uninstall

Viene eseguito quando un plugin viene rimosso. Usalo per la pulizia.

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

    if (deleteData) {
      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;
}

Hook Cron

cron

Si attiva quando un task pianificato viene eseguito. Pianifica task con 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;
}

Hook email

Gli hook email vengono eseguiti nell’ordine: email:beforeSend, poi email:deliver, poi email:afterSend.

email:beforeSend

Capacità: hooks.email-events:register

Hook middleware che viene eseguito prima della consegna. Trasformare messaggi o annullare la consegna.

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

Event

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

Valore di ritorno

• Restituire messaggio modificato per trasformare
• Restituire false per annullare la consegna
• Restituire void per passare senza modifiche

email:deliver

Capacità: hooks.email-transport:register | Esclusivo: Sì

Il provider di trasporto. Solo un plugin può consegnare le email. Responsabile dell’invio effettivo del messaggio tramite un servizio email.

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

email:afterSend

Capacità: hooks.email-events:register

Hook fire-and-forget dopo consegna riuscita. Gli errori vengono registrati ma non si propagano.

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

Hook dei commenti

Gli hook dei commenti vengono eseguiti nell’ordine: comment:beforeCreate, poi comment:moderate, poi comment:afterCreate. L’hook comment:afterModerate si attiva separatamente quando un amministratore cambia lo stato di un commento.

comment:beforeCreate

Capacità: users:read

Hook middleware prima dello storage di un commento. Arricchire, validare o rifiutare commenti.

hooks: {
  "comment:beforeCreate": async (event, ctx) => {
    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>;
}

Valore di ritorno

• Restituire evento modificato per trasformare
• Restituire false per rifiutare
• Restituire void per passare senza modifiche

comment:moderate

Capacità: users:read | Esclusivo: Sì

Decide se un commento è approvato, in attesa o spam. Solo un provider di moderazione è attivo.

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: { /* come in beforeCreate */ };
	metadata: Record<string, unknown>;
	collectionSettings: {
		commentsEnabled: boolean;
		commentsModeration: "all" | "first_time" | "none";
		commentsClosedAfterDays: number;
		commentsAutoApproveUsers: boolean;
	};
	priorApprovedCount: number;
}

Valore di ritorno

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

comment:afterCreate

Capacità: users:read

Hook fire-and-forget dopo lo storage di un commento. Usalo per le notifiche.

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

Capacità: users:read

Hook fire-and-forget quando un amministratore cambia manualmente lo stato di un commento.

Event

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

Hook di pagina

Gli hook di pagina vengono eseguiti durante il rendering delle pagine pubbliche. Permettono ai plugin di iniettare metadati e script.

page:metadata

Capacità: Nessuna richiesta

Contribuire meta tag, proprietà Open Graph, dati strutturati JSON-LD o link tag all’head della pagina.

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 } },
    ];
  },
}

Tipi di contribuzione

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>>;
	  };

Il campo key deduplica le contribuzioni — solo l’ultima contribuzione con un dato key viene usata.

page:fragments

Capacità: hooks.page-fragments:register

Iniettare script o HTML nelle pagine. Disponibile solo per i plugin nativi.

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";`,
      },
    ];
  },
}

Tipi di contribuzione

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;
		};

Configurazione degli hook

Gli hook accettano sia una funzione handler che un oggetto di configurazione:

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

  // Con configurazione
  "content:beforeSave": {
    priority: 50,        // I valori bassi vengono eseguiti prima (predefinito: 100)
    timeout: 10000,      // Tempo massimo di esecuzione in ms (predefinito: 5000)
    dependencies: [],    // Eseguire dopo questi plugin
    errorPolicy: "abort", // "continue" o "abort" (predefinito)
    handler: async (event, ctx) => { ... },
  },
}

Opzioni di configurazione

Contesto del plugin

Tutti gli hook ricevono un oggetto contesto con accesso alle API del 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;
}

Vedi Panoramica plugin — Contesto del plugin per i requisiti delle capacità e i dettagli dei metodi.

Gestione degli errori

Gli errori negli hook vengono registrati e gestiti in base a errorPolicy:

• "abort" (predefinito) — Fermare l’esecuzione, annullare la transazione se applicabile
• "continue" — Registrare l’errore e continuare all’hook successivo

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

Ordine di esecuzione

Gli hook vengono eseguiti in questo ordine:

1. Ordinati per priority (ascendente)
2. I plugin con dependencies vengono eseguiti dopo le loro dipendenze
3. A parità di priorità, l’ordine è deterministico ma non specificato

// Questo viene eseguito per primo (priorità 10)
{ priority: 10, handler: ... }

// Questo viene eseguito per secondo (priorità 50)
{ priority: 50, handler: ... }

// Questo viene eseguito per ultimo (priorità predefinita 100)
{ handler: ... }