Il tuo primo plugin nativo | EmDash CMS Everything

Questa guida ti guida attraverso la costruzione di un plugin nativo da zero. I plugin nativi vengono eseguiti nello stesso processo del tuo sito Astro con accesso completo al runtime, incluse pagine di amministrazione React, componenti Portable Text e frammenti di pagina.

Se non hai ancora deciso se vuoi un plugin nativo invece di uno sandboxed, leggi prima Scegliere un formato di plugin. Nativo è il formato per i plugin che necessitano di pagine di amministrazione React, componenti di rendering Portable Text o frammenti di pagina.

Due pezzi, in uno o due file

Come i plugin sandboxed, i plugin nativi includono due pezzi:

Una factory di descriptor — restituisce un PluginDescriptor con format: "native" più punti di ingresso relativi all’amministrazione. Importato da astro.config.mjs al momento della build.
Una funzione createPlugin(options) — il lato runtime. Restituisce un risultato definePlugin({ id, version, capabilities, hooks, routes, admin }).

A differenza dei plugin sandboxed, entrambi i pezzi possono vivere nello stesso file perché non vengono eseguiti in ambienti diversi — l’intero plugin viene eseguito in-process. L’export "." del package punta a un file che esporta sia la factory del descriptor che una funzione createPlugin (o default):

my-native-plugin/
├── src/
│   ├── index.ts          # Descriptor factory + createPlugin
│   ├── admin.tsx         # React admin components (optional)
│   └── astro/            # Astro components for PT block rendering (optional)
│       └── index.ts
├── package.json
└── tsconfig.json

Configurare il package

Il seguente package.json dichiara i punti di ingresso e le peer dependencies di cui un plugin nativo ha bisogno:

{
	"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"
	}
}

Mantieni emdash e react come peer dependencies in modo che il sito host fornisca le versioni effettive e tu non spedisca duplicati.

Scrivere il descriptor e il runtime

Il seguente src/index.ts definisce la factory del descriptor e il runtime createPlugin in un file:

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;

Dettagli chiave di questa configurazione:

format: "native" è obbligatorio. "native" è anche il valore predefinito, ma dichiararlo esplicitamente su ogni descriptor rende il formato facile da individuare.
entrypoint è l’export principale del package. EmDash lo importa al runtime e chiama l’export predefinito per costruire il plugin risolto.
options fluiscono dal descriptor a createPlugin. Tutto ciò che l’utente passa quando registra il plugin (analyticsPlugin({ enabled: false })) viene conservato sul descriptor e inoltrato a createPlugin. I plugin sandboxed non hanno questa superficie — leggono le impostazioni da KV invece.
id, version e capabilities appaiono due volte. Una volta sul descriptor, una volta su definePlugin(). Devono corrispondere. La copia del descriptor è ciò che astro.config.mjs vede al momento della build; la copia di definePlugin() è ciò che viene eseguito al momento della richiesta.
I gestori di route nativi prendono un singolo argomento — (ctx: RouteContext) dove ctx.input, ctx.request e ctx.requestMeta sono uniti con le proprietà PluginContext regolari. Questo è l’opposto della forma a due argomenti del formato standard. Vedi Route API per la superficie completa (tutto il resto è identico).

Regole ID plugin

Il campo id deve corrispondere a /^[a-z][a-z0-9_-]*$/ — iniziare con una lettera minuscola, poi lettere, cifre, trattini o underscore. L’id viene usato come singolo segmento di percorso negli URL delle route dei plugin e come parte di identificatori SQL generati per gli indici di storage dei plugin, quindi tutto ciò che è al di fuori di quel pattern fallisce al runtime. I seguenti valori mostrano quali ID sono accettati:

// Valid
"seo";
"audit-log";
"audit_log";
"plugin-forms";

// Invalid
"@my-org/plugin-forms";  // scoped form not allowed at runtime
"MyPlugin";              // no uppercase
"42-plugin";             // can't start with a digit
"my.plugin";             // no dots

Abbina un id senza scope con un nome di package npm con scope in entrypoint — il nome del package e l’id del plugin sono preoccupazioni separate.

Formato versione

Usa il versionamento semantico. I seguenti valori mostrano quali stringhe di versione sono accettate:

version: "1.0.0";       // valid
version: "1.2.3-beta";  // valid (prerelease)
version: "1.0";         // invalid (missing patch)

Registrare il plugin

Nel astro.config.mjs del tuo sito, importa la factory del descriptor e passala nell’array plugins: [] — i plugin nativi vengono sempre eseguiti in-process, mai in sandboxed: []:

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

UI impostazioni

I plugin nativi possono usare admin.settingsSchema per un form di impostazioni generato automaticamente, che è il percorso più semplice:

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

Tipi di campo: string, number, boolean, select, secret, url, email. Ciascuno accetta label, description, default, più extra specifici del tipo come min/max/options. Le impostazioni vengono persistite nello stesso store KV per plugin che usano i plugin sandboxed — leggile con ctx.kv.get<T>("settings:<key>") da qualsiasi luogo.

Per un’UI di impostazioni più ricca di quanto fornito da settingsSchema, spedisci pagine React personalizzate — vedi Pagine di amministrazione e widget React.

Esempio completo — plugin registro di audit

Il seguente plugin registra ogni creazione, aggiornamento ed eliminazione di contenuto in storage indicizzato ed espone una route di attività recente:

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: "Retention (days)",
					description: "Days to keep entries. 0 = forever.",
					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;

Test

Testa un plugin nativo creando un sito Astro minimale con il plugin registrato:

Crea un sito di test con EmDash installato.
Registra il tuo plugin in astro.config.mjs, importandolo direttamente dal tuo percorso sorgente locale.
Esegui il server di sviluppo e attiva gli hook creando, aggiornando o eliminando contenuti.
Controlla la console per l’output di ctx.log e verifica lo storage tramite route API.

Per i test unitari, simula l’interfaccia PluginContext e chiama i gestori di hook direttamente.

Prossimi passi

Pagine di amministrazione e widget React — spedisci UI React personalizzata per il pannello di amministrazione.
Componenti di rendering Portable Text — fornisci componenti Astro che renderizzano tipi di blocco definiti dal plugin.
Frammenti di pagina — inietta script, fogli di stile o HTML in pagine pubbliche.
Distribuzione di plugin nativi — packaging npm e versionamento.