Riferimento API JavaScript

EmDash esporta funzioni per interrogare i contenuti e lavorare con anteprima, impostazioni, menu, tassonomie, aree widget, sezioni e ricerca.

Query sui contenuti

Le funzioni di query di EmDash seguono il pattern delle collezioni di contenuti live di Astro, restituendo { entries, error } o { entry, error } per una gestione elegante degli errori.

getEmDashCollection()

Recupera tutte le voci da una collezione. L’esempio seguente carica tutti i post e verifica la presenza di errori:

import { getEmDashCollection } from "emdash";

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

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

Parametri

Opzioni

Il parametro options accetta il seguente filtro:

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

Valore restituito

La funzione si risolve in un CollectionResult:

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

Esempi

I seguenti esempi filtrano per stato e tassonomia, limitano i risultati e gestiscono gli errori:

// 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()

Recupera una singola voce per slug o ID. L’esempio seguente carica un post e reindirizza quando manca:

import { getEmDashEntry } from "emdash";

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

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

Parametri

La modalità anteprima viene gestita automaticamente: il middleware rileva i token _preview e serve contenuti bozza tramite AsyncLocalStorage. Il parametro facoltativo options accetta solo un locale per la risoluzione dello slug; lo stato di anteprima non richiede parametri.

Valore restituito

La funzione si risolve in un EntryResult:

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
}

Esempi

I seguenti esempi recuperano per slug e ID, leggono lo stato di anteprima e distinguono gli errori da “non trovato”:

// 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");
}

Tipi di contenuto

ContentEntry

Le funzioni di query restituiscono voci nella seguente forma:

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

Il proxy edit fornisce annotazioni di modifica visiva. Distribuiscilo sugli elementi per abilitare la modifica inline: {...entry.edit.title}. In produzione, questo non produce output.

L’oggetto data contiene tutti i campi di contenuto più i campi di sistema:

• id - Identificatore univoco
• slug - Identificatore compatibile con URL
• status - “draft” | “published” | “archived”
• createdAt - Timestamp ISO
• updatedAt - Timestamp ISO
• publishedAt - Timestamp ISO o null
• Più tutti i campi personalizzati definiti nel tuo schema di collezione

Sistema di anteprima

generatePreviewToken()

Genera un token di anteprima per contenuti bozza. L’esempio seguente crea un token che scade tra un’ora:

import { generatePreviewToken } from "emdash";

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

verifyPreviewToken()

Verifica un token di anteprima e legge il suo payload:

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()

Verifica se una richiesta include un token di anteprima, quindi lo legge:

import { isPreviewRequest, getPreviewToken } from "emdash";

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

Convertitori di contenuto

Conversione tra formati Portable Text e ProseMirror:

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

Impostazioni del sito

Leggere le impostazioni a livello di sito con getSiteSettings e getSiteSetting:

import { getSiteSettings, getSiteSetting } from "emdash";

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

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

Le impostazioni sono di sola lettura dall’API di runtime. Utilizza l’API di amministrazione per aggiornarle.

Menu

Recuperare i menu di navigazione e iterare sui loro elementi, inclusi i figli nidificati:

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

Tassonomie

Recuperare i termini di tassonomia, un singolo termine, i termini di una voce o le voci per termine:

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");

Aree widget

Recuperare le aree widget e i widget che contengono:

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

Sezioni

Recuperare le sezioni e filtrarle:

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?) restituisce { items: Section[]; nextCursor?: string }. Le opzioni sono source ("theme" | "user" | "import"), search, limit (predefinito 50, max 100) e cursor.

Ricerca

Eseguire una ricerca globale nelle collezioni. I risultati includono estratti evidenziati:

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

Gestione degli errori

EmDash esporta classi di errore per gestire errori specifici. L’esempio seguente cattura errori di validazione e schema:

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