@antelopejs/dms-frontend 0.9.3 → 0.10.0

package/dist/server-process.js

@@ -73,7 +73,7 @@ function readListenError(message) {
 function readStartError(message) {
     if (!isServerMessage(message) || message.type !== START_ERROR_MESSAGE)
         return undefined;
-    const { location } = message;
+    const location = message.location;
     const isLocated = hasFile(location);
     return {
         message: String(message.message),

package/dist/verify-source-build.js

@@ -8,6 +8,8 @@ const cli_1 = require("@antelopejs/core/cli");
 const child_output_1 = require("./child-output");
 const build_action_1 = require("./commands/build-action");
 const common_1 = require("./common");
+const text_list_1 = require("./internal/text-list");
+const plain_object_1 = require("./internal/plain-object");
 const typecheck_output_1 = require("./typecheck-output");
 const verify_source_result_1 = require("./verify-source-result");
 const vite_output_1 = require("./vite-output");
@@ -39,8 +41,14 @@ const TYPECHECK_CONFIG = "tsconfig.verify.json";
 function snapshotTypeDeclarations(workspace) {
     (0, node_fs_1.cpSync)((0, node_path_1.join)(workspace, AUTO_IMPORTS_DECLARATIONS), (0, node_path_1.join)(workspace, AUTO_IMPORTS_SNAPSHOT));
     const config = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(workspace, "tsconfig.json"), "utf8"));
-    config.files = (config.files ?? []).map((file) => file === AUTO_IMPORTS_DECLARATIONS ? AUTO_IMPORTS_SNAPSHOT : file);
-    if (!config.files.includes(AUTO_IMPORTS_SNAPSHOT))
+    const listed = (0, plain_object_1.isPlainObject)(config) ? (config.files ?? []) : undefined;
+    if (!(0, plain_object_1.isPlainObject)(config) || !(0, text_list_1.isTextList)(listed))
+        throw new cli_1.CliError({
+            title: "The workspace tsconfig.json does not list its files as paths",
+        });
+    const files = listed.map((file) => file === AUTO_IMPORTS_DECLARATIONS ? AUTO_IMPORTS_SNAPSHOT : file);
+    config.files = files;
+    if (!files.includes(AUTO_IMPORTS_SNAPSHOT))
         throw new cli_1.CliError({
             title: `The workspace tsconfig.json does not list ${AUTO_IMPORTS_DECLARATIONS}`,
         });

package/dist/verify-source-client-bundle.d.ts

@@ -0,0 +1 @@
+export declare function checkClientBundle(workspace: string): void;

package/dist/verify-source-client-bundle.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkClientBundle = checkClientBundle;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const ensure_1 = require("./internal/ensure");
+const vite_manifest_1 = require("./internal/vite-manifest");
+const LAZY_LIBRARIES = [
+    { name: "ApexCharts", pattern: /ApexCharts/ },
+    { name: "Tiptap", pattern: /tiptap/i },
+];
+const RUNTIME_MARKERS = ["auth/login", "DefaultLayout", "error.500.title"];
+function checkClientBundle(workspace) {
+    const clientRoot = (0, node_path_1.join)(workspace, "dist", "client");
+    const manifest = (0, vite_manifest_1.parseViteManifest)((0, node_fs_1.readFileSync)((0, node_path_1.join)(clientRoot, ".vite", "manifest.json"), "utf8"), "client build manifest");
+    const mainEntry = manifest.find((entry) => entry.isEntry);
+    (0, ensure_1.ensure)(mainEntry !== undefined, "The Vite manifest names no entry chunk");
+    const mainJavascript = (0, node_fs_1.readFileSync)((0, node_path_1.join)(clientRoot, mainEntry.file), "utf8");
+    const javascript = (0, node_fs_1.readdirSync)((0, node_path_1.join)(clientRoot, "assets"))
+        .filter((file) => file.endsWith(".js"))
+        .map((file) => (0, node_fs_1.readFileSync)((0, node_path_1.join)(clientRoot, "assets", file), "utf8"))
+        .join("\n");
+    for (const { name, pattern } of LAZY_LIBRARIES) {
+        (0, ensure_1.ensure)(!pattern.test(mainJavascript), `The main chunk bundles ${name}`, "It must stay in a lazily loaded chunk.");
+        (0, ensure_1.ensure)(pattern.test(javascript), `No client chunk bundles ${name}`);
+    }
+    (0, ensure_1.ensure)(manifest.some((chunk) => chunk.src?.endsWith("/kpi/KpiCard.vue")), "DmsKpiCard is not reachable at runtime");
+    for (const marker of RUNTIME_MARKERS)
+        (0, ensure_1.ensure)(javascript.includes(marker), `${marker} is not reachable at runtime`);
+}

package/dist/verify-source-runner.js

@@ -37,32 +37,27 @@ const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const cli_1 = require("@antelopejs/core/cli");
 const child_output_1 = require("./child-output");
+const ensure_1 = require("./internal/ensure");
+const guards_1 = require("./internal/guards");
+const plain_object_1 = require("./internal/plain-object");
+const vite_manifest_1 = require("./internal/vite-manifest");
 const common_1 = require("./common");
 const output_1 = require("./output");
 const temporary_workspace_1 = require("./temporary-workspace");
+const verify_source_client_bundle_1 = require("./verify-source-client-bundle");
 const verify_source_build_1 = require("./verify-source-build");
 const verify_source_result_1 = require("./verify-source-result");
 const verify_source_sources_1 = require("./verify-source-sources");
 const vite_output_1 = require("./vite-output");
 const EMAIL_BUILD_SIZE_CEILING_BYTES = 256 * 1024;
 const NON_EMAIL_RUNTIME_PATTERN = /DisplayRichText|ApexCharts|Tiptap|FlowCanvas|app\/.*table|components\/table/i;
-const LAZY_LIBRARIES = [
-    { name: "ApexCharts", pattern: /ApexCharts/ },
-    { name: "Tiptap", pattern: /tiptap/i },
-];
-const RUNTIME_MARKERS = ["auth/login", "DefaultLayout", "error.500.title"];
-function readJson(path) {
-    return JSON.parse((0, node_fs_1.readFileSync)(path, "utf8"));
-}
-function ensure(condition, title, reason) {
-    if (!condition)
-        throw new cli_1.CliError({ title, reason });
-}
 function removeDevelopmentDependencies(root) {
     const packagePath = (0, node_path_1.join)(root, "package.json");
     if (!(0, node_fs_1.existsSync)(packagePath))
         return;
-    const packageData = readJson(packagePath);
+    const packageData = JSON.parse((0, node_fs_1.readFileSync)(packagePath, "utf8"));
+    if (!(0, plain_object_1.isPlainObject)(packageData))
+        return;
     delete packageData.devDependencies;
     (0, node_fs_1.writeFileSync)(packagePath, `${JSON.stringify(packageData, null, 2)}\n`);
 }
@@ -82,10 +77,14 @@ function materializeWorkspace(workspace, layers, localPackages) {
     (0, node_fs_1.writeFileSync)((0, node_path_1.join)(workspace, "dms-main.css"), '@import "tailwindcss";\n@import "@nuxt/ui";\n');
     (0, common_1.writeWorkspacePackageJson)(workspace, layers);
     const packagePath = (0, node_path_1.join)(workspace, "package.json");
-    const workspacePackage = readJson(packagePath);
+    const workspacePackage = JSON.parse((0, node_fs_1.readFileSync)(packagePath, "utf8"));
+    (0, ensure_1.ensure)((0, plain_object_1.isPlainObject)(workspacePackage), "The workspace package.json is not a JSON object");
     workspacePackage.pnpm = {
         overrides: {
-            ...Object.fromEntries(layers.map((layer) => [layer.packageName, "workspace:*"])),
+            ...Object.fromEntries(layers.map((layer) => [
+                String(layer.packageName),
+                "workspace:*",
+            ])),
             ...Object.fromEntries(Object.entries(localPackages).map(([name, path]) => [
                 name,
                 `link:${(0, node_path_1.resolve)(path)}`,
@@ -94,33 +93,15 @@ function materializeWorkspace(workspace, layers, localPackages) {
     };
     (0, node_fs_1.writeFileSync)(packagePath, `${JSON.stringify(workspacePackage, null, 2)}\n`);
 }
-function checkClientBundle(workspace) {
-    const clientRoot = (0, node_path_1.join)(workspace, "dist", "client");
-    const manifest = readJson((0, node_path_1.join)(clientRoot, ".vite", "manifest.json"));
-    const mainEntry = Object.values(manifest).find((entry) => entry.isEntry);
-    ensure(mainEntry !== undefined, "The Vite manifest names no entry chunk");
-    const mainJavascript = (0, node_fs_1.readFileSync)((0, node_path_1.join)(clientRoot, mainEntry.file), "utf8");
-    const javascript = (0, node_fs_1.readdirSync)((0, node_path_1.join)(clientRoot, "assets"))
-        .filter((file) => file.endsWith(".js"))
-        .map((file) => (0, node_fs_1.readFileSync)((0, node_path_1.join)(clientRoot, "assets", file), "utf8"))
-        .join("\n");
-    for (const { name, pattern } of LAZY_LIBRARIES) {
-        ensure(!pattern.test(mainJavascript), `The main chunk bundles ${name}`, "It must stay in a lazily loaded chunk.");
-        ensure(pattern.test(javascript), `No client chunk bundles ${name}`);
-    }
-    ensure(Object.keys(manifest).some((source) => source.endsWith("/kpi/KpiCard.vue")), "DmsKpiCard is not reachable at runtime");
-    for (const marker of RUNTIME_MARKERS)
-        ensure(javascript.includes(marker), `${marker} is not reachable at runtime`);
-}
 async function checkServerModulesBundle(workspace) {
     const root = (0, node_path_1.join)(workspace, "dist", "server-modules");
     const javascript = (0, node_fs_1.readdirSync)(root, { recursive: true, encoding: "utf8" })
         .filter((file) => file.endsWith(".js"))
         .map((file) => (0, node_fs_1.readFileSync)((0, node_path_1.join)(root, file), "utf8"))
         .join("\n");
-    ensure(!/\.vue["'?]|createApp\(|DefaultLayout/.test(javascript), "The server modules bundle loads application code", "A dms.server.ts imports server code only, never .vue files or dms.frontend.ts.");
-    const { serverModules } = await Promise.resolve(`${(0, node_path_1.join)(root, "server-modules.generated.js")}`).then(s => __importStar(require(s)));
-    ensure(Array.isArray(serverModules), "The server modules bundle exports none");
+    (0, ensure_1.ensure)(!/\.vue["'?]|createApp\(|DefaultLayout/.test(javascript), "The server modules bundle loads application code", "A dms.server.ts imports server code only, never .vue files or dms.frontend.ts.");
+    const serverModules = (await Promise.resolve(`${(0, node_path_1.join)(root, "server-modules.generated.js")}`).then(s => __importStar(require(s)))).serverModules;
+    (0, ensure_1.ensure)(Array.isArray(serverModules), "The server modules bundle exports none");
     return `${(0, cli_1.pluralize)(serverModules.length, "server module")}, ${(0, output_1.formatSize)(Buffer.byteLength(javascript))} JS`;
 }
 const EMAIL_CASES = [
@@ -177,19 +158,19 @@ const EMAIL_CASES = [
 ];
 const BROWSER_ONLY_REASON = "It must not load rich text, charts, tables or flows.";
 function checkLayoutEmail(html) {
-    ensure(/<meta charset="utf-8"/.test(html), "EmailLayout declares no UTF-8 charset");
-    ensure(/images\/antelope-logo\/light\.svg/.test(html), "EmailLayout renders no logo");
-    ensure(!/<h1[^>]*\bas=/.test(html), "EmailLayout leaks an `as` attribute onto its heading");
+    (0, ensure_1.ensure)(/<meta charset="utf-8"/.test(html), "EmailLayout declares no UTF-8 charset");
+    (0, ensure_1.ensure)(/images\/antelope-logo\/light\.svg/.test(html), "EmailLayout renders no logo");
+    (0, ensure_1.ensure)(!/<h1[^>]*\bas=/.test(html), "EmailLayout leaks an `as` attribute onto its heading");
 }
 async function checkEmailContracts(workspace) {
     const emailRoot = (0, node_path_1.join)(workspace, "dist", "server");
     const emailManifestContent = (0, node_fs_1.readFileSync)((0, node_path_1.join)(emailRoot, ".vite", "manifest.json"), "utf8");
-    ensure(!NON_EMAIL_RUNTIME_PATTERN.test(emailManifestContent), "The e-mail manifest references browser-only modules", BROWSER_ONLY_REASON);
-    const emailManifest = JSON.parse(emailManifestContent);
+    (0, ensure_1.ensure)(!NON_EMAIL_RUNTIME_PATTERN.test(emailManifestContent), "The e-mail manifest references browser-only modules", BROWSER_ONLY_REASON);
+    const emailManifest = (0, vite_manifest_1.parseViteManifest)(emailManifestContent, "e-mail build manifest");
     const emailJavascriptFiles = [
         ...new Set([
             "email-renderer.js",
-            ...Object.values(emailManifest)
+            ...emailManifest
                 .map((entry) => entry.file)
                 .filter((file) => file.endsWith(".js")),
         ]),
@@ -197,18 +178,18 @@ async function checkEmailContracts(workspace) {
     const emailJavascript = emailJavascriptFiles
         .map((file) => (0, node_fs_1.readFileSync)((0, node_path_1.join)(emailRoot, file), "utf8"))
         .join("\n");
-    ensure(!NON_EMAIL_RUNTIME_PATTERN.test(emailJavascript), "The e-mail bundle loads browser-only modules", BROWSER_ONLY_REASON);
+    (0, ensure_1.ensure)(!NON_EMAIL_RUNTIME_PATTERN.test(emailJavascript), "The e-mail bundle loads browser-only modules", BROWSER_ONLY_REASON);
     const emailBuildSize = Buffer.byteLength(emailJavascript);
     const emailLocaleBytes = (0, node_fs_1.readdirSync)((0, node_path_1.join)(emailRoot, "locales")).reduce((total, file) => total + (0, node_fs_1.readFileSync)((0, node_path_1.join)(emailRoot, "locales", file)).byteLength, 0);
     const limit = (0, output_1.formatSize)(EMAIL_BUILD_SIZE_CEILING_BYTES);
-    ensure(emailBuildSize <= EMAIL_BUILD_SIZE_CEILING_BYTES, `The e-mail bundle is ${(0, output_1.formatSize)(emailBuildSize)} of JavaScript`, `The limit is ${limit}.`);
+    (0, ensure_1.ensure)(emailBuildSize <= EMAIL_BUILD_SIZE_CEILING_BYTES, `The e-mail bundle is ${(0, output_1.formatSize)(emailBuildSize)} of JavaScript`, `The limit is ${limit}.`);
     const { renderEmail } = await Promise.resolve(`${(0, node_path_1.join)(emailRoot, "email-renderer.js")}`).then(s => __importStar(require(s)));
     for (const emailCase of EMAIL_CASES) {
         const html = await renderEmail(emailCase.name, emailCase.props);
-        ensure(html.startsWith("<!doctype html>"), `${emailCase.name} does not render a full HTML document`);
+        (0, ensure_1.ensure)((0, guards_1.isText)(html) && html.startsWith("<!doctype html>"), `${emailCase.name} does not render a full HTML document`);
         if (emailCase.name === "EmailLayout")
             checkLayoutEmail(html);
-        ensure(html.includes(emailCase.marker), `${emailCase.name} does not render its props`, `Its HTML lacks ${emailCase.marker}.`);
+        (0, ensure_1.ensure)(html.includes(emailCase.marker), `${emailCase.name} does not render its props`, `Its HTML lacks ${emailCase.marker}.`);
     }
     return [
         "E-mail contracts hold",
@@ -219,18 +200,6 @@ async function checkEmailContracts(workspace) {
 }
 const LINE_BREAK = /\r?\n/;
 const STACK_TRACE_HINT = "Run with --verbose for the full trace.";
-function describeError(error, isVerbose) {
-    if (error instanceof cli_1.CliError)
-        return error.problem;
-    if (!(error instanceof Error))
-        return { title: String(error) };
-    const [title] = error.message.split(LINE_BREAK);
-    const stack = (error.stack ?? "").split(LINE_BREAK);
-    return {
-        title: title || error.name,
-        details: isVerbose ? stack : [STACK_TRACE_HINT],
-    };
-}
 async function verifySources() {
     const options = (0, verify_source_sources_1.readSourceOptions)();
     const { layers, coreLayer } = (0, verify_source_sources_1.readSources)(options);
@@ -251,7 +220,7 @@ async function verifySources() {
     await (0, common_1.installDeps)(workspace, context.mapLine, ["--ignore-scripts"]);
     await (0, verify_source_build_1.prepareTypes)(context);
     await (0, verify_source_build_1.buildAndTypeCheck)(context);
-    await tasks.run("Checking the client bundle", async () => checkClientBundle(workspace), { done: "Client bundle checked", failed: "Client bundle check failed" });
+    await tasks.run("Checking the client bundle", async () => (0, verify_source_client_bundle_1.checkClientBundle)(workspace), { done: "Client bundle checked", failed: "Client bundle check failed" });
     await tasks.run("Checking the e-mail contracts", async () => checkEmailContracts(workspace), { done: (line) => line, failed: "E-mail contracts failed" });
     await tasks.run("Checking the server modules", async () => checkServerModulesBundle(workspace), { done: (line) => line, failed: "Server modules check failed" });
     return { ok: true, modules: layers.length };
@@ -276,7 +245,22 @@ async function main() {
             process.exitCode = error.exitCode;
             return;
         }
-        result = { ok: false, problem: describeError(error, (0, cli_1.isVerboseRun)()) };
+        let problem;
+        if (error instanceof cli_1.CliError) {
+            problem = error.problem;
+        }
+        else if (error instanceof Error) {
+            const [title] = error.message.split(LINE_BREAK);
+            const stack = (error.stack ?? "").split(LINE_BREAK);
+            problem = {
+                title: title || error.name,
+                details: (0, cli_1.isVerboseRun)() ? stack : [STACK_TRACE_HINT],
+            };
+        }
+        else {
+            problem = { title: String(error) };
+        }
+        result = { ok: false, problem };
     }
     if (process.send) {
         process.exitCode = result.ok ? 0 : 1;

package/dist/verify-source-sources.js

@@ -5,18 +5,20 @@ exports.readSources = readSources;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const common_1 = require("./common");
+const guards_1 = require("./internal/guards");
+const plain_object_1 = require("./internal/plain-object");
 const output_1 = require("./output");
 const verify_source_result_1 = require("./verify-source-result");
 const DMS_PACKAGE = "@antelopejs/dms";
 const DMS_CORE_LAYER_PACKAGE = "@antelopejs/dms-frontend-vue";
 const CORE_LAYER_DIRECTORY = "frontend-vue";
 const FRONTEND_ENTRY = "dms.frontend.ts";
-const ADD_DEV_DEPENDENCY = {
-    pnpm: "pnpm add -D",
-    npm: "npm install -D",
-    yarn: "yarn add -D",
-    bun: "bun add -d",
-};
+const ADD_DEV_DEPENDENCY = new Map([
+    ["pnpm", "pnpm add -D"],
+    ["npm", "npm install -D"],
+    ["yarn", "yarn add -D"],
+    ["bun", "bun add -d"],
+]);
 const LOCKFILES = [
     ["pnpm-lock.yaml", "pnpm"],
     ["package-lock.json", "npm"],
@@ -24,16 +26,46 @@ const LOCKFILES = [
     ["bun.lock", "bun"],
     ["bun.lockb", "bun"],
 ];
+function malformedVariable(variable, expected) {
+    return new common_1.UsageError({
+        title: `${variable} is not ${expected}`,
+        reason: `\`ajs dms verify-source\` starts the runner with ${variable} set to ${expected}.`,
+    });
+}
+function readTextList(variable) {
+    const value = JSON.parse(process.env[variable] ?? "[]");
+    if (Array.isArray(value) && value.every(guards_1.isText))
+        return value;
+    throw malformedVariable(variable, "a JSON list of paths");
+}
+function readTextRecord(variable) {
+    const value = JSON.parse(process.env[variable] ?? "{}");
+    if ((0, plain_object_1.isPlainObject)(value)) {
+        const entries = Object.entries(value);
+        if (entries.every((entry) => (0, guards_1.isText)(entry[1]))) {
+            return Object.fromEntries(entries);
+        }
+    }
+    throw malformedVariable(variable, "a JSON record of paths by package name");
+}
 function readSourceOptions() {
     return {
         projectDir: process.cwd(),
         layerSource: process.env.DMS_LAYER_SOURCE || undefined,
-        moduleSources: JSON.parse(process.env.DMS_MODULE_SOURCES ?? "[]"),
-        localPackages: JSON.parse(process.env.DMS_LOCAL_PACKAGES ?? "{}"),
+        moduleSources: readTextList("DMS_MODULE_SOURCES"),
+        localPackages: readTextRecord("DMS_LOCAL_PACKAGES"),
     };
 }
 function readManifest(packagePath) {
-    return JSON.parse((0, node_fs_1.readFileSync)(packagePath, "utf8"));
+    const parsed = JSON.parse((0, node_fs_1.readFileSync)(packagePath, "utf8"));
+    if (!(0, plain_object_1.isPlainObject)(parsed))
+        return {};
+    const { name, version, packageManager } = parsed;
+    return {
+        name: (0, guards_1.isText)(name) ? name : undefined,
+        version: (0, guards_1.isText)(version) ? version : undefined,
+        packageManager: (0, guards_1.isText)(packageManager) ? packageManager : undefined,
+    };
 }
 function readLayer(root) {
     const packagePath = (0, node_path_1.join)(root, "package.json");
@@ -68,7 +100,7 @@ function packageManager(projectDir) {
         const packagePath = (0, node_path_1.join)(directory, "package.json");
         if ((0, node_fs_1.existsSync)(packagePath)) {
             const [name] = (readManifest(packagePath).packageManager ?? "").split("@");
-            if (name && ADD_DEV_DEPENDENCY[name])
+            if (name && ADD_DEV_DEPENDENCY.has(name))
                 return name;
             const lockfile = LOCKFILES.find(([file]) => (0, node_fs_1.existsSync)((0, node_path_1.join)(directory, file)));
             if (lockfile)
@@ -79,7 +111,7 @@ function packageManager(projectDir) {
     }
 }
 function addDmsCommand(projectDir, version = "") {
-    return `${ADD_DEV_DEPENDENCY[packageManager(projectDir)]} ${DMS_PACKAGE}${version}`;
+    return `${ADD_DEV_DEPENDENCY.get(packageManager(projectDir))} ${DMS_PACKAGE}${version}`;
 }
 function describeDirectory(directory) {
     return (0, node_path_1.resolve)(directory) === process.cwd()
@@ -107,6 +139,12 @@ function installedCoreLayer(projectDir) {
             ],
         });
     const { version } = readManifest(packagePath);
+    if (version === undefined)
+        throw new common_1.UsageError({
+            title: `${DMS_PACKAGE} has no text "version" in its package.json`,
+            reason: `${(0, output_1.showPath)(packagePath)} has no "version" that is text, and the verification names the installed ${DMS_PACKAGE} by it.`,
+            fixes: [`Reinstall it: ${addDmsCommand(projectDir, "@latest")}`],
+        });
     const root = (0, node_path_1.join)((0, node_path_1.dirname)(packagePath), CORE_LAYER_DIRECTORY);
     const layer = (0, node_fs_1.existsSync)((0, node_path_1.join)(root, "package.json"))
         ? readLayer(root)

package/dist/workspace-setup.js

@@ -95,7 +95,7 @@ async function installDeps(workspaceDir, mapLine, extraArgs = []) {
         task.succeed(progress.doneLabel);
     }
     catch (error) {
-        (0, output_1.endInterruptedTask)(task, error, "Dependency install stopped");
+        (0, output_1.endInterruptedTask)(task, error instanceof cancellation_1.CancelledError ? error : undefined, "Dependency install stopped");
         throw error;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/dms-frontend",
-  "version": "0.9.3",
+  "version": "0.10.0",
   "description": "Frontend-agnostic loader for AntelopeJS DMS, shipping the Vue 3 renderer (Vite, Inertia, SSR)",
   "keywords": [
     "antelope",
@@ -76,9 +76,7 @@
     "prepare": "if git rev-parse --is-inside-work-tree >/dev/null 2>&1 && command -v lefthook >/dev/null 2>&1; then lefthook install; fi",
     "checks": "antelopejs-checks",
     "size": "antelopejs-check-size",
-    "ratchet": "antelopejs-ratchet",
     "sync": "antelopejs-sync",
-    "ratchet:update": "antelopejs-ratchet --update",
     "sync:check": "antelopejs-sync --check",
     "format:check": "oxfmt --check .",
     "suppressions": "antelopejs-suppressions",
@@ -92,7 +90,8 @@
     "semver": "^7.7.4"
   },
   "devDependencies": {
-    "@antelopejs/core": "^1.16.0",
+    "@antelopejs/core": "^1.20.0",
+    "@antelopejs/interface-dms": "^0.10.0",
     "@antelopejs/tooling-configs": "^0.2.17",
     "@iconify/utils": "^3.1.0",
     "@iconify/vue": "^5.0.1",
@@ -141,6 +140,9 @@
     }
   },
   "antelopeJs": {
+    "docs": {
+      "standard": true
+    },
     "skills": [
       "./skills"
     ]

package/skills/dms-frontend/SKILL.md

@@ -40,7 +40,7 @@ tags: [frontend, cli, renderer, vue, inertia, ssr, deployment, dms-module]
 
 | Task | Page |
 | --- | --- |
-| Compatibility with DMS releases | `/docs/frontend/introduction#compatibility` |
+| Where to read the renderer releases a DMS release runs on | `/docs/frontend/introduction#compatibility` |
 | One command in depth | `/docs/frontend/cli/<command>` |
 | Variables and secrets | `/docs/frontend/configuration` |
 | Module files and SDK | `/docs/frontend/frontend-modules/anatomy`, then `server-routes`, `sessions-and-sign-in`, `route-rules`, `emails` |

package/templates/vue/app-runtime.ts

@@ -9,7 +9,6 @@ import { useHead } from "@unhead/vue";
 import type { VueHeadClient } from "@unhead/vue/types";
 import type { IconifyIcon } from "@iconify/vue";
 import { parse } from "devalue";
-import type { FetchOptions } from "ofetch";
 import {
   type App,
   type Component,
@@ -28,6 +27,7 @@ import {
   type DmsLocaleLoader,
   type DmsPageProps,
   type DmsPayload,
+  type DmsServerFetch,
   type DmsUser,
   createDmsFrontendRuntime,
   dmsPageSuspenseProps,
@@ -107,11 +107,6 @@ export interface DmsConfiguredApp {
   runtime: ReturnType<typeof createDmsFrontendRuntime>;
 }
 
-export type DmsServerFetch = (
-  request: string,
-  options?: FetchOptions,
-) => Promise<unknown>;
-
 export const DMS_PAYLOAD_ID = "dms-payload";
 export const SSR_ASYNC_COMPONENTS_ID = "dms-ssr-async-components";
 const DEFAULT_LOCALE = "en";
@@ -156,9 +151,7 @@ drawLoadedIconsAtOnce();
 function createBrowserRuntime(
   serverFetch?: DmsServerFetch,
 ): DmsConfiguredApp["runtime"] {
-  const runtime = createDmsFrontendRuntime(
-    serverFetch as typeof import("ofetch").ofetch,
-  );
+  const runtime = createDmsFrontendRuntime(serverFetch);
   // Nothing when the server did not render the page: no hydration then.
   const payload = readServerRendered<DmsPayload | undefined>(
     DMS_PAYLOAD_ID,

package/templates/vue/client-server-guard.mjs

@@ -2,11 +2,20 @@ import { relative, sep } from "node:path";
 
 const SERVER_ENTRY = /(?:^|[\\/])dms\.server\.[cm]?[jt]sx?$/;
 
+/**
+ * @param {string} id
+ * @returns {string}
+ */
 function stripQuery(id) {
   const query = id.indexOf("?");
   return query === -1 ? id : id.slice(0, query);
 }
 
+/**
+ * @param {string} file
+ * @param {readonly string[]} moduleRoots
+ * @returns {boolean}
+ */
 function insideModuleServerDirectory(file, moduleRoots) {
   return moduleRoots.some((root) => {
     const path = relative(root, file);
@@ -20,6 +29,10 @@ function insideModuleServerDirectory(file, moduleRoots) {
  * Whether `id`, a resolved module id, is server code: a module's server entry
  * (`dms.server.*`) or a file under a `server/` directory of a module. Installed
  * packages never are: `node_modules` has its own `server` directories.
+ *
+ * @param {string} id
+ * @param {readonly string[]} moduleRoots
+ * @returns {boolean}
  */
 export function isServerSource(id, moduleRoots) {
   if (id.startsWith("\0")) return false;
@@ -44,6 +57,9 @@ export function isServerSource(id, moduleRoots) {
  * import; the guard sits in the module graph instead, where every resolved file
  * passes. Kept beside vite.config.ts rather than inside it so the plugin can be
  * exercised on its own, the way head-order.mjs is.
+ *
+ * @param {readonly string[]} moduleRoots
+ * @returns {import("vite").Plugin}
  */
 export function rejectServerSourcesInClient(moduleRoots) {
   let ssrBuild = false;

package/templates/vue/compress-assets.mjs

@@ -16,10 +16,14 @@ const MINIMUM_SIZE_BYTES = 1_024;
 const compressBrotli = promisify(brotliCompress);
 const compressGzip = promisify(gzip);
 
+/**
+ * @param {string} directory
+ * @returns {Promise<string[]>}
+ */
 async function assetFiles(directory) {
   const entries = await readdir(directory, { withFileTypes: true });
   const files = await Promise.all(
-    entries.map((entry) => {
+    entries.map(async (entry) => {
       const path = join(directory, entry.name);
       return entry.isDirectory() ? assetFiles(path) : [path];
     }),
@@ -27,6 +31,10 @@ async function assetFiles(directory) {
   return files.flat();
 }
 
+/**
+ * @param {string} path
+ * @returns {Promise<void>}
+ */
 async function compressAsset(path) {
   if (!COMPRESSIBLE_EXTENSIONS.has(extname(path))) return;
   const content = await readFile(path);

package/templates/vue/entry-weight.mjs

@@ -10,11 +10,20 @@ export const TRANSLATIONS_OWNER = "translations";
 
 const LOCALE_CATALOG = /[\\/]locales\.generated[\\/]/;
 
+/**
+ * @param {string} id
+ * @returns {string}
+ */
 function stripQuery(id) {
   const query = id.indexOf("?");
   return query === -1 ? id : id.slice(0, query);
 }
 
+/**
+ * @param {string} root
+ * @param {string} file
+ * @returns {boolean}
+ */
 function isInside(root, file) {
   const path = relative(root, file);
   return Boolean(path) && !path.startsWith("..") && !path.startsWith(sep);
@@ -26,7 +35,9 @@ function isInside(root, file) {
  * what every page shares (the renderer's runtime, the UI and icon libraries,
  * an installed package).
  *
+ * @param {string} id
  * @param {{ root: string, name?: string, packageName?: string, id: string }[]} modules
+ * @returns {string}
  */
 export function entryOwner(id, modules) {
   if (id.startsWith("\0")) return SHARED_OWNER;
@@ -42,13 +53,18 @@ export function entryOwner(id, modules) {
 /**
  * The files a page loads before its first line runs: the entry chunks and
  * their static imports, transitively, by file name.
+ *
+ * @param {import("vite").Rollup.OutputBundle} bundle
+ * @returns {(import("vite").Rollup.OutputChunk | undefined)[]}
  */
 function entryClosure(bundle) {
   const chunks = Object.values(bundle).filter(
     (output) => output.type === "chunk",
   );
   const byName = new Map(chunks.map((chunk) => [chunk.fileName, chunk]));
+  /** @type {Set<string>} */
   const seen = new Set();
+  /** @param {import("vite").Rollup.OutputChunk | undefined} chunk */
   const visit = (chunk) => {
     if (!chunk || seen.has(chunk.fileName)) return;
     seen.add(chunk.fileName);
@@ -64,10 +80,13 @@ function entryClosure(bundle) {
  * rendered for each (`renderedLength`, before minification): an estimate that
  * needs nothing the bundle does not already hold.
  *
+ * @param {import("vite").Rollup.OutputBundle} bundle
+ * @param {{ root: string, name?: string, packageName?: string, id: string }[]} modules
  * @returns {{ files: string[], bytes: number, owners: Record<string, number> }}
  */
 export function attributeEntry(bundle, modules) {
   const files = entryClosure(bundle);
+  /** @type {Record<string, number>} */
   const owners = {};
   let bytes = 0;
   for (const chunk of files) {
@@ -109,6 +128,9 @@ export function attributeEntry(bundle, modules) {
  *
  * The weight is recorded once the bundle is written: plugins that generate the
  * bundle after this one still rewrite the chunks' code.
+ *
+ * @param {{ root: string, name?: string, packageName?: string, id: string }[]} modules
+ * @returns {import("vite").Plugin}
  */
 export function recordEntryWeight(modules) {
   let ssrBuild = false;

package/templates/vue/frontend-module.ts

@@ -34,6 +34,7 @@ export type {
   DmsFetchTransformContext,
   UseAsyncDataOptions,
   UseFetchOptions,
+  DmsServerFetch,
   DmsErrorData,
   DmsPayload,
   DmsStateOptions,

package/templates/vue/frontend-runtime/module-registration.ts

@@ -1,5 +1,4 @@
 import { usePage } from "@inertiajs/vue3";
-import { ofetch } from "ofetch";
 import {
   type Component,
   type EffectScope,
@@ -19,6 +18,7 @@ import {
   type DmsPluginRegistrationOptions,
   type DmsPluginSetup,
   type DmsRoute,
+  type DmsServerFetch,
   type DmsSharedPagePayload,
   type RouteLocationRaw,
 } from "./types";
@@ -212,7 +212,7 @@ export interface DmsFrontendRuntime {
   /** Whether to warn about what a development render does wrong. */
   devWarnings?: boolean;
   runtimeHooks: Map<string, DmsRuntimeHook[]>;
-  serverFetch?: typeof ofetch;
+  serverFetch?: DmsServerFetch;
   currentError: Ref<Error | null>;
   route: DmsRoute;
   currentRoutePattern?: string;