@antelopejs/dms-frontend 0.1.8 → 0.2.0

package/README.md

@@ -10,7 +10,9 @@ Frontend-agnostic loader for AntelopeJS DMS. The backend serves a frontend
 manifest and the matching frontend-module archives; the `ajs dms` CLI
 materializes them into a generated workspace for one renderer, builds it, and
 runs its Node frontend server. The `vue` renderer — Vue 3, Vite, Inertia, and
-SSR — is the one shipped today.
+SSR — is the one shipped today. The package itself installs a single executable,
+`ajs-dms`; `ajs dms` is the core CLI delegating to it, and is the name every
+project, script and document uses.
 
 ## Renderers
 
@@ -42,7 +44,7 @@ making the template root (`src/materialize.ts`) and the manifest query
 `--renderer` flag and no renderer registry; the single-renderer assumption is
 deliberate until a second renderer exists. Whatever a renderer names its module
 entry is its own convention: `dms.frontend.ts` and the
-`#dms-inertia/frontend-module` alias belong to the Vue renderer, not to the
+`#dms/frontend-module` alias belong to the Vue renderer, not to the
 loader.
 
 ## Application ownership
@@ -55,15 +57,23 @@ not infer application ownership from other framework configuration.
 
 ## Install
 
-The loader is an AntelopeJS CLI plugin: install it next to `@antelopejs/core`
-and `ajs` delegates its `dms` command to the `ajs-dms` executable.
+The loader is an official AntelopeJS CLI plugin: install it next to
+`@antelopejs/core` and run it as `ajs dms <command>`. That is the only supported
+way to invoke it — in a shell, in a package script, in CI and in a container
+alike.
 
 ```bash
+# in a project (the usual case: both are already project dependencies)
+pnpm add @antelopejs/core @antelopejs/dms-frontend
+
+# or globally
 pnpm add -g @antelopejs/core @antelopejs/dms-frontend
 ```
 
 `npm install -g` works too; this repository and every generated workspace use
-pnpm.
+pnpm. Inside a package script, `ajs` resolves from `node_modules/.bin`, and the
+`dms` command it delegates to resolves the project-local plugin, so a script
+never depends on a global install.
 
 ## Commands
 
@@ -76,9 +86,6 @@ ajs dms clean -b https://dms.example.com
 ajs dms clean --all
 ```
 
-`ajs dms <command>` and `ajs-dms <command>` are the same program; the delegation
-only saves you from remembering a second executable name. Package scripts should
-call `ajs-dms` directly so they do not depend on the CLI being installed.
 `--help`, `--version` and `clean` run from any directory. `prepare` also runs
 anywhere: with no backend in reach it warns and exits 0, so a frontend module's
 `postinstall` hook never fails an install, and the generated types are refreshed
@@ -97,7 +104,7 @@ Manifest negotiation and module materialization are the renderer contract descri
 
 The generated Vue application uses `@inertiajs/vue3`, `@nuxt/ui/vite` with `{ router: "inertia" }`, and `@nuxt/ui/vue-plugin`. The Node server resolves each Inertia visit through `/dms/page?path=…`, including fresh shared data so account, tenant, and permission changes update navigation state. It proxies backend routes and manages authentication through server-side sessions. `DMS_BOOTSTRAP_SECRET` is used only by the CLI's server-to-server frontend manifest and module archive requests and is never sent by, or exposed to, browser traffic.
 
-Vue modules use `dms.frontend.ts` and the `#dms-inertia/frontend-module` SDK alias, which replaces the former `#cms-inertia` alias and is the import path every DMS frontend module now uses. Email templates register separately through `dms.email.ts`.
+Vue modules register through `dms.frontend.ts` and import the SDK from the `#dms/frontend-module` alias, which the loader resolves to the generated `frontend-module.ts`: `defineDmsPlugin`, `useDmsRouter`, the page and session types, and everything else a module needs from the host. Email templates register separately through `dms.email.ts`.
 
 An email entry exports `serverEmailTemplates` and may export a plain `appConfig` object, such as shared branding defaults. Email rendering merges these configurations in manifest-priority order and provides them to `useDmsAppConfig` per render. Public runtime options come from the module manifest; `DMS_CLIENT_BASE_URL` overrides `public.dms.clientBaseUrl`. Email entries must not import the browser frontend module.
 
