Discord Sync

Über

Das Plugin zieht Guilds, Channels, Mitglieder und Rollen aus Discord über discord.js in Payload-Kollektionen. Der Bot-Token verbindet den Client. Synchronisationen lassen sich aus dem Admin-Panel starten, über eine programmatische API, einen HTTP-Endpunkt oder zeitgesteuert über Payload-Jobs auslösen. Jedes synchronisierte Dokument speichert einen Snapshot der Discord-Daten im Feld `raw` sowie einen Zeitstempel `lastSyncedAt`. Die Daten lassen sich damit wie jeder andere Payload-Inhalt abfragen und anzeigen. Standardmäßig registriert das Plugin vier Kollektionen: `discord-guilds`, `discord-channels`, `discord-members` und `discord-roles`. Jede Ressource lässt sich über die Option `resources` deaktivieren, umbenennen oder um eigene Felder erweitern. Mit dem Hook `collectionOverride` kann die gesamte Kollektionskonfiguration ersetzt werden. Für die Mitglieds-Synchronisation muss der Server Members Intent im Bot aktiviert sein. Die Option `linkUsers` verknüpft Discord-Mitglieder mit der Auth- oder Users-Kollektion. Sie fügt ein Feld `discordId` ein, setzt eine Relation auf Members und kann während der Synchronisation automatisch nach Discord-ID oder E-Mail-Adresse verlinken. Die Hilfsfunktion `linkDiscordUser` übernimmt das programmatische Verlinken nach einem Discord-OAuth-Flow, `unlinkDiscordUser` hebt die Verknüpfung wieder auf. Das Plugin lauscht nicht auf Live-Gateway-Events wie `guildUpdate` oder `channelUpdate`. Die Daten entsprechen dem Stand zum Zeitpunkt der letzten Synchronisation, nicht dem aktuellen Discord-Zustand. Zeitgesteuerte Synchronisationen registrieren einen Task `discordSync` auf einer Queue `discord-sync` mit konfigurierbarem Cron-Intervall, standardmäßig alle sechs Stunden.

Paketinformationen

Paketname

@lizardglobal/payload-discord-sync

Neueste Version

0.1.7

Entpackte Größe

181 kB

Lizenz

MIT

Wöchentliche Downloads

2

Zuletzt veröffentlicht

27. Juli 2026