フックリファレンス

フックを使うと、プラグインがコンテンツ、メディア、メール、コメント、ページのライフサイクルの特定のポイントでEmDashの動作をインターセプトして変更できます。

フック概要

以下の表は各フック、そのトリガー、変更できるもの、排他的かどうかを示します：

コンテンツフック

content:beforeSave

コンテンツがデータベースに保存される前に実行されます。コンテンツの検証、変換、エンリッチに使用します。

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

戻り値

• 変更を適用するには変更されたコンテンツオブジェクトを返す
• 変更なしで通過させるにはvoidを返す

content:afterSave

コンテンツ保存後に実行されます。通知、キャッシュ無効化、外部同期などの副作用に使用します。

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

戻り値

戻り値は期待されません。

content:beforeDelete

コンテンツ削除前に実行されます。削除の検証や防止に使用します。

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

戻り値

• 削除をキャンセルするにはfalseを返す
• 許可するにはtrueまたはvoidを返す

content:afterDelete

コンテンツ削除後に実行されます。クリーンアップタスクに使用します。

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

content:afterRestore

ゴミ箱のコンテンツ復元後に実行されます。content:readケイパビリティが必要です。

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

content:afterSchedule

コンテンツの将来公開スケジュール後に実行されます。content:readケイパビリティが必要です。

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

content:afterUnschedule

スケジュール済みコンテンツのスケジュール解除後に実行されます。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;
}

戻り値

戻り値は期待されません。

メディアフック

media:beforeUpload

ファイルアップロード前に実行されます。ファイルの検証、リネーム、拒否に使用します。

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

戻り値

• 変更を適用するには変更されたファイルメタデータを返す
• 変更なしで通過させるにはvoidを返す
• アップロードを拒否するにはエラーをスロー

media:afterUpload

ファイルアップロード後に実行されます。処理、サムネイル、メタデータ抽出に使用します。

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

ライフサイクルフック

plugin:install

プラグイン初回インストール時に実行されます。初期設定、ストレージコレクションの作成、データシードに使用します。

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

プラグインが有効化された時（インストール後または再有効化）に実行されます。

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

plugin:deactivate

プラグインが無効化された時に実行されます。

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

plugin:uninstall

プラグインが削除された時に実行されます。クリーンアップに使用します。

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

Cronフック

cron

スケジュールタスク実行時に発火します。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;
}

メールフック

メールフックは順番に実行されます：email:beforeSend、次にemail:deliver、次にemail:afterSend。

email:beforeSend

ケイパビリティ: hooks.email-events:register

配信前に実行されるミドルウェアフック。メッセージの変換や配信のキャンセルに使用。

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

戻り値

• 変換するには変更されたメッセージを返す
• 配信をキャンセルするにはfalseを返す
• 変更なしで通過させるにはvoidを返す

email:deliver

ケイパビリティ: hooks.email-transport:register | 排他的: はい

トランスポートプロバイダー。メールを配信できるプラグインは1つだけです。メールサービス経由で実際にメッセージを送信する責任があります。

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

email:afterSend

ケイパビリティ: hooks.email-events:register

配信成功後のfire-and-forgetフック。エラーはログされますが伝播しません。

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

コメントフック

コメントフックは順番に実行されます：comment:beforeCreate、次にcomment:moderate、次にcomment:afterCreate。comment:afterModerateフックは管理者がコメントのステータスを変更した時に別途発火します。

comment:beforeCreate

ケイパビリティ: users:read

コメント保存前のミドルウェアフック。コメントのエンリッチ、検証、拒否に使用。

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

戻り値

• 変換するには変更されたイベントを返す
• 拒否するにはfalseを返す
• 通過させるにはvoidを返す

comment:moderate

ケイパビリティ: users:read | 排他的: はい

コメントが承認、保留、スパムかを決定します。アクティブなモデレーションプロバイダーは1つだけです。

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

戻り値

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

comment:afterCreate

ケイパビリティ: users:read

コメント保存後のfire-and-forgetフック。通知に使用します。

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

ケイパビリティ: users:read

管理者がコメントのステータスを手動で変更した時のfire-and-forgetフック。

Event

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

ページフック

ページフックは公開ページの描画時に実行されます。プラグインがメタデータとスクリプトを注入できます。

page:metadata

ケイパビリティ: 不要

メタタグ、Open Graphプロパティ、JSON-LD構造化データ、リンクタグをページheadに追加します。

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

コントリビューションタイプ

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

keyフィールドはコントリビューションを重複排除します — 指定されたkeyの最後のコントリビューションのみが使用されます。

page:fragments

ケイパビリティ: hooks.page-fragments:register

ページにスクリプトまたはHTMLを注入します。ネイティブプラグインのみ利用可能。

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

コントリビューションタイプ

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

フック設定

フックはハンドラー関数または設定オブジェクトのいずれかを受け付けます：

hooks: {
  // シンプルなハンドラー
  "content:afterSave": async (event, ctx) => { ... },

  // 設定付き
  "content:beforeSave": {
    priority: 50,        // 低い値が先に実行（デフォルト: 100）
    timeout: 10000,      // 最大実行時間ms（デフォルト: 5000）
    dependencies: [],    // これらのプラグインの後に実行
    errorPolicy: "abort", // "continue"または"abort"（デフォルト）
    handler: async (event, ctx) => { ... },
  },
}

設定オプション

プラグインコンテキスト

すべてのフックはプラグインAPIへのアクセスを持つコンテキストオブジェクトを受け取ります：

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

ケイパビリティ要件とメソッドの詳細はプラグイン概要 — プラグインコンテキストを参照してください。

エラーハンドリング

フック内のエラーはerrorPolicyに基づいてログされ処理されます：

• "abort"（デフォルト）— 実行を停止、該当する場合はトランザクションをロールバック
• "continue" — エラーをログして次のフックに進む

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

実行順序

フックはこの順序で実行されます：

1. priorityで並べ替え（昇順）
2. dependenciesを持つプラグインは依存先の後に実行
3. 同じ優先度内では、順序は決定論的だが未指定

// これが最初に実行（優先度10）
{ priority: 10, handler: ... }

// これが2番目に実行（優先度50）
{ priority: 50, handler: ... }

// これが最後に実行（デフォルト優先度100）
{ handler: ... }