Plugin Development

info

Plugin support is currently under development and in testing phase, the API may be subject to changes.

The RSD provides limited support for plugins, enabling third-party services to insert links into dedicated areas (plugin slots) within the user interface.

A simple example is available in research-software-directory/RSD-plugin-example.

Available plugin slots

Plugin slots are currently available in the user menu:

and at the bottom of the software edit navbar:

How plugins work

1. Next.js performs GET requests to all registered plugins, to the endpoints <baseUrl>/plugin/<plugin>/api/v1/config. The baseUrl is determined by the plugin name in settings.json. If a user is signed it, the token is sent in the header for authentication. The token contains a data attribute which can be used to determine which links should be displayed for each user. Users logged in via HelmholtzID have their eduPersonEntitlements delivered within the data attribute.
2. If necessary, the plugin backend verifies the user token.
3. The plugin backend returns a list of PluginSlot that need to be in the following format:

   type PluginSlot={
     slot: PluginSlot,
     icon: string,
     href: string,
     title: string,
     subtitle: string | null
   }
   where PluginSlotNames is:

   type PluginSlot = 'userMenu' | 'editSoftwareNav'
4. The plugin slots are stored in the global <RsdPluginContext> within the next app and can be accessed by the components.

Developing plugins

If the plugin requires a database, it can either use a new scheme in the existing database container, or provide its own.

If the plugin provides its own database and user authentication is required, the plugin backend needs access to the PGRST_JWT_SECRET so that it can verify the user token.

The backend of the plugin needs to be added to the reverse proxy configuration.