Collections et champs

Une collection est un type de contenu (articles, pages, produits). Ses définitions de champs déterminent la structure des données de chaque entrée.

Créer des collections

Créez des collections via le panneau d’administration sous Content Types. Chaque collection possède les propriétés suivantes :

Fonctionnalités de collection

Lors de la création d’une collection, activez les fonctionnalités dont vous avez besoin :

La collection suivante active les quatre fonctionnalités :

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

Types de champs

EmDash prend en charge 16 types de champs qui correspondent aux types de colonnes SQLite.

Champs texte

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

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

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

Contenu riche

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

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

Nombres

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

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

Booléens et dates

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

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

Sélection

{
  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édias et références

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

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

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

Propriétés des champs

Chaque champ prend en charge ces propriétés :

Définissez indexed: true lorsqu’une requête de collection doit utiliser un champ personnalisé dans orderBy ou un filtre de champ. Les index sont pris en charge pour les champs string, url, number, integer, boolean, datetime, select, reference et slug. EmDash rejette les champs JSON indexés, le contenu riche et les autres types de champs non scalaires.

Règles de validation

L’objet validation varie selon le type de champ. Sa forme complète est :

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

Le champ suivant nécessite une adresse e-mail unique et validée par motif :

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

Options de widget

L’objet options configure le comportement UI spécifique au champ. Sa forme complète est :

interface FieldWidgetOptions {
	rows?: number; // text (lignes de zone de texte)
	showPreview?: boolean; // image, file
	collection?: string; // reference (collection cible)
	allowMultiple?: boolean; // reference (refs multiples)
	[key: string]: unknown; // Options de widget personnalisées
}

Le champ de référence suivant lie à plusieurs produits :

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

Interroger les collections

Utilisez les fonctions de requête fournies pour récupérer le contenu. Celles-ci suivent le modèle de collections en direct d’Astro, retournant des résultats structurés. L’exemple suivant montre les options de requête courantes :

import { getEmDashCollection, getEmDashEntry } from "emdash";

// Obtenir toutes les entrées - retourne { entries, error }
const { entries: posts } = await getEmDashCollection("posts");

// Filtrer par statut
const { entries: drafts } = await getEmDashCollection("posts", {
	status: "draft",
});

// Limiter les résultats
const { entries: recent } = await getEmDashCollection("posts", {
	limit: 5,
});

// Filtrer par taxonomie
const { entries: newsPosts } = await getEmDashCollection("posts", {
	where: { category: "news" },
});

// Obtenir une entrée par slug - retourne { entry, error, isPreview }
const { entry: post } = await getEmDashEntry("posts", "my-post-slug");

// Gestion des erreurs
const { entries, error } = await getEmDashCollection("posts");
if (error) {
	console.error("Failed to load posts:", error);
}

Génération de types

Exécutez npx emdash types pour générer des types TypeScript depuis votre schéma. Le fichier généré contient une interface par collection :

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

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

Correspondance base de données

Les types de champs correspondent aux types de colonnes SQLite comme suit :

Prochaines étapes