n8n/packages/frontend/@n8n/frontend-module-sdk

@n8n/frontend-module-sdk

The frontend module contract and registries for n8n editor modules.

This package owns the FrontendModuleDescription descriptor type plus the modal and resource registries that features register against. The editor shell keeps the wiring (moduleInitializer) that drives the two-phase lifecycle; this package only defines the contract and the registry state.

It is a source-only package (no build step): consumers resolve it from src via the editor-ui Vite alias and tsconfig paths, and src/index.ts is the only public entry point.

import { modalRegistry, registerResource, type FrontendModuleDescription } from '@n8n/frontend-module-sdk';