Module
@riducms/plugin
@riducms/plugin — Static Svelte 5 extension contracts for generated admins and plugin packages.
Functions 9
defineAdminPlugin()Preserve inference while declaring a statically bundled admin plugin.
defineFieldPlugin()Preserve inference while declaring a field renderer.
defineRowLabelPlugin()Preserve inference while declaring an array or blocks row-label component.
defineAdminMessages()Define an exact plugin-owned message catalog with build-time key and placeholder checks.
validateAdminMessages()Validate plugin message keys, translations, plural forms, and placeholders at runtime.
variable getAdminI18nRead the current admin localization context inside a Svelte plugin component.
variable setAdminI18nProvide the admin localization context to nested plugin components.
resolveAdminPluginPairs()Validate compiled backend/admin pairs and return frozen, collision-checked registrations.
resolveAdminPluginExtensions()Validate and flatten frontend extension registrations before the admin mounts.
Interfaces 46
interface AdminPlugininterface BackendAdminPlugininterface AdminPluginPairinterface ResolvedAdminPluginPairsinterface FieldPlugininterface FieldComponentPropsinterface RowLabelPlugininterface RowLabelComponentPropsinterface FieldForminterface FieldFormResourceinterface AdminI18ninterface DefineAdminMessagesInputinterface PluginMessageCataloginterface FieldAuthoringHostinterface FieldReferenceBrowserPropsinterface FieldReferenceFilterinterface AdminPluginRouteinterface AdminPluginNavigationinterface AdminDashboardPanelinterface AdminDashboardPanelPropsinterface AdminLoginComponentinterface AdminLoginComponentPropsinterface AdminLoginExtensionHostinterface AdminAccountComponentinterface AdminAccountComponentPropsinterface AdminAccountExtensionHostinterface AdminNavigationComponentinterface AdminNavigationComponentPropsinterface AdminLogoutButtoninterface AdminLogoutButtonPropsinterface AdminLogoutExtensionHostinterface AdminCoreViewPropsinterface AdminCoreViewHostinterface AdminBrandComponentinterface AdminBrandComponentPropsinterface AdminShellComponentinterface AdminShellComponentPropsinterface AdminProviderinterface AdminProviderPropsinterface AdminListCellinterface AdminListCellPropsinterface AdminDocumentActioninterface AdminDocumentViewinterface AdminDocumentExtensionPropsinterface AdminDocumentExtensionHostinterface AdminExtensionProps
Types 13
constant ADMIN_PLUGIN_API_VERSIONThe framework-owned admin extension API version.
type ResolvedAdminPluginExtensionsThe flattened extension registry without the original plugin and field arrays.
type RowLabelSnapshotA detached, recursively frozen snapshot of the current array or blocks row.
type RowLabelValueA recursively read-only JSON-like value available to row-label components.
type FieldDocumentThe authoring-safe document shape exposed to extension components.
type PluginTranslationKeyA namespaced plugin message key accepted by AdminI18n.t.
type AdminAccountSurfaceThe extensible account screen.
type AdminNavigationPositionThe composition point around framework navigation.
type AdminCoreViewSurfaceThe framework route surface exposed to a core-view extension.
type AdminCoreViewA replacement or wrapper for collection, global, or not-found routes.
type AdminBrandSurfaceAn exact framework branding location.
type AdminShellPositionAn exact global shell insertion point.
type AdminExtensionNotificationToneThe notification tones currently exposed to extensions.
Methods 47
AdminAccountComponent.component()AdminAccountComponentProps.defaultView()AdminAccountExtensionHost.logout()AdminAccountExtensionHost.notify()AdminAccountExtensionHost.refreshUser()AdminBrandComponent.component()AdminCoreViewHost.documentsChanged()AdminCoreViewHost.notify()AdminCoreViewHost.refreshManifest()AdminCoreViewProps.defaultView()AdminDashboardPanel.component()AdminDocumentAction.component()AdminDocumentExtensionHost.notify()AdminDocumentExtensionHost.refresh()AdminDocumentView.component()AdminI18n.formatDate()AdminI18n.formatList()AdminI18n.formatNumber()AdminI18n.formatRelativeTime()AdminI18n.t()AdminI18n.text()AdminListCell.component()AdminLoginComponent.component()AdminLoginComponentProps.defaultView()AdminLoginExtensionHost.login()AdminLoginExtensionHost.notify()AdminLogoutButton.component()AdminLogoutExtensionHost.logout()AdminNavigationComponent.component()AdminNavigationComponentProps.defaultView()AdminPluginRoute.component()AdminProvider.component()AdminProviderProps.defaultView()AdminShellComponent.component()FieldAuthoringHost.findDocument()FieldAuthoringHost.referenceBrowser()FieldAuthoringHost.requestPlugin()FieldForm.get()FieldForm.issuesFor()FieldForm.register()FieldForm.set()FieldForm.snapshot()FieldPlugin.canRender()FieldPlugin.component()FieldReferenceBrowserProps.onClose()FieldReferenceBrowserProps.onCommit()RowLabelPlugin.component()