Colecciones y campos

Una colección es un tipo de contenido (publicaciones, páginas, productos). Sus definiciones de campo establecen la estructura de los datos de cada entrada.

Crear colecciones

Crea colecciones a través del panel de administración en Content Types. Cada colección tiene las siguientes propiedades:

Características de colección

Al crear una colección, habilita las características que necesites:

La siguiente colección habilita las cuatro características:

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

Tipos de campo

EmDash soporta 16 tipos de campo que se mapean a tipos de columna SQLite.

Campos de texto

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

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

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

Contenido enriquecido

{ 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 y fechas

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

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

Selección

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

Medios y referencias

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

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

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

Propiedades de campo

Cada campo soporta estas propiedades:

Establece indexed: true cuando una consulta de colección necesite usar un campo personalizado en orderBy o un filtro de campo. Los índices son compatibles con campos string, url, number, integer, boolean, datetime, select, reference y slug. EmDash rechaza campos JSON indexados, contenido enriquecido y otros tipos de campo no escalares.

Reglas de validación

El objeto validation varía según el tipo de campo. Su forma completa es:

interface FieldValidation {
	required?: boolean; // Todos los 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
}

El siguiente campo requiere una dirección de correo electrónico única y validada por patrón:

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

Opciones de widget

El objeto options configura el comportamiento de UI específico del campo. Su forma completa es:

interface FieldWidgetOptions {
	rows?: number; // text (filas del área de texto)
	showPreview?: boolean; // image, file
	collection?: string; // reference (colección destino)
	allowMultiple?: boolean; // reference (múltiples refs)
	[key: string]: unknown; // Opciones de widget personalizadas
}

El siguiente campo de referencia enlaza a múltiples productos:

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

Consultar colecciones

Usa las funciones de consulta proporcionadas para obtener contenido. Estas siguen el patrón de colecciones en vivo de Astro, devolviendo resultados estructurados. El siguiente ejemplo muestra las opciones de consulta comunes:

import { getEmDashCollection, getEmDashEntry } from "emdash";

// Obtener todas las entradas - devuelve { entries, error }
const { entries: posts } = await getEmDashCollection("posts");

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

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

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

// Obtener una entrada por slug - devuelve { entry, error, isPreview }
const { entry: post } = await getEmDashEntry("posts", "my-post-slug");

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

Generación de tipos

Ejecuta npx emdash types para generar tipos TypeScript desde tu esquema. El archivo generado contiene una interfaz por colección:

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

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

Mapeo de base de datos

Los tipos de campo se mapean a tipos de columna SQLite de la siguiente manera:

Próximos pasos