Ihr erstes natives Plugin

Diese Anleitung führt Sie Schritt für Schritt durch die Erstellung eines nativen Plugins. Native Plugins laufen im selben Prozess wie Ihre Astro-Site mit vollem Zugriff auf die Laufzeit, einschließlich React-Admin-Seiten, Portable-Text-Komponenten und Seitenfragmenten.

Wenn Sie sich noch nicht entschieden haben, ob Sie ein natives Plugin statt eines sandboxed Plugins möchten, lesen Sie zuerst Ein Plugin-Format wählen. Nativ ist das Format für Plugins, die React-Admin-Seiten, Portable-Text-Rendering-Komponenten oder Seitenfragmente benötigen.

Zwei Teile, in einer oder zwei Dateien

Wie sandboxed Plugins liefern native Plugins zwei Teile:

1. Eine Deskriptor-Factory — gibt einen PluginDescriptor mit format: "native" plus admin-bezogenen Einstiegspunkten zurück. Wird von astro.config.mjs zur Build-Zeit importiert.
2. Eine createPlugin(options)-Funktion — die Laufzeitseite. Gibt ein definePlugin({ id, version, capabilities, hooks, routes, admin })-Ergebnis zurück.

Im Gegensatz zu sandboxed Plugins können beide Teile in derselben Datei leben, da sie nicht in verschiedenen Umgebungen laufen:

my-native-plugin/
├── src/
│   ├── index.ts          # Deskriptor-Factory + createPlugin
│   ├── admin.tsx         # React-Admin-Komponenten (optional)
│   └── astro/            # Astro-Komponenten für PT-Block-Rendering (optional)
│       └── index.ts
├── package.json
└── tsconfig.json

Paket einrichten

{
	"name": "@my-org/plugin-analytics",
	"version": "0.1.0",
	"type": "module",
	"main": "dist/index.js",
	"exports": {
		".": {
			"types": "./dist/index.d.ts",
			"import": "./dist/index.js"
		},
		"./admin": {
			"types": "./dist/admin.d.ts",
			"import": "./dist/admin.js"
		}
	},
	"files": ["dist"],
	"peerDependencies": {
		"emdash": "*",
		"react": "^18.0.0"
	}
}

Halten Sie emdash und react als Peer-Dependencies, damit die Host-Site die tatsächlichen Versionen bereitstellt und Sie keine Duplikate ausliefern.

Deskriptor und Laufzeit schreiben

import { definePlugin } from "emdash";
import type { PluginDescriptor } from "emdash";

export interface AnalyticsOptions {
	enabled?: boolean;
	maxEvents?: number;
}

export function analyticsPlugin(options: AnalyticsOptions = {}): PluginDescriptor {
	return {
		id: "analytics",
		version: "0.1.0",
		format: "native",
		entrypoint: "@my-org/plugin-analytics",
		options,
		adminEntry: "@my-org/plugin-analytics/admin",
		adminPages: [{ path: "/dashboard", label: "Dashboard", icon: "chart" }],
		adminWidgets: [{ id: "events-today", title: "Events Today", size: "third" }],
	};
}

export function createPlugin(options: AnalyticsOptions = {}) {
	const maxEvents = options.maxEvents ?? 100;

	return definePlugin({
		id: "analytics",
		version: "0.1.0",

		capabilities: ["network:request"],
		allowedHosts: ["api.analytics.example.com"],

		storage: {
			events: { indexes: ["type", "createdAt"] },
		},

		admin: {
			entry: "@my-org/plugin-analytics/admin",
			settingsSchema: {
				trackingId: { type: "string", label: "Tracking ID" },
				enabled: { type: "boolean", label: "Enabled", default: options.enabled ?? true },
			},
			pages: [{ path: "/dashboard", label: "Dashboard", icon: "chart" }],
			widgets: [{ id: "events-today", title: "Events Today", size: "third" }],
		},

		hooks: {
			"plugin:install": async (_event, ctx) => {
				ctx.log.info("Analytics plugin installed", { maxEvents });
			},
			"content:afterSave": async (event, ctx) => {
				const enabled = await ctx.kv.get<boolean>("settings:enabled");
				if (enabled === false) return;
				await ctx.storage.events.put(`evt_${Date.now()}`, {
					type: "content:save",
					contentId: event.content.id,
					createdAt: new Date().toISOString(),
				});
			},
		},

		routes: {
			stats: {
				handler: async (ctx) => {
					const today = new Date().toISOString().split("T")[0];
					const count = await ctx.storage.events.count({
						createdAt: { gte: today },
					});
					return { today: count };
				},
			},
		},
	});
}

export default createPlugin;

Wichtige Details:

