@heswell/module-admin
v2.3.0
Published
Reusable VUU module-administration module
Readme
@heswell/module-admin
@heswell/module-admin is the browser-safe home for reusable VUU module
administration functionality.
| Import | Use |
| --- | --- |
| @heswell/module-admin | Module-admin contract and helpers. |
| @heswell/module-admin/contracts | The same contracts, as a focused entry point. |
It exports the module-admin RPC contract. The default module catalog is not part of this package; the portal seeds it from default-modules.yaml. The contract includes ModuleConfig, ManagedModule, ModuleConfigChanges, MODULE_ADMIN_RPC, MODULE_ADMIN_RPC_CONTRACT, parse/validate helpers, pure RPC operation helpers (executeModuleAdminRpc and per-RPC functions), access-role helpers, and projections for managed module and permission rows. Server table wiring and YAML persistence deliberately remain portal-specific.
ManagedModule and ModuleConfig have an optional workspace descriptor
({ paletteGroup, iconUrl?, defaultSize?: { cols?, rows? } }). A module that
has one is listed in the portal's Panels palette and can be placed in a
workspace. Leave it out for modules that only work inside their parent. In
the modules table it is a JSON string column; use
serializeModuleWorkspace and deserializeModuleWorkspace to convert it.
updateModule replaces the whole descriptor, and null clears it.
validateModuleConfig requires location and path for a top-level module
unless it has workspace metadata: a top-level module with workspace may
leave both empty to be palette-only (no nav entry or route). A location, when
given, still needs a path. Child modules are unchanged. See
Workspace metadata.
Publishing
Build all publishable packages with:
npm run build:packagesBuild only this package with:
npm run build:packages -- --package=@heswell/module-adminBump this package and any workspace dependants with:
npm run bump:versions -- --package=@heswell/module-adminPublish it from dist/module-admin with:
npm run pub -- --package=@heswell/module-adminAdd --dry-run to validate the package or --version-check to inspect its
version and npm dist-tags.