@@ -110,7 +117,7 @@ A materialized module opts into the Vue adapter with a root `dms.frontend.ts`:
 ```ts
 import MyBlock from "./components/MyBlock.vue";
 import MyPage from "./pages/MyPage.vue";
-import type { DmsFrontendModule } from "../../frontend-module";
+import type { DmsFrontendModule } from "#dms/frontend-module";
 
 const frontendModule: DmsFrontendModule = {
   setup(sdk) {

package/dist/commands/build.js

@@ -51,7 +51,7 @@ function cmdBuild() {
             if (code === 0) {
                 console.log("");
                 (0, cli_ui_1.success)("Build completed successfully!");
-                console.log(chalk_1.default.dim("  Run 'ajs-dms start' to start the production server"));
+                console.log(chalk_1.default.dim("  Run 'ajs dms start' to start the production server"));
             }
             else {
                 (0, cli_ui_1.error)("Build failed");

package/dist/commands/start.js

@@ -26,7 +26,7 @@ function cmdStart() {
         if (!(0, node_fs_1.existsSync)(serverPath) || !(0, node_fs_1.existsSync)(clientPath)) {
             console.log("");
             (0, cli_ui_1.error)("Production build not found!");
-            console.log(chalk_1.default.dim("  Run 'ajs-dms build -b " +
+            console.log(chalk_1.default.dim("  Run 'ajs dms build -b " +
                 options.backendUrl +
                 "' first to create a production build"));
             process.exit(1);

package/dist/index.js

@@ -25,7 +25,7 @@ const runCLI = async () => {
         console.log(chalk_1.default.dim(`  Frontend Loader for AntelopeJS DMS - v${version}\n`));
     }
     const program = new commander_1.Command()
-        .name("ajs-dms")
+        .name("ajs dms")
         .description(`Antelope DMS - Frontend Loader v${version}\n\n` +
         `Materializes frontend modules from an AntelopeJS backend and starts a Vue or React Vite and Inertia application.`)
         .version(version, "-v, --version", "Display version number")

package/dist/layers.js

@@ -23,8 +23,8 @@ function assertLayerPathsServed(modules) {
         return;
     throw new Error("The backend served a manifest without layer source paths:\n" +
         pathless.map((mod) => `  - ${mod.name}`).join("\n") +
-        "\n`ajs-dms dev` needs a development backend running on this machine (started with " +
-        "`ajs project dev`); use `ajs-dms build` against a remote or production one.\n" +
+        "\n`ajs dms dev` needs a development backend running on this machine (started with " +
+        "`ajs project dev`); use `ajs dms build` against a remote or production one.\n" +
         "If the backend is local and in development mode, it did not recognize the bootstrap " +
         "credential — see DMS_BOOTSTRAP_SECRET.");
 }

package/dist/materialize.js

@@ -140,7 +140,7 @@ function writeFrontendModuleRegistry(workspaceDir, layers) {
 }
 function writeFrontendTypePaths(workspaceDir, registry) {
     const paths = {
-        "#dms-inertia/frontend-module": ["./frontend-module.ts"],
+        "#dms/frontend-module": ["./frontend-module.ts"],
         "@frontend/*": ["./frontend-modules/*"],
     };
     [...registry.modules].reverse().forEach((module) => {

package/dist/verify-source-runner.js

@@ -53,7 +53,7 @@ function removeDevelopmentDependencies(root) {
 if (!process.env.DMS_LAYER_SOURCE)
     throw new Error("DMS_LAYER_SOURCE must identify a frontend package");
 const sourceRoot = (0, node_path_1.resolve)(process.env.DMS_LAYER_SOURCE);
-const workspace = (0, node_fs_1.mkdtempSync)((0, node_path_1.join)((0, node_os_1.tmpdir)(), "dms-inertia-real-source-"));
+const workspace = (0, node_fs_1.mkdtempSync)((0, node_path_1.join)((0, node_os_1.tmpdir)(), "dms-frontend-real-source-"));
 const templateRoot = (0, node_path_1.join)((0, common_1.getPackageRoot)(), "templates", "vue");
 const commandEnvironment = { ...process.env };
 const EMAIL_BUILD_SIZE_CEILING_BYTES = 256 * 1024;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/dms-frontend",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "description": "Frontend-agnostic loader for AntelopeJS DMS, shipping the Vue 3 renderer (Vite, Inertia, SSR)",
   "keywords": [
     "antelope",

package/templates/vue/vite.config.ts

@@ -135,7 +135,7 @@ export default defineConfig({
   resolve: {
     dedupe: ["vue", "reka-ui", "@nuxt/ui"],
     alias: {
-      "#dms-inertia/frontend-module": resolve(__dirname, "frontend-module.ts"),
+      "#dms/frontend-module": resolve(__dirname, "frontend-module.ts"),
       "#build/nuxt-icon-client-bundle": "virtual:nuxt-ui-icons",
       "#shortcuts-aggregated": resolve(
         __dirname,