Referência da API JavaScript

EmDash exporta funções para consultar conteúdo e trabalhar com visualização prévia, configurações, menus, taxonomias, áreas de widgets, seções e pesquisa.

Consultas de conteúdo

As funções de consulta do EmDash seguem o padrão de coleções de conteúdo ao vivo do Astro, retornando { entries, error } ou { entry, error } para tratamento elegante de erros.

getEmDashCollection()

Busca todas as entradas de uma coleção. O exemplo a seguir carrega todas as postagens e verifica erros:

import { getEmDashCollection } from "emdash";

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

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

Parâmetros

Opções

O parâmetro options aceita o seguinte filtro:

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

Valor de retorno

A função resolve para um CollectionResult:

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

Exemplos

Os exemplos a seguir filtram por status e taxonomia, limitam resultados e tratam erros:

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

Busca uma única entrada por slug ou ID. O exemplo a seguir carrega uma postagem e redireciona quando está ausente:

import { getEmDashEntry } from "emdash";

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

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

Parâmetros

O modo de visualização prévia é tratado automaticamente — o middleware detecta tokens _preview e serve conteúdo de rascunho via AsyncLocalStorage. O parâmetro opcional options aceita apenas um locale para resolução de slug; o estado de visualização prévia não requer parâmetro.

Valor de retorno

A função resolve para um 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
}

Exemplos

Os exemplos a seguir buscam por slug e ID, leem o estado de visualização prévia e distinguem erros de “não encontrado”:

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

Tipos de conteúdo

ContentEntry

As funções de consulta retornam entradas na seguinte forma:

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

O proxy edit fornece anotações de edição visual. Distribua-o em elementos para habilitar edição inline: {...entry.edit.title}. Em produção, isso não produz saída.

O objeto data contém todos os campos de conteúdo mais campos do sistema:

• id - Identificador único
• slug - Identificador amigável para URL
• status - “draft” | “published” | “archived”
• createdAt - Timestamp ISO
• updatedAt - Timestamp ISO
• publishedAt - Timestamp ISO ou null
• Mais todos os campos personalizados definidos no seu esquema de coleção

Sistema de visualização prévia

generatePreviewToken()

Gera um token de visualização prévia para conteúdo de rascunho. O exemplo a seguir cria um token que expira em uma hora:

import { generatePreviewToken } from "emdash";

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

verifyPreviewToken()

Verifica um token de visualização prévia e lê sua carga útil:

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 uma requisição inclui um token de visualização prévia e então o lê:

import { isPreviewRequest, getPreviewToken } from "emdash";

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

Conversores de conteúdo

Converter entre formatos 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);

Configurações do site

Ler configurações de todo o site com getSiteSettings e getSiteSetting:

import { getSiteSettings, getSiteSetting } from "emdash";

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

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

As configurações são somente leitura da API de tempo de execução. Use a API de administração para atualizá-las.

Menus

Buscar menus de navegação e iterar sobre seus itens, incluindo filhos aninhados:

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

Taxonomias

Buscar termos de taxonomia, um termo único, os termos de uma entrada ou entradas por termo:

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

Áreas de widgets

Buscar áreas de widgets e os widgets que elas contêm:

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

Seções

Buscar seções e filtrá-las:

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?) retorna { items: Section[]; nextCursor?: string }. As opções são source ("theme" | "user" | "import"), search, limit (padrão 50, máximo 100) e cursor.

Pesquisa

Executar uma pesquisa global em coleções. Os resultados incluem trechos destacados:

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

Tratamento de erros

EmDash exporta classes de erro para lidar com falhas específicas. O exemplo a seguir captura erros de validação e esquema:

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