Pluginsystem

Überblick

Plugins sind der primäre Erweiterungsmechanismus in Rebase. Sie können:

• Die gesamte App mit einem Provider (Kontext, Zustandsverwaltung) umschließen
• Homepage-Aktionen und Widgets hinzufügen
• Sammlungsansichts-Komponenten injizieren (Toolbar, Spalten-Builder)
• Formular-Komponenten hinzufügen (Feld-Builder, zusätzliche Panels)
• Sammlungen dynamisch injizieren oder modifizieren

Plugin-Schnittstelle

interface RebasePlugin {
    key: string;                    // Unique identifier
    loading?: boolean;              // Show loading state while initializing

    // Wrap the app with a provider
    provider?: {
        Component: React.ComponentType;
    };

    // Home page customization
    homePage?: {
        additionalActions?: React.ReactNode;
        additionalChildrenStart?: React.ReactNode;
        additionalChildrenEnd?: React.ReactNode;
    };

    // Collection view customization
    collectionView?: {
        showTextSearchBar?: boolean;
        CollectionActions?: React.ComponentType[];
        AddColumnComponent?: React.ComponentType;
        onCellValueChange?: (params) => void;
    };

    // Entity form customization
    form?: {
        Actions?: React.ComponentType;
        provider?: { Component: React.ComponentType };
        fieldBuilder?: (params) => React.ReactNode | null;
    };

    // Collection injection/modification
    collection?: {
        injectCollections?: (params) => EntityCollection[];
        modifyCollection?: (params) => EntityCollection;
    };
}

Verwendung von Plugins

Übergeben Sie Plugin-Instanzen an den Navigations-Controller:

const dataEnhancementPlugin = useDataEnhancementPlugin();

const plugins = [dataEnhancementPlugin];

const navigationStateController = useBuildNavigationStateController({
    plugins,
    collections: () => collections,
    // ...
});

Erstellen eines Plugins

Hier ist ein minimales Plugin, das jeder Sammlung eine Toolbar-Aktion hinzufügt:

import { RebasePlugin } from "@rebasepro/types";

function useMyPlugin(): RebasePlugin {
    return {
        key: "my_plugin",

        collectionView: {
            CollectionActions: [MyToolbarAction]
        },

        form: {
            fieldBuilder: ({ property, ...rest }) => {
                // Return a custom field for specific property configs
                if (property.propertyConfig === "my_custom_field") {
                    return <MyCustomField {...rest} />;
                }
                return null; // Use default field
            }
        }
    };
}

Integrierte Plugins

Daten-Enhancement-Plugin

KI-gestützte Feld-Autovervollständigung:

import { useDataEnhancementPlugin } from "@rebasepro/data_enhancement";

const enhancementPlugin = useDataEnhancementPlugin();

Sammlungs-Injektion

Plugins können dynamisch neue Sammlungen hinzufügen:

collection: {
    injectCollections: ({ collections, user }) => {
        // Add an audit log collection for admins
        if (user?.roles?.includes("admin")) {
            return [auditLogCollection];
        }
        return [];
    }
}

Sammlungs-Modifikation

Plugins können bestehende Sammlungen modifizieren:

collection: {
    modifyCollection: ({ collection }) => {
        // Add a "last_modified_by" field to every collection
        return {
            ...collection,
            properties: {
                ...collection.properties,
                last_modified_by: {
                    type: "string",
                    name: "Modified By",
                    readOnly: true
                }
            }
        };
    }
}

Nächste Schritte

• Studio-Tools — SQL-Konsole, JS-Konsole, RLS-Editor
• Benutzerdefinierte Felder — Erstellen von benutzerdefinierten Formularfeldern

---