Sammlungen

Was ist eine Sammlung?

Eine Sammlung ist ein TypeScript-Objekt, das eine Datenbanktabelle beschreibt und wie diese in der Admin-Benutzeroberfläche erscheinen soll. Sie definiert:

• Schema – Eigenschaften (Spalten), deren Typen und Validierungsregeln
• Relationen – Fremdschlüssel, Verknüpfungstabellen und Join-Pfade
• Sicherheit – Row Level Security-Richtlinien
• UI-Verhalten – Ansichtsmodi, Inline-Bearbeitung, Entitätsansichten, Aktionen
• Lebenszyklus-Hooks – Callbacks für Erstellungs-, Aktualisierungs- und Löschvorgänge

import { defineCollection } from "@rebasepro/cms-types";

export const productsCollection = defineCollection({
    slug: "products",              // URL path and API endpoint
    name: "Products",              // Display name (plural)
    singularName: "Product",       // Display name (singular)
    table: "products",            // PostgreSQL table name

    properties: {
        name: {
            type: "string",
            name: "Product Name",
            validation: { required: true }
        },
        price: {
            type: "number",
            name: "Price",
            validation: { required: true, min: 0 }
        },
        category: {
            type: "string",
            name: "Category",
            enum: [
                { id: "electronics", label: "Electronics", color: "blue" },
                { id: "clothing", label: "Clothing", color: "pink" },
                { id: "books", label: "Books", color: "orange" }
            ]
        },
        description: {
            type: "string",
            name: "Description",
            admin: { multiline: true }
        },
        active: {
            type: "boolean",
            name: "Active",
            defaultValue: true
        },
        createdAt: {
            type: "date",
            name: "Created At",
            autoValue: "on_create",
            readOnly: true
        }
    },
    admin: {
        icon: "inventory_2"           // Material icon key
    }
});

Eine Sammlung deklarieren: defineCollection

Umschließen Sie das Literal mit defineCollection. Zur Laufzeit ist es die Identitätsfunktion — es gibt das Objekt unverändert zurück und kostet daher nichts. Was es bringt, ist Inferenz: ein const-Typparameter erfasst Ihre properties-Schlüssel als Literaltypen, wodurch sie in der Editor-Vervollständigung für admin.display, admin.sort und admin.propertiesOrder erscheinen.

import { defineCollection } from "@rebasepro/cms-types";

const products = defineCollection({
    name: "Products",
    slug: "products",
    table: "products",
    properties: {
        name: { name: "Name", type: "string" },
        price: { name: "Price", type: "number" }
    },
    admin: {
        display: { title: "name" },   // Vervollständigung: "name" | "price"
        sort: ["price", "asc"]   // Vervollständigung beim ersten Element
    }
});

Importieren Sie es in einem Projekt mit Admin-Panel aus @rebasepro/cms-types — das ist die Variante, die auch den admin-Block typprüft. Ein Headless-BaaS-Projekt ohne admin-Block und ohne React importiert dieselbe Funktion stattdessen aus @rebasepro/common.

Den Typ direkt zu annotieren funktioniert weiterhin und wird weiterhin geprüft:

import type { PostgresCollectionConfig } from "@rebasepro/types";

const products: PostgresCollectionConfig = {
    name: "Products",
    slug: "products",
    table: "products",
    properties: {
        name: { name: "Name", type: "string" }
    }
};

Eine Annotation validiert das Objekt jedoch nur — sie kann Ihre Eigenschaftsnamen nicht sehen, Sie erhalten also keine Vervollständigung. Bevorzugen Sie defineCollection, sofern Sie den Typ nicht benennen müssen.

Hinweis

buildCollection und buildProperty existieren nicht mehr. buildCollection ist defineCollection ohne die Inferenz; buildProperty umhüllte eine Eigenschaft mit einem Typ, den sie bereits hatte. Siehe das Changelog für die einzeilige Migration.

Haupteigenschaften

Identifikation

Eigenschaft	Typ	Beschreibung
slug	string	Erforderlich. URL-sicherer Bezeichner. Wird in der Admin-UI-URL und im REST-API-Pfad (/api/data/{slug}) verwendet.
name	string	Erforderlich. Anzeigename (Plural). Wird in der Navigation und in Seitenüberschriften angezeigt.
singularName	string	Anzeigename für eine einzelne Entität. Wird in „Neues Produkt“, „Produkt bearbeiten“ usw. verwendet.
table	string	Erforderlich. PostgreSQL-Tabellenname. Wenn er sich vom slug unterscheidet, können URLs von Tabellennamen entkoppelt werden.
admin.icon	string	Material-Icon-Schlüssel. Siehe Google Fonts Icons.

Schema

Eigenschaft	Typ	Beschreibung
properties	Properties	Erforderlich. Abbildung von Eigenschaftsschlüssel → Eigenschaftsdefinition. Jeder Schlüssel wird zu einer Datenbankspalte.
relations	Relation[]	SQL-Relationen – Fremdschlüssel, Verknüpfungstabellen. Siehe Relationen.
securityRules	SecurityRule[]	Row Level Security-Richtlinien. Siehe Sicherheitsregeln.
indexes	CollectionIndex[]	Postgres-Indizes, die diese Tabelle braucht. Siehe Indizes.
search	SearchConfig	Gerankte Volltextsuche über die von Ihnen benannten Felder, einschließlich JSONB- und Array-Inhalten. Nur Postgres. Siehe Suche.
auth	boolean | AuthCollectionConfig	Die Sammlung als Authentifizierungs-Sammlung kennzeichnen (Benutzerverwaltung, Passwort zurücksetzen usw.)

