@antelopejs/dms-database

Database administration for AntelopeJS DMS. The module uses the Database interface to provide health and schema overviews, schema and table inspection, data browsing, a schema diagram, and an AQL query workspace under /modules/database.

Installation

Add the module to a project that already uses @antelopejs/dms and a Database implementation:

ajs project modules add @antelopejs/dms-database

Configuration

Configuration is optional. driverLabel supplies the database name shown in the health overview; the Database interface cannot discover it. schemaLabels overrides labels for exact schema IDs or glob patterns containing *.

config: {
  driverLabel: "MongoDB 8.0",
  schemaLabels: {
    "app-*": { label: "Application", color: "info" },
  },
}

Development

pnpm install
pnpm build
pnpm test

The module registers its Vue 3 Inertia frontend through frontend-vue/dms.frontend.ts. The adapter discovers composables and locale files from this directory; Nuxt is not required.

Run pnpm --dir frontend-vue install and pnpm --dir frontend-vue test for frontend tests. Set DMS_FRONTEND_WORKSPACE to a generated Inertia workspace before running pnpm --dir frontend-vue typecheck.

Run DMS_SOURCE=/absolute/path/to/dms pnpm test to test a local DMS runtime with disposable MongoDB and filesystem storage. Only the test harness loads the runtime; the types come from @antelopejs/interface-dms, so pnpm typecheck is unaffected by that path.