Coleções e campos

Uma coleção é um tipo de conteúdo (publicações, páginas, produtos). Suas definições de campo definem a estrutura dos dados de cada entrada.

Criando coleções

Crie coleções através do painel de administração em Content Types. Cada coleção tem as seguintes propriedades:

Funcionalidades de coleção

Ao criar uma coleção, ative as funcionalidades que você precisa:

A seguinte coleção ativa todas as quatro funcionalidades:

{
  slug: "posts",
  label: "Blog Posts",
  labelSingular: "Post",
  supports: ["drafts", "revisions", "preview", "scheduling"]
}

Tipos de campo

EmDash suporta 16 tipos de campo que mapeiam para tipos de coluna SQLite.

Campos de texto

{ slug: "title", type: "string", label: "Title" }

{ slug: "excerpt", type: "text", label: "Excerpt" }

{ slug: "handle", type: "slug", label: "URL Handle" }

Conteúdo rico

{ slug: "content", type: "portableText", label: "Content" }

{ slug: "metadata", type: "json", label: "Custom Metadata" }

Números

{ slug: "price", type: "number", label: "Price" }

{ slug: "quantity", type: "integer", label: "Stock Quantity" }

Booleanos e datas

{ slug: "featured", type: "boolean", label: "Featured Post" }

{ slug: "eventDate", type: "datetime", label: "Event Date" }

Seleção

{
  slug: "status",
  type: "select",
  label: "Product Status",
  validation: {
    options: ["active", "discontinued", "coming_soon"]
  }
}

{
  slug: "features",
  type: "multiSelect",
  label: "Product Features",
  validation: {
    options: ["wireless", "waterproof", "eco-friendly"]
  }
}

Mídia e referências

{ slug: "featuredImage", type: "image", label: "Featured Image" }

{ slug: "attachment", type: "file", label: "PDF Attachment" }

{
  slug: "author",
  type: "reference",
  label: "Author",
  options: {
    collection: "authors"
  }
}

Propriedades de campo

Todo campo suporta estas propriedades:

Defina indexed: true quando uma consulta de coleção precisar usar um campo personalizado em orderBy ou um filtro de campo. Índices são suportados para campos string, url, number, integer, boolean, datetime, select, reference e slug. EmDash rejeita campos JSON indexados, conteúdo rico e outros tipos de campo não escalares.

Regras de validação

O objeto validation varia por tipo de campo. Sua forma completa é:

interface FieldValidation {
	required?: boolean; // Todos os tipos
	min?: number; // number, integer
	max?: number; // number, integer
	minLength?: number; // string, text
	maxLength?: number; // string, text
	pattern?: string; // string (regex)
	options?: string[]; // select, multiSelect
}

O seguinte campo requer um endereço de email único e validado por padrão:

{
  slug: "email",
  type: "string",
  label: "Email Address",
  required: true,
  unique: true,
  validation: {
    pattern: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
  }
}

Opções de widget

O objeto options configura o comportamento de UI específico do campo. Sua forma completa é:

interface FieldWidgetOptions {
	rows?: number; // text (linhas da área de texto)
	showPreview?: boolean; // image, file
	collection?: string; // reference (coleção de destino)
	allowMultiple?: boolean; // reference (múltiplas refs)
	[key: string]: unknown; // Opções de widget personalizadas
}

O seguinte campo de referência vincula a múltiplos produtos:

{
  slug: "relatedProducts",
  type: "reference",
  label: "Related Products",
  options: {
    collection: "products",
    allowMultiple: true
  }
}

Consultando coleções

Use as funções de consulta fornecidas para buscar conteúdo. Estas seguem o padrão de coleções ao vivo do Astro, retornando resultados estruturados. O seguinte exemplo mostra as opções de consulta comuns:

import { getEmDashCollection, getEmDashEntry } from "emdash";

// Obter todas as entradas - retorna { entries, error }
const { entries: posts } = await getEmDashCollection("posts");

// Filtrar por status
const { entries: drafts } = await getEmDashCollection("posts", {
	status: "draft",
});

// Limitar resultados
const { entries: recent } = await getEmDashCollection("posts", {
	limit: 5,
});

// Filtrar por taxonomia
const { entries: newsPosts } = await getEmDashCollection("posts", {
	where: { category: "news" },
});

// Obter uma entrada por slug - retorna { entry, error, isPreview }
const { entry: post } = await getEmDashEntry("posts", "my-post-slug");

// Tratamento de erros
const { entries, error } = await getEmDashCollection("posts");
if (error) {
	console.error("Failed to load posts:", error);
}

Geração de tipos

Execute npx emdash types para gerar tipos TypeScript a partir do seu schema. O arquivo gerado contém uma interface por coleção:

export interface Post {
	title: string;
	content: PortableTextBlock[];
	excerpt?: string;
	featuredImage?: string;
	author: string; // ID de referência
}

export interface Product {
	title: string;
	price: number;
	description: PortableTextBlock[];
}

Mapeamento de banco de dados

Tipos de campo mapeiam para tipos de coluna SQLite da seguinte forma:

Próximos passos