UI-Konfiguration

Alle folgenden Felder gehören in admin.

Eigenschaft	Typ	Standard	Beschreibung
defaultViewMode	"list" | "table" | "cards" | "kanban"	"table"	Standardansichtsmodus
enabledViews	ViewMode[]	Alle vier	Welche Ansichtsmodi verfügbar sind
kanban	KanbanConfig	—	Kanban-Konfiguration (Spalteneigenschaft). Immer zusammen mit orderProperty angeben — siehe Ansichtsmodi
orderProperty	string	—	Schlüssel der string-Eigenschaft, die den Drag-and-drop-Sortierschlüssel hält. Für ein funktionierendes Kanban-Board erforderlich
openEntityMode	"side_panel" | "full_screen" | "split"	"full_screen"	Wie Entitäten zur Bearbeitung geöffnet werden
sideDialogWidth	number | string	—	Breite des Seitendialogs
inlineEditing	boolean	true	Inline-Bearbeitung in der Tabellenansicht aktivieren
defaultSize	"xs" | "s" | "m" | "l" | "xl"	"m"	Standardzeilenhöhe in der Tabelle
pagination	boolean | number	true (50)	Paginierung aktivieren und/oder Seitengröße festlegen
listProperties	string[]	—	Eigenschaften, die in der Listenansicht angezeigt werden sollen
propertiesOrder	string[]	—	Spaltenreihenfolge in der Tabellenansicht
selectionEnabled	boolean	true	Zeilenauswahl aktivieren
hideFromNavigation	boolean	false	Aus der Sidebar-Navigation ausblenden
defaultSelectedView	string | function	—	Standardansicht oder Unterkollektion, die geöffnet werden soll

Entitätsoptionen

Innerhalb von admin, außer history — das ist eine Backend-Funktion und bleibt auf oberster Ebene.

Eigenschaft	Typ	Standard	Beschreibung
formAutoSave	boolean	false	Automatisches Speichern bei Feldänderung
localChangesBackup	"manual_apply" | "auto_apply" | false	"manual_apply"	Ungespeicherte Änderungen sichern
hideIdFromForm	boolean	false	Die Entitäts-ID aus dem Formular ausblenden
hideIdFromCollection	boolean	false	Die ID-Spalte aus der Tabelle ausblenden
includeJsonView	boolean	true	Die Rohwerte im Datensatz-Inspektor anbieten
history	boolean	false	Änderungen in der Entitätshistorie verfolgen
alwaysApplyDefaultValues	boolean	false	Standardwerte bei jedem Speichern anwenden
previewProperties	string[]	—	Eigenschaften, die in Referenzvorschauen angezeigt werden sollen
display	EntityDisplay	—	Was jede Anzeigerolle füllt — title, subtitle, image, status, date, tags

Erweitert

Eigenschaft	Typ	Beschreibung
callbacks	CollectionCallbacks	Lebenszyklus-Hooks (beforeSave, afterSave, beforeDelete, etc.)
entityActions	EntityAction[]	Benutzerdefinierte Aktionen für Entitäten (archivieren, veröffentlichen usw.)
Actions	React.ComponentType	Benutzerdefinierte Symbolleisten-Aktionskomponente
entityViews	EntityCustomView[]	Benutzerdefinierte Tabs in der Entitätsdetailansicht
additionalFields	AdditionalFieldDelegate[]	Berechnete/virtuelle Spalten
childCollections	() => CollectionConfig[]	Verschachtelte Kindersammlungen
subcollections	() => CollectionConfig[]	Verschachtelte Sammlungen (z.B. Bestellung → Posten)
exportable	boolean | ExportConfig	Datenexport aktivieren
ownerId	string	Besitzer-Benutzer-ID (von Plugins/benutzerdefiniertem Code verwendet)
overrides	EntityOverrides	Overrides für die Entitätsansicht
driver	string	Zu verwendender Datenbanktreiber (Standard: "(default)")
databaseId	string	Datenbank-/Schema-ID innerhalb des Treibers

Sammlungs-Builder

Für dynamische Sammlungen, die sich basierend auf dem Benutzer oder externen Daten ändern, verwenden Sie eine Builder-Funktion:

const collectionsBuilder: CollectionConfigsBuilder = ({ user, authController }) => {
    const collections = [productsCollection];

    if (authController.extra?.role === "admin") {
        collections.push(adminSettingsCollection);
    }

    return collections;
};

Filtern und Sortieren

Sie können Standard- oder erzwungene Filter festlegen:

{
    // Default filter — users can change it
    filter: { active: ["==", true] },

    // Forced filter — cannot be changed
    forceFilter: { tenant_id: ["==", currentTenantId] },

    // Default sort
    sort: ["createdAt", "desc"]
}

Nächste Schritte

• Entitäts-Callbacks – Lebenszyklus-Hooks zum Synchronisieren von Daten zwischen Sammlungen, Validierung, Nebenwirkungen
• Eigenschaften – Alle Eigenschaftstypen und Optionen
• Relationen – Fremdschlüssel, Verknüpfungstabellen, Joins
• Sicherheitsregeln – Row Level Security
• Ansichtsmodi – Liste, Tabelle, Karten, Kanban