• format: "native" ist erforderlich. "native" ist auch der Standard, aber die explizite Angabe macht das Format leicht erkennbar.
• entrypoint ist der Hauptexport des Pakets. EmDash importiert ihn zur Laufzeit und ruft den Standardexport auf.
• options fließen vom Deskriptor → createPlugin. Alles, was der Benutzer bei der Registrierung übergibt, wird auf dem Deskriptor gespeichert und an createPlugin weitergeleitet.
• id, version und capabilities erscheinen zweimal. Einmal auf dem Deskriptor, einmal auf definePlugin(). Sie sollten übereinstimmen.
• Native Routen-Handler nehmen ein einzelnes Argument — (ctx: RouteContext).

Plugin-ID-Regeln

Das id-Feld muss /^[a-z][a-z0-9_-]*$/ entsprechen — mit einem Kleinbuchstaben beginnen, dann Buchstaben, Ziffern, Bindestriche oder Unterstriche.

// Gültig
"seo";
"audit-log";
"audit_log";
"plugin-forms";

// Ungültig
"@my-org/plugin-forms";  // Scoped-Form zur Laufzeit nicht erlaubt
"MyPlugin";              // Keine Großbuchstaben
"42-plugin";             // Darf nicht mit einer Ziffer beginnen
"my.plugin";             // Keine Punkte

Versionsformat

Verwenden Sie semantische Versionierung:

version: "1.0.0";       // gültig
version: "1.2.3-beta";  // gültig (Vorabversion)
version: "1.0";         // ungültig (fehlender Patch)

Plugin registrieren

import { defineConfig } from "astro/config";
import emdash from "emdash/astro";
import { analyticsPlugin } from "@my-org/plugin-analytics";

export default defineConfig({
	integrations: [
		emdash({
			plugins: [
				analyticsPlugin({ enabled: true, maxEvents: 500 }),
			],
		}),
	],
});

Einstellungs-UI

Native Plugins können admin.settingsSchema für ein automatisch generiertes Einstellungsformular verwenden:

admin: {
	settingsSchema: {
		apiKey: { type: "secret", label: "API Key" },
		enabled: { type: "boolean", label: "Enabled", default: true },
		maxItems: { type: "number", label: "Max items", min: 1, max: 1000, default: 100 },
	},
},

Feldtypen: string, number, boolean, select, secret, url, email. Jeder akzeptiert label, description, default plus typspezifische Extras wie min/max/options. Einstellungen werden im selben Plugin-KV-Store gespeichert — lesen Sie sie mit ctx.kv.get<T>("settings:<key>").

Für reichhaltigere Einstellungs-UI siehe React-Admin-Seiten und Widgets.

Vollständiges Beispiel — Audit-Log-Plugin

import { definePlugin } from "emdash";
import type { PluginDescriptor } from "emdash";

interface AuditEntry {
	timestamp: string;
	action: "create" | "update" | "delete";
	collection: string;
	resourceId: string;
	userId?: string;
}

export function auditLogPlugin(): PluginDescriptor {
	return {
		id: "audit-log",
		version: "0.1.0",
		format: "native",
		entrypoint: "@emdash-cms/plugin-audit-log",
	};
}

export function createPlugin() {
	return definePlugin({
		id: "audit-log",
		version: "0.1.0",

		storage: {
			entries: {
				indexes: [
					"timestamp",
					"action",
					"collection",
					["collection", "timestamp"],
					["action", "timestamp"],
				],
			},
		},

		admin: {
			settingsSchema: {
				retentionDays: {
					type: "number",
					label: "Aufbewahrung (Tage)",
					description: "Tage, die Einträge aufbewahrt werden. 0 = unbegrenzt.",
					default: 90,
					min: 0,
					max: 365,
				},
			},
			pages: [{ path: "/history", label: "Audit History", icon: "history" }],
			widgets: [{ id: "recent-activity", title: "Recent Activity", size: "half" }],
		},

		hooks: {
			"content:afterSave": {
				priority: 200,
				handler: async (event, ctx) => {
					const entry: AuditEntry = {
						timestamp: new Date().toISOString(),
						action: event.isNew ? "create" : "update",
						collection: event.collection,
						resourceId: event.content.id as string,
					};
					await ctx.storage.entries.put(`${Date.now()}-${event.content.id}`, entry);
				},
			},
			"content:afterDelete": {
				priority: 200,
				handler: async (event, ctx) => {
					await ctx.storage.entries.put(`${Date.now()}-${event.id}`, {
						timestamp: new Date().toISOString(),
						action: "delete",
						collection: event.collection,
						resourceId: event.id,
					});
				},
			},
		},

		routes: {
			recent: {
				handler: async (ctx) => {
					const result = await ctx.storage.entries.query({
						orderBy: { timestamp: "desc" },
						limit: 10,
					});
					return {
						entries: result.items.map((item) => ({
							id: item.id,
							...(item.data as AuditEntry),
						})),
					};
				},
			},
		},
	});
}

export default createPlugin;

Testen

Für Unit-Tests mocken Sie das PluginContext-Interface und rufen Sie Hook-Handler direkt auf.

Nächste Schritte

• React-Admin-Seiten und Widgets
• Portable-Text-Rendering-Komponenten
• Seitenfragmente
• Native Plugins verteilen