@antelopejs/dms-database 0.1.2 → 0.2.1

package/frontend-vue/vitest.config.ts

@@ -1,5 +1,29 @@
+import { resolve } from 'node:path'
+import vue from '@vitejs/plugin-vue'
 import { defineConfig } from 'vitest/config'
 
+// The renderer and the DMS core layer the server-render tests run on: the
+// ones the repository installs at its root (`@antelopejs/dms-frontend`,
+// `@antelopejs/dms`), as `pnpm test:frontend` builds against them.
+const root = resolve(__dirname, '..', 'node_modules', '@antelopejs')
+
 export default defineConfig({
+	plugins: [vue()],
+	resolve: {
+		alias: {
+			'#dms/frontend-module': resolve(
+				root,
+				'dms-frontend/templates/vue/frontend-module.ts',
+			),
+			'#dms-core': resolve(root, 'dms/frontend-vue/layers/dms-core'),
+			// The renderer's own imports, from this package's dependencies: one
+			// Vue for the renderer and the components.
+			vue: resolve(__dirname, 'node_modules/vue'),
+			'@unhead/vue': resolve(__dirname, 'node_modules/@unhead/vue'),
+			// What the renderer reads of Inertia and vue-i18n in the browser only.
+			'@inertiajs/vue3': resolve(__dirname, 'tests/fixtures/inertia.ts'),
+			'vue-i18n': resolve(__dirname, 'tests/fixtures/vueI18n.ts'),
+		},
+	},
 	test: { environment: 'node', include: ['tests/**/*.test.ts'] },
 })

package/package.json

@@ -1,6 +1,19 @@
 {
   "name": "@antelopejs/dms-database",
-  "version": "0.1.2",
+  "version": "0.2.1",
+  "description": "Database console for the AntelopeJS DMS: schemas, relation diagrams, a data browser and an AQL query console.",
+  "keywords": [
+    "admin",
+    "antelopejs",
+    "aql",
+    "database",
+    "dms",
+    "dms-module"
+  ],
+  "homepage": "https://dms.antelopejs.com/docs/modules/database",
+  "bugs": {
+    "url": "https://github.com/AntelopeJS/dms-database/issues"
+  },
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -10,7 +23,8 @@
     "dist",
     "!dist/test",
     "!dist/.tsbuildinfo",
-    "frontend-vue"
+    "frontend-vue",
+    "skills"
   ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -45,18 +59,18 @@
     "test:frontend": "ajs dms verify-source --layer node_modules/@antelopejs/dms/frontend-vue --module frontend-vue"
   },
   "dependencies": {
-    "@antelopejs/interface-api": ">=0.0.14 <1.0.0",
-    "@antelopejs/interface-api-util": ">=0.1.2 <1.0.0",
-    "@antelopejs/interface-core": ">=0.1.1 <1.0.0",
-    "@antelopejs/interface-database": ">=0.1.8 <1.0.0",
-    "@antelopejs/interface-database-decorators": ">=0.1.7 <1.0.0",
-    "@antelopejs/interface-dms": ">=0.6.0 <1.0.0"
+    "@antelopejs/interface-api": ">=0.0.15 <1.0.0",
+    "@antelopejs/interface-api-util": ">=0.1.3 <1.0.0",
+    "@antelopejs/interface-core": ">=0.2.4 <1.0.0",
+    "@antelopejs/interface-database": ">=0.1.10 <1.0.0",
+    "@antelopejs/interface-database-decorators": ">=0.1.9 <1.0.0",
+    "@antelopejs/interface-dms": ">=0.7.2 <1.0.0"
   },
   "devDependencies": {
-    "@antelopejs/core": ">=1.13.5 <2",
-    "@antelopejs/dms": ">=0.8.0 <0.9.0",
-    "@antelopejs/dms-frontend": ">=0.5.6 <0.6.0",
-    "@antelopejs/tooling-configs": ">=0.0.7 <1.0.0",
+    "@antelopejs/core": ">=1.16.0 <2",
+    "@antelopejs/dms": ">=0.9.3 <1.0.0",
+    "@antelopejs/dms-frontend": ">=0.6.3 <0.7.0",
+    "@antelopejs/tooling-configs": ">=0.0.9 <1.0.0",
     "@types/chai": "^5.2.3",
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.0.0",
@@ -74,12 +88,15 @@
     "typescript": "^6.0.3"
   },
   "optionalDependencies": {
-    "@antelopejs/interface-dms-automation": ">=0.1.1 <1.0.0"
+    "@antelopejs/interface-dms-automation": ">=0.2.1 <1.0.0"
   },
   "packageManager": "pnpm@10.2.0",
   "antelopeJs": {
     "baseUrl": "dist",
     "implements": [],
-    "test": "src/test/harness.ts"
+    "test": "src/test/harness.ts",
+    "skills": [
+      "./skills"
+    ]
   }
 }

package/skills/dms-database/SKILL.md

@@ -0,0 +1,35 @@
+---
+name: dms-database
+description: Uses the @antelopejs/dms-database console of the AntelopeJS DMS (owner-only pages under /modules/database to inspect schemas, draw diagrams, browse and edit rows, and run AQL). Use when installing or configuring dms-database (driverLabel, schemaLabels), deep-linking to its pages, wiring its "database.table-watch" automation trigger, or explaining why a table is missing from it.
+icon: i-lucide-database
+category: data
+tags: [database, schemas, aql, data-browser, automation]
+---
+
+# dms-database
+
+A read-mostly database console for the platform owner. It has no API for other modules: it introspects every schema registered through `@antelopejs/interface-database-decorators`, so a table appears once its module calls `RegisterSchema(<id>)` and declares `@RegisterTable(<table>, <id>)`. User docs: https://dms.antelopejs.com/docs/modules/database (source: `docs/` of this package).
+
+## When to reach for it
+
+- A user wants to look at, fix or query raw rows: point them to the console instead of writing a throwaway admin page.
+- A procedure must react to row changes: use the `database.table-watch` trigger (`schema`, `table`, optional `eventTypes`), loaded only with `@antelopejs/dms-automation`.
+- Never build a business screen on it: saved edits bypass every module's logic. Build a DMS page for that.
+
+## Config (`antelope.config.ts`, all optional)
+
+- Version 0.2+ needs `@antelopejs/dms` 0.9 (`interface-dms` 0.7) and `@antelopejs/dms-frontend` 0.6; 0.1 is the DMS 0.8 line.
+
+- `driverLabel: "MongoDB 8.0"`: the database name on the Overview (the interface cannot discover it).
+- `schemaLabels: { "<schemaId or glob*>": { label, color?: Tone } }`: badges; built-in patterns cover `app*`, `core*`, `global*`, `staging*`, `review*`, `prod*`.
+
+## Deep links
+
+`/modules/database/schemas?record=<schema>::<table>`, `/modules/database/{diagram,data,query}?schema=<schema>&table=<table>`, plus `instance=<name>` or `instance=all`.
+
+## Gotchas
+
+- Owner-only: pages and `/api/database/*` routes answer the platform owner alone.
+- The data browser is read-only on **All instances**; a saved edit can be undone for 10 seconds only.
+- Write queries in the console always run a dry run and need the table name typed to confirm.
+- `table-watch` needs a change feed: MongoDB must run as a replica set.