plugin sdk
Build extensions for the DSUI workspace.
A plugin adds workspace features across services: pages, navigation, UI slots, operations, background jobs and storage. An adapter connects one external system; a plugin composes capabilities across the installation.
Plugins are trusted server code. DSUI validates inputs and enforces request permissions, but a plugin runs inside the server process.
| Primitive | Purpose | Guide |
|---|---|---|
| Plugin | Identity, configuration and lifecycle | Create a plugin |
| Page and slot | Routes and contributions to host UI | Pages and slots |
| Resource | Read data with a refresh policy | Resources |
| Procedure and action | Validated operations | Actions and procedures |
| Job | Durable background work | Jobs |
| Signal | Typed events and event reading | Signals |
| Store and storage | JSON state and private SQLite databases | Stores and storage |
| Host capabilities | Service access and authorization | Host capabilities |
Start with create a plugin, then add the capabilities your extension needs. See testing and release before distributing it.
The public package is @northgraindata/dsui-plugin-sdk. Shared page components
are re-exported from the Adapter SDK, so both extension types use the same
component vocabulary.