JavaScript API-Referenz

EmDash exportiert Funktionen zum Abfragen von Inhalten und zur Arbeit mit Vorschau, Einstellungen, Menüs, Taxonomien, Widget-Bereichen, Abschnitten und Suche.

Inhaltsabfragen

Die Abfragefunktionen von EmDash folgen dem Live Content Collections-Muster von Astro und geben { entries, error } oder { entry, error } für eine elegante Fehlerbehandlung zurück.

getEmDashCollection()

Ruft alle Einträge aus einer Sammlung ab. Das folgende Beispiel lädt alle Beiträge und prüft auf einen Fehler:

import { getEmDashCollection } from "emdash";

const { entries: posts, error } = await getEmDashCollection("posts");

if (error) {
	console.error("Failed to load posts:", error);
}

Parameter

Optionen

Der options-Parameter akzeptiert den folgenden Filter:

interface CollectionFilter {
	status?: "draft" | "published" | "archived";
	limit?: number;
	where?: Record<string, string | string[]>; // Filter by field or taxonomy
}

Rückgabewert

Die Funktion löst sich zu einem CollectionResult auf:

interface CollectionResult<T> {
	entries: ContentEntry<T>[]; // Empty array if error or none found
	error?: Error; // Set if query failed
}

Beispiele

Die folgenden Beispiele filtern nach Status und Taxonomie, begrenzen Ergebnisse und behandeln Fehler:

// Get all published posts
const { entries: posts } = await getEmDashCollection("posts", {
	status: "published",
});

// Get latest 5 posts
const { entries: latest } = await getEmDashCollection("posts", {
	limit: 5,
	status: "published",
});

// Filter by taxonomy
const { entries: newsPosts } = await getEmDashCollection("posts", {
	status: "published",
	where: { category: "news" },
});

// Handle errors
const { entries, error } = await getEmDashCollection("posts");
if (error) {
	return new Response("Server error", { status: 500 });
}

getEmDashEntry()

Ruft einen einzelnen Eintrag nach Slug oder ID ab. Das folgende Beispiel lädt einen Beitrag und leitet um, wenn er fehlt:

import { getEmDashEntry } from "emdash";

const { entry: post, error } = await getEmDashEntry("posts", "my-post-slug");

if (!post) {
	return Astro.redirect("/404");
}

Parameter

Der Vorschaumodus wird automatisch behandelt — die Middleware erkennt _preview-Tokens und liefert Entwurfsinhalte über AsyncLocalStorage. Der optionale options-Parameter akzeptiert nur ein locale für die Slug-Auflösung; der Vorschaustatus erfordert keinen Parameter.

Rückgabewert

Die Funktion löst sich zu einem EntryResult auf:

interface EntryResult<T> {
	entry: ContentEntry<T> | null; // null if not found
	error?: Error; // Set only for actual errors, not "not found"
	isPreview: boolean; // true if draft content is being served
}

Beispiele

Die folgenden Beispiele rufen nach Slug und ID ab, lesen den Vorschaustatus und unterscheiden Fehler von “nicht gefunden”:

// Get by slug
const { entry: post } = await getEmDashEntry("posts", "hello-world");

// Get by ID
const { entry: post } = await getEmDashEntry("posts", "01HXK5MZSN0FVXT2Q3KPRT9M7D");

// Preview is automatic — isPreview is true when a valid _preview token is present
const { entry, isPreview, error } = await getEmDashEntry("posts", slug);

// Handle errors vs not-found
if (error) {
	return new Response("Server error", { status: 500 });
}
if (!entry) {
	return Astro.redirect("/404");
}

Inhaltstypen

ContentEntry

Abfragefunktionen geben Einträge in der folgenden Form zurück:

interface ContentEntry<T = Record<string, unknown>> {
	id: string;
	data: T;
	edit: EditProxy; // Visual editing annotations
}

Der edit-Proxy bietet visuelle Bearbeitungsanmerkungen. Verteilen Sie ihn auf Elemente, um Inline-Bearbeitung zu ermöglichen: {...entry.edit.title}. In der Produktion erzeugt dies keine Ausgabe.

Das data-Objekt enthält alle Inhaltsfelder plus Systemfelder:

• id - Eindeutige Kennung
• slug - URL-freundliche Kennung
• status - “draft” | “published” | “archived”
• createdAt - ISO-Zeitstempel
• updatedAt - ISO-Zeitstempel
• publishedAt - ISO-Zeitstempel oder null
• Plus alle benutzerdefinierten Felder, die in Ihrem Sammlungsschema definiert sind

Vorschausystem

generatePreviewToken()

Generiert ein Vorschau-Token für Entwurfsinhalte. Das folgende Beispiel erstellt ein Token, das in einer Stunde abläuft:

import { generatePreviewToken } from "emdash";

const token = await generatePreviewToken({
	contentId: "posts:01HXK5MZSN...",
	secret: process.env.EMDASH_ADMIN_SECRET,
	expiresIn: 3600, // 1 hour
});

verifyPreviewToken()

Überprüft ein Vorschau-Token und liest seine Nutzlast:

import { verifyPreviewToken } from "emdash";

const result = await verifyPreviewToken({
	token,
	secret: process.env.EMDASH_ADMIN_SECRET,
});

if (result.valid) {
	const { cid, exp, iat } = result.payload;
	// cid is "collection:id" format, e.g. "posts:my-draft-post"
}

isPreviewRequest()

Prüft, ob eine Anfrage ein Vorschau-Token enthält, und liest es dann:

import { isPreviewRequest, getPreviewToken } from "emdash";

if (isPreviewRequest(Astro.url)) {
	const token = getPreviewToken(Astro.url);
	// Verify and show preview content
}

Inhaltskonverter

Konvertierung zwischen Portable Text und ProseMirror-Formaten:

import { prosemirrorToPortableText, portableTextToProsemirror } from "emdash";

// From ProseMirror (editor) to Portable Text (storage)
const portableText = prosemirrorToPortableText(prosemirrorDoc);

// From Portable Text to ProseMirror
const prosemirrorDoc = portableTextToProsemirror(portableText);

Site-Einstellungen

Lesen Sie seitenweite Einstellungen mit getSiteSettings und getSiteSetting:

import { getSiteSettings, getSiteSetting } from "emdash";

// Get all settings
const settings = await getSiteSettings();

// Get single setting
const title = await getSiteSetting("title");

Einstellungen sind über die Runtime-API schreibgeschützt. Verwenden Sie die Admin-API, um sie zu aktualisieren.

Menüs

Rufen Sie Navigationsmenüs ab und iterieren Sie über ihre Elemente, einschließlich verschachtelter Kinder:

import { getMenu, getMenus } from "emdash";

// Get all menus
const menus = await getMenus();

// Get specific menu with items
const primaryMenu = await getMenu("primary");

if (primaryMenu) {
	primaryMenu.items.forEach(item => {
		console.log(item.label, item.url);
		// Nested items for dropdowns
		item.children.forEach(child => console.log("  -", child.label));
	});
}

Taxonomien

Rufen Sie Taxonomie-Begriffe, einen einzelnen Begriff, die Begriffe eines Eintrags oder Einträge nach Begriff ab:

import { getTaxonomyTerms, getTerm, getEntryTerms, getEntriesByTerm } from "emdash";

// Get all terms for a taxonomy (tree structure for hierarchical)
const categories = await getTaxonomyTerms("category");

// Get single term
const news = await getTerm("category", "news");

// Get terms assigned to a content entry
const postCategories = await getEntryTerms("posts", "post-123", "category");

// Get entries with a specific term
const newsPosts = await getEntriesByTerm("posts", "category", "news");

Widget-Bereiche

Rufen Sie Widget-Bereiche und die darin enthaltenen Widgets ab:

import { getWidgetArea, getWidgetAreas } from "emdash";

// Get all widget areas
const areas = await getWidgetAreas();

// Get specific widget area with widgets
const sidebar = await getWidgetArea("sidebar");

if (sidebar) {
	sidebar.widgets.forEach(widget => {
		console.log(widget.type, widget.title);
	});
}

Abschnitte

Rufen Sie Abschnitte ab und filtern Sie sie:

import { getSection, getSections } from "emdash";

// Get all sections (paginated)
const { items, nextCursor } = await getSections();

// Filter sections
const { items: themeSections } = await getSections({ source: "theme" });
const { items: results } = await getSections({ search: "newsletter" });

// Get a single section by slug
const cta = await getSection("newsletter-cta");

getSections(options?) gibt { items: Section[]; nextCursor?: string } zurück. Optionen sind source ("theme" | "user" | "import"), search, limit (Standard 50, max 100) und cursor.

Suche

Führen Sie eine globale Suche über Sammlungen durch. Ergebnisse enthalten hervorgehobene Ausschnitte:

import { search } from "emdash";

const results = await search("hello world", {
	collections: ["posts", "pages"],
	status: "published",
	limit: 20,
});

// search() resolves to { items, nextCursor? }
results.items.forEach(result => {
	console.log(result.title);
	console.log(result.snippet); // Contains <mark> tags
	console.log(result.score);
});

Fehlerbehandlung

EmDash exportiert Fehlerklassen für die Behandlung spezifischer Fehler. Das folgende Beispiel fängt Validierungs- und Schema-Fehler ab:

import {
  EmDashDatabaseError,
  EmDashValidationError,
  EmDashStorageError,
  SchemaError,
} from "emdash";

try {
  await repo.create({ ... });
} catch (error) {
  if (error instanceof EmDashValidationError) {
    console.error("Validation failed:", error.message);
  }
  if (error instanceof SchemaError) {
    console.error("Schema error:", error.code, error.details);
  }
}