@antelopejs/dms-frontend 0.3.11 → 0.4.0

package/README.md

@@ -100,7 +100,7 @@ generated server read, from the environment or the project's `.env`.
 need a backend URL through `-b` or `DMS_API_BASE_URL`, and exit 2 without one.
 `dev` also discovers it from the enclosing antelope project's
 `.antelope/dev.json`, and exits 1 when there is none to discover.
-`verify-source` needs `--layer` instead.
+`verify-source` needs no backend: it runs in the project that installs `@antelopejs/dms`.
 
 `prepare` runs anywhere: when it cannot prepare the workspace it warns on
 stderr and exits 0, so a frontend module's `postinstall` hook never fails an
@@ -188,6 +188,61 @@ The SDK also exposes `use` for Vue plugins. Entries execute by descending manife
 
 Within one setup, the first module to register a name keeps it. `ajs-dms dev` sets every module up again each time a change to a layer reaches the server renderer, into empty registries, so the next server render uses the edited component without a restart. A `setup` may therefore run more than once in a process: it should only register, and keep no state of its own between runs.
 
+### Private components
+
+A component registers as public by default: it joins the application's global components and resolves by name anywhere. A component that only exists to render the module's own backend pages registers as private instead:
+
+```ts
+sdk.registerComponent("BillingTotals", BillingTotals, { private: true });
+```
+
+A private component is not registered with `app.component`, so no template or other module reaches it by name. `resolveDmsComponent(name, owner)` returns it only when `owner` is the registering module, and then ahead of a public component of the same name; without an owner, only public components resolve. The generic page renderer passes the page's owner, so a backend page tree naming the component renders it, and the page preloader and the server render's hydration handover cover it too.
+
+The owner is the page payload's `module` field: the name of the frontend module that owns the page's component tree, as the backend added it (the module's `name` in the frontend manifest, which the generated loader hands each module's setup). A backend that does not send `module` reaches no private component, whatever the tree names.
+
+### Auto-imports (`dms.frontend.build.ts`)
+
+Nothing a module ships is auto-imported unless the module declares it, in an optional `dms.frontend.build.ts` next to its `dms.frontend.ts`:
+
+```ts
+import { defineDmsFrontendBuild } from "#dms/frontend-build";
+
+export default defineDmsFrontendBuild((build) => {
+  build.registerAutoImports([
+    "layers/*/app/composables",
+    "layers/*/app/utils",
+    "layers/*/app/types",
+  ]);
+});
+```
+
+Each entry is a directory relative to the module root, glob patterns allowed; every export of the files under it becomes available to the whole application without an import, in scripts and templates. A module without the file has nothing auto-imported. `app/build/` holds a module's private code and is never auto-imported: it is left out of what a broader entry covers, and an entry naming it, or a directory outside the module, is ignored with a warning when Vite starts.
+
+The file runs in Node.js when Vite starts, under `ajs dms dev` and `ajs dms build`, not in the application: it may import `#dms/frontend-build` and Node.js built-ins, never the application's code. Vite restarts when one changes.
+
+Up to 0.3, every module's `app/composables`, `app/types`, `app/utils`, `app/build/composables` and `app/build/types` were auto-imported. A module that relies on auto-imports declares its public directories in `dms.frontend.build.ts`, and imports its `app/build/` code by path.
+
+### Page loading state
+
+After a client navigation, the page renders under a `<Suspense>` until its chunk and any async `setup` resolve. `useDmsPageLoading()` (auto-imported) is `true` meanwhile, so a layout can show its own placeholder instead of an empty page body:
+
+```vue
+<script setup lang="ts">
+const pageLoading = useDmsPageLoading();
+</script>
+
+<template>
+  <slot />
+  <PageSkeleton v-if="pageLoading" />
+</template>
+```
+
+It stays `false` on the server and during hydration, which render the page resolved, for a page that does not suspend, and once a pending page is left.
+
+### Interface language
+
+The interface language follows the session (`useUserSession().user.language`), not the props of the page on screen: the first render takes it from the session the page arrived with, and it changes when the session's language does, after `useUserSession().fetch()` or a visit with a newer session. A page Inertia restores from history or serves from its prefetch cache carries the session it was fetched with: the frontend server stamps every session it writes (`session.updatedAt`), and a page carrying an older stamp of the same account updates neither the session nor the language. A session without a language, such as a signed-out one, keeps the language on screen; `$i18n.setLocale()` still switches it at any time.
+
 ### Declaring the loader releases a module supports
 
 A frontend module names the `@antelopejs/dms-frontend` releases it runs on in its own `package.json`, the way a package names the Node.js versions it supports:
@@ -412,7 +467,8 @@ The other files the workspace derives from every module follow their sources
 the same way. A file added to, changed in or removed from a module's `public/`
 is served, or no longer served, at once. Adding or removing an
 `app/config/shortcuts-registry.ts` or a `dms.frontend.ts` regenerates the
-aggregated shortcuts or the module loader, and the page reloads. A layer
+aggregated shortcuts or the module loader, and the page reloads. Adding,
+changing or removing a `dms.frontend.build.ts` restarts Vite. A layer
 directory added to or removed from `layers/` is the exception: Vite reads the
 `#<layer>` aliases and the auto-imported directories at startup only, so the
 dev server says it needs a restart.
@@ -436,6 +492,14 @@ needs no exception for the Iconify API. Icons reach the page two ways:
   answers `404`, and a name outside Iconify's naming rule `400`. `ajs dms dev`
   and `ajs dms start` run the same server, so both serve the route.
 
+The server render draws every icon, bundled or not: the frontend server loads
+each installed `@iconify-json/*` collection once and hands it to the renderer,
+and an icon is drawn in its first render as soon as its data is loaded, instead
+of after the component mounts. The data of each icon a render drew travels in
+the page, so the browser draws the same icons as it hydrates; an icon no
+installed collection holds stays empty on the server and is fetched in the
+browser as before.
+
 ## Options
 
 | Option | Environment | Purpose |
@@ -449,6 +513,7 @@ needs no exception for the Iconify API. Icons reach the page two ways:
 | | `HOST` | Address the frontend server binds to (default `0.0.0.0`) |
 | | `DMS_COOKIE_SECURE` | Secure cookies (`true` by default; `ajs dms dev` defaults to `false`) |
 | | `DMS_TRUSTED_PROXY_HOPS` | Number of trusted, rightmost reverse-proxy hops (default `0`) |
+| | `DMS_COUNTRY_HEADER` | Client country header the server relays to the backend, set by a trusted reverse proxy (default `CF-IPCountry`; empty relays none). Name the same header in the backend's `auth.signInCountry.header`. Relayed only when `DMS_TRUSTED_PROXY_HOPS` is above `0`, like the client address |
 | | `DMS_SESSION_SECRET` | Session cookie encryption key, 32 characters or more (required for login) |
 | | `DMS_HTML_RENDER_SECRET` | Secret that verifies the backend's signed HTML/email render requests; without it, e-mail renders are refused. Defaults to the `htmlRender.serviceSecret` the backend publishes in the frontend manifest |
 | | `DMS_OAUTH_RELAY_SECRET` | Secret the server presents to the backend's OAuth endpoints; without it, the backend refuses OAuth sign-in. Defaults to the `oauth.relaySecret` the backend publishes in the frontend manifest |
@@ -463,15 +528,30 @@ Use pnpm for all repository and workspace operations.
 
 ## Verify local frontend modules
 
-Use the packaged source verifier to validate an unpublished DMS frontend package against this exact adapter version. Additional modules and local package bindings are repeatable. All supplied frontend packages are copied into the generated workspace and bound with `workspace:*`.
+Use the packaged source verifier to validate unpublished DMS frontend modules against this exact adapter version. Run it from the project:
+
+```bash
+ajs dms verify-source
+```
+
+The modules are verified on top of the DMS core layer, the `frontend-vue` directory of `@antelopejs/dms`. The verifier finds the `@antelopejs/dms` the project installs the way Node does, from the current directory, and names it before it starts: `Verifying against @antelopejs/dms 0.5.5 (installed in this project)`. When the project does not install it, the verifier stops with the command that adds it as a development dependency (`pnpm add -D @antelopejs/dms`, or the equivalent for the project's package manager).
+
+Without `--module`, the verifier takes the current directory when it is a frontend module (it contains `dms.frontend.ts`), and its `frontend-vue` directory otherwise. `--module` names other ones and is repeatable, as is `--local-package`, which binds a local build of a package into the generated workspace. All supplied frontend packages are copied into the generated workspace and bound with `workspace:*`.
+
+```bash
+ajs dms verify-source --module ./admin-vue --module ./shop-vue
+```
+
+`--layer` is for the DMS core layer's own development: it verifies an unpublished core layer instead of the installed one, here against a local build of `@antelopejs/dms`:
 
 ```bash
 ajs dms verify-source \
   --layer /path/to/dms/frontend-vue \
-  --module /path/to/module/frontend-vue \
   --local-package @antelopejs/dms=/path/to/dms
 ```
 
-A supplied package whose declared range excludes this adapter version is refused before anything is installed (see [Declaring the loader releases a module supports](#declaring-the-loader-releases-a-module-supports)). The verifier generates a temporary workspace, installs it, builds client, SSR, and email bundles, checks what the client bundle loads, runs `vue-tsc`, renders eight DMS email templates, and checks that the email bundle excludes browser-only modules. Each check is one line that ends in ✔ or ✖, and the run ends with `Verified <n> modules` and its duration, or with the first failure: a type or Vite error points at the file in the package you passed (`./frontend-vue/app/components/Callout.vue:17:7`), not at its copy in the workspace, and the command exits 1. `--verbose` streams the pnpm, Vite and `vue-tsc` output. The workspace is removed when the run ends. It does not start a backend or publish packages. Repository development can invoke the same runner with `DMS_LAYER_SOURCE` through `pnpm test:real-source`.
+The checks look for what the core layer ships: its lazily loaded chart and rich-text libraries, the pages every DMS serves and its e-mail templates. A `--layer` that holds no core layer, such as a project's own `frontend-vue`, is refused before anything is installed, with exit code 2 and the command that verifies the same folder with `--module` instead.
+
+A supplied package whose declared range excludes this adapter version is refused before anything is installed (see [Declaring the loader releases a module supports](#declaring-the-loader-releases-a-module-supports)). The verifier generates a temporary workspace, installs it, builds client, SSR, and email bundles, checks what the client bundle loads, runs `vue-tsc`, renders eight DMS email templates, and checks that the email bundle excludes browser-only modules. Each check is one line that ends in ✔ or ✖, and the run ends with `Verified <n> modules` and its duration, or with the first failure: a type or Vite error points at the file in the package you passed (`./frontend-vue/app/components/Callout.vue:17:7`), not at its copy in the workspace, and the command exits 1. `--verbose` streams the pnpm, Vite and `vue-tsc` output. The workspace is removed when the run ends. It does not start a backend or publish packages. Repository development can invoke the same runner through `pnpm test:real-source`, with `DMS_LAYER_SOURCE` set to a core layer root and `DMS_MODULE_SOURCES` to a JSON array of module roots.
 
 Refresh rotation is single-flight within one frontend process. Horizontally scaled deployments must use sticky routing so a browser reaches the same process, or replace this process-local behavior with an external session adapter. It does not provide a distributed rotation guarantee.

package/dist/commands/verify-source-action.js

@@ -9,8 +9,6 @@ const node_path_1 = require("node:path");
 const cli_1 = require("@antelopejs/core/cli");
 const common_1 = require("../common");
 const verify_source_result_1 = require("../verify-source-result");
-const COMMAND_PATH = "ajs dms verify-source";
-const LAYER_OPTION = "-l, --layer <path>";
 function localPackageSeparator(value) {
     const separator = value.indexOf("=");
     return separator <= 0 || separator === value.length - 1 ? -1 : separator;
@@ -37,15 +35,10 @@ function directoryProblem(path, label) {
         return undefined;
     return { title: `${label} not found: ${path}`, fixes: [verify_source_result_1.LAYER_PATH_FIX] };
 }
-const MISSING_LAYER = {
-    title: `Required option '${LAYER_OPTION}' not specified`,
-    reason: `Usage: ${COMMAND_PATH} [options]`,
-    fixes: [`Run ${COMMAND_PATH} --help for usage`],
-};
 function usageProblems(options) {
     const problems = [
         options.layer === undefined
-            ? MISSING_LAYER
+            ? undefined
             : directoryProblem(options.layer, "Layer path"),
         ...(options.module ?? []).map((path) => directoryProblem(path, "Module path")),
         ...(options.localPackage ?? []).map(localPackageProblem),
@@ -71,7 +64,6 @@ function channelClosed(child) {
 async function runVerifySource(options) {
     const startedAt = Date.now();
     assertValidUsage(usageProblems(options));
-    const layer = options.layer ?? "";
     const modules = options.module ?? [];
     const localPackages = parseLocalPackages(options.localPackage ?? []);
     const runner = (0, node_path_1.join)(__dirname, "..", `verify-source-runner${(0, node_path_1.extname)(__filename)}`);
@@ -83,7 +75,7 @@ async function runVerifySource(options) {
         stdio: ["inherit", "inherit", "inherit", "ipc"],
         env: {
             ...process.env,
-            DMS_LAYER_SOURCE: (0, node_path_1.resolve)(layer),
+            DMS_LAYER_SOURCE: options.layer === undefined ? undefined : (0, node_path_1.resolve)(options.layer),
             DMS_MODULE_SOURCES: JSON.stringify(modules.map((path) => (0, node_path_1.resolve)(path))),
             DMS_LOCAL_PACKAGES: JSON.stringify(localPackages),
         },

package/dist/commands/verify-source.js

@@ -41,20 +41,24 @@ function collectOption(value, values = []) {
 }
 const VERIFY_SOURCE_EXAMPLES = [
     {
-        description: "A frontend package and a module that uses it",
-        command: "ajs dms verify-source -l ../dms/frontend-vue -m ./frontend-vue",
+        description: "The project's frontend module: the current directory or ./frontend-vue",
+        command: "ajs dms verify-source",
     },
     {
-        description: "With a local build of a package it depends on",
-        command: "ajs dms verify-source -l . --local-package @antelopejs/dms=../dms",
+        description: "Frontend modules in other directories",
+        command: "ajs dms verify-source -m ./admin-vue -m ./shop-vue",
+    },
+    {
+        description: "An unpublished DMS core layer, with a local build of @antelopejs/dms",
+        command: "ajs dms verify-source -l . --local-package @antelopejs/dms=..",
     },
 ];
 function cmdVerifySource() {
     const command = new commander_1.Command("verify-source")
         .summary("Build and type-check unpublished frontend sources")
-        .description("Build and type-check unpublished DMS frontend sources against this loader version, in a temporary workspace removed when the run ends. Starts no backend.")
-        .option("-l, --layer <path>", "Root of the DMS frontend package to verify (required)")
-        .option("-m, --module <path>", "Root of another frontend package to verify with it (repeatable)", collectOption)
+        .description("Build and type-check unpublished DMS frontend modules against this loader version, on top of the DMS core layer of the @antelopejs/dms installed in the project. Runs in a temporary workspace removed when the run ends, and starts no backend.")
+        .option("-l, --layer <path>", "Root of an unpublished DMS core layer to verify instead of the installed one")
+        .option("-m, --module <path>", "Root of a frontend module to verify (repeatable); without -l or -m, the current directory or ./frontend-vue", collectOption)
         .option("--local-package <name=path>", "Bind a local package into the generated workspace (repeatable)", collectOption)
         .action(async (options) => (await Promise.resolve().then(() => __importStar(require("./verify-source-action")))).runVerifySource(options));
     return (0, cli_1.withExamples)(command, VERIFY_SOURCE_EXAMPLES);

package/dist/config.d.ts

@@ -9,6 +9,7 @@ export declare function writeSecretBearingFile(file: string, content: string): v
 export declare const TEMPLATE_FILES: ReadonlyArray<readonly [string, string]>;
 export declare const LAYERS_SUBDIR = "frontend-modules";
 export declare const FRONTEND_MODULE_ENTRY = "dms.frontend.ts";
+export declare const FRONTEND_BUILD_ENTRY = "dms.frontend.build.ts";
 export declare const AUTH_ESTABLISH_FILE = "generated-auth-establish.json";
 export declare const LAYER_COPY_BLOCKLIST: readonly string[];
 export declare const layerCopyIgnore: ignore.Ignore;

package/dist/config.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Options = exports.UsageError = exports.TAILWIND_SOURCE_GLOB = exports.PNPM_LIFECYCLE_SCRIPTS = exports.layerCopyIgnore = exports.LAYER_COPY_BLOCKLIST = exports.AUTH_ESTABLISH_FILE = exports.FRONTEND_MODULE_ENTRY = exports.LAYERS_SUBDIR = exports.TEMPLATE_FILES = exports.WORKSPACE_DIR_MODE = exports.DEPS_HASH_FILE = exports.DMS_FRONTEND_HOME = void 0;
+exports.Options = exports.UsageError = exports.TAILWIND_SOURCE_GLOB = exports.PNPM_LIFECYCLE_SCRIPTS = exports.layerCopyIgnore = exports.LAYER_COPY_BLOCKLIST = exports.AUTH_ESTABLISH_FILE = exports.FRONTEND_BUILD_ENTRY = exports.FRONTEND_MODULE_ENTRY = exports.LAYERS_SUBDIR = exports.TEMPLATE_FILES = exports.WORKSPACE_DIR_MODE = exports.DEPS_HASH_FILE = exports.DMS_FRONTEND_HOME = void 0;
 exports.writeSecretBearingFile = writeSecretBearingFile;
 exports.parseBackendUrl = parseBackendUrl;
 exports.requireBackendUrl = requireBackendUrl;
@@ -45,6 +45,9 @@ exports.TEMPLATE_FILES = [
     ["ui-app-config.ts", "ui-app-config.ts"],
     ["ssr-renderer.ts", "ssr-renderer.ts"],
     ["frontend-module.ts", "frontend-module.ts"],
+    ["frontend-build.ts", "frontend-build.ts"],
+    ["frontend-build-loader.ts", "frontend-build-loader.ts"],
+    ["icon-hydration.ts", "icon-hydration.ts"],
     ["globals.d.ts", "globals.d.ts"],
     ["compress-assets.mjs", "compress-assets.mjs"],
     ["head-order.mjs", "head-order.mjs"],
@@ -66,6 +69,7 @@ exports.TEMPLATE_FILES = [
 ];
 exports.LAYERS_SUBDIR = "frontend-modules";
 exports.FRONTEND_MODULE_ENTRY = "dms.frontend.ts";
+exports.FRONTEND_BUILD_ENTRY = "dms.frontend.build.ts";
 exports.AUTH_ESTABLISH_FILE = "generated-auth-establish.json";
 exports.LAYER_COPY_BLOCKLIST = [
     "node_modules",

package/dist/derived-outputs.d.ts

@@ -1,10 +1,12 @@
 import { FrontendModuleOptions, ResolvedLayer } from "./workspace";
 export interface FrontendModuleRegistryEntry {
     id: string;
+    name?: string;
     packageName?: string;
     root: string;
     priority: number;
     entry?: string;
+    build?: string;
     options: FrontendModuleOptions;
 }
 export interface FrontendModuleRegistry {

package/dist/derived-outputs.js

@@ -21,6 +21,8 @@ function validateFrontendModuleRegistry(registry, workspaceDir) {
             throw new Error(`Invalid frontend module priority: ${module.id}`);
         if (module.entry !== undefined && module.entry !== config_1.FRONTEND_MODULE_ENTRY)
             throw new Error(`Invalid frontend module entry: ${module.id}`);
+        if (module.build !== undefined && module.build !== config_1.FRONTEND_BUILD_ENTRY)
+            throw new Error(`Invalid frontend module build entry: ${module.id}`);
         if (!(0, node_path_1.resolve)(module.root).startsWith(moduleRoot))
             throw new Error(`Frontend module root escapes the workspace: ${module.id}`);
         ids.add(module.id);
@@ -29,13 +31,16 @@ function validateFrontendModuleRegistry(registry, workspaceDir) {
 function createFrontendModuleRegistry(workspaceDir, layers) {
     const modules = layers.map((layer) => {
         const sourceEntry = (0, node_path_1.join)(layer.path, config_1.FRONTEND_MODULE_ENTRY);
+        const buildEntry = (0, node_path_1.join)(layer.path, config_1.FRONTEND_BUILD_ENTRY);
         const options = layer.options ?? {};
         return {
             id: (0, layers_1.getLayerSafeName)(layer),
+            name: layer.name ?? layer.packageName,
             packageName: layer.packageName,
             root: (0, layers_1.getLayerWorkspacePath)(workspaceDir, layer),
             priority: layer.priority ?? 0,
             entry: (0, node_fs_1.existsSync)(sourceEntry) ? config_1.FRONTEND_MODULE_ENTRY : undefined,
+            build: (0, node_fs_1.existsSync)(buildEntry) ? config_1.FRONTEND_BUILD_ENTRY : undefined,
             options: layer.configKey ? { [layer.configKey]: options } : options,
         };
     });
@@ -47,6 +52,7 @@ function createFrontendModuleRegistry(workspaceDir, layers) {
 function writeFrontendTypePaths(workspaceDir, registry) {
     const paths = {
         "#dms/frontend-module": ["./frontend-module.ts"],
+        "#dms/frontend-build": ["./frontend-build.ts"],
         "@frontend/*": ["./frontend-modules/*"],
         ...(0, layer_aliases_1.frontendLayerTypePaths)([...registry.modules].reverse().map((module) => module.root), { relativeTo: workspaceDir }),
     };
@@ -59,14 +65,27 @@ function writeFrontendModuleLoader(workspaceDir, registry) {
         .map((module, index) => `import module${index} from "@frontend/${module.id}/${module.entry}";`)
         .join("\n");
     const registrations = modules
-        .map((module, index) => `{ module: module${index}, options: { public: ${JSON.stringify(module.options)} } }`)
+        .map((module, index) => `{ name: ${JSON.stringify(module.name)}, module: module${index}, options: { public: ${JSON.stringify(module.options)} } }`)
         .join(", ");
     const content = `${imports}\n\nimport type { DmsFrontendModuleRegistration } from "./frontend-module";\n\nexport const frontendModules: DmsFrontendModuleRegistration[] = [${registrations}];\n`;
     return (0, fs_sync_1.applyContent)(content, (0, node_path_1.join)(workspaceDir, "frontend-modules.generated.ts"));
 }
+function writeFrontendBuildLoader(workspaceDir, registry) {
+    const modules = registry.modules.filter((module) => module.build);
+    const imports = modules
+        .map((module, index) => `import build${index} from "./${config_1.LAYERS_SUBDIR}/${module.id}/${module.build}";`)
+        .join("\n");
+    const declarations = modules
+        .map((module, index) => `{ id: ${JSON.stringify(module.id)}, setup: build${index} }`)
+        .join(", ");
+    const content = `${imports}\n\nimport type { FrontendBuildDeclaration } from "./frontend-build-loader";\n\nexport const frontendBuilds: FrontendBuildDeclaration[] = [${declarations}];\n`;
+    return (0, fs_sync_1.applyContent)(content, (0, node_path_1.join)(workspaceDir, "frontend-builds.generated.ts"));
+}
 function writeModuleRegistry(workspaceDir, registry) {
     const wroteRegistry = (0, fs_sync_1.applyContent)(`${JSON.stringify(registry, null, 2)}\n`, (0, node_path_1.join)(workspaceDir, "generated-frontend-modules.json"));
-    return writeFrontendModuleLoader(workspaceDir, registry) || wroteRegistry;
+    const wroteModules = writeFrontendModuleLoader(workspaceDir, registry);
+    const wroteBuilds = writeFrontendBuildLoader(workspaceDir, registry);
+    return wroteRegistry || wroteModules || wroteBuilds;
 }
 function moduleAssetRoots(moduleRoot) {
     const layersRoot = (0, node_path_1.join)(moduleRoot, "layers");
@@ -278,7 +297,7 @@ function writeShortcutExports(workspaceDir, registry) {
 exports.DERIVED_OUTPUTS = [
     {
         name: "module registry",
-        affects: (path) => (0, fs_sync_1.toPosixPath)(path) === config_1.FRONTEND_MODULE_ENTRY,
+        affects: (path) => [config_1.FRONTEND_MODULE_ENTRY, config_1.FRONTEND_BUILD_ENTRY].includes((0, fs_sync_1.toPosixPath)(path)),
         write: writeModuleRegistry,
     },
     {

package/dist/help.js

@@ -25,6 +25,10 @@ exports.ENVIRONMENT_VARIABLES = [
         "DMS_TRUSTED_PROXY_HOPS",
         "Trusted reverse-proxy hops, counted from the right (default: 0)",
     ],
+    [
+        "DMS_COUNTRY_HEADER",
+        "Proxy country header relayed to the backend when a proxy is trusted (default: CF-IPCountry; empty: none)",
+    ],
     [
         "DMS_HTML_RENDER_SECRET",
         "Overrides the e-mail render secret the backend publishes",

package/dist/layers.js

@@ -119,6 +119,7 @@ function readLayerPackageName(layerPath) {
 function resolveLayer(layerPath, mod) {
     return {
         path: layerPath,
+        name: mod.name,
         sourcePath: mod.path,
         packageName: readLayerPackageName(layerPath),
         priority: mod.priority,

package/dist/verify-source-runner.js

@@ -43,6 +43,7 @@ const output_1 = require("./output");
 const temporary_workspace_1 = require("./temporary-workspace");
 const typecheck_output_1 = require("./typecheck-output");
 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;
@@ -58,44 +59,6 @@ function ensure(condition, title, reason) {
     if (!condition)
         throw new cli_1.CliError({ title, reason });
 }
-function readLayer(root) {
-    const packagePath = (0, node_path_1.join)(root, "package.json");
-    if (!(0, node_fs_1.existsSync)(packagePath))
-        throw new common_1.UsageError({
-            title: `No package.json in ${(0, output_1.showPath)(root)}`,
-            fixes: [verify_source_result_1.LAYER_PATH_FIX],
-        });
-    const { name } = readJson(packagePath);
-    return { path: root, sourcePath: root, packageName: name };
-}
-function readSources() {
-    const layerSource = process.env.DMS_LAYER_SOURCE;
-    if (!layerSource)
-        throw new common_1.UsageError({
-            title: "DMS_LAYER_SOURCE is not set",
-            fixes: [
-                `Set it to the root of a DMS frontend package, or run ${verify_source_result_1.VERIFY_SOURCE_COMMAND} -l <path>`,
-            ],
-        });
-    const sourceRoot = (0, node_path_1.resolve)(layerSource);
-    if (!(0, node_fs_1.statSync)(sourceRoot, { throwIfNoEntry: false })?.isDirectory())
-        throw new common_1.UsageError({
-            title: `Layer path not found: ${(0, output_1.showPath)(sourceRoot)}`,
-            fixes: [verify_source_result_1.LAYER_PATH_FIX],
-        });
-    const extraSources = JSON.parse(process.env.DMS_MODULE_SOURCES ?? "[]");
-    const layerRoots = (0, node_fs_1.existsSync)((0, node_path_1.join)(sourceRoot, "dms.frontend.ts"))
-        ? [sourceRoot]
-        : (0, node_fs_1.readdirSync)(sourceRoot, { withFileTypes: true })
-            .filter((entry) => entry.isDirectory())
-            .map((entry) => (0, node_path_1.join)(sourceRoot, entry.name));
-    if (layerRoots.length === 0)
-        throw new common_1.UsageError({
-            title: `No frontend package in ${(0, output_1.showPath)(sourceRoot)}`,
-            fixes: [verify_source_result_1.LAYER_PATH_FIX],
-        });
-    return [...layerRoots, ...extraSources.map((root) => (0, node_path_1.resolve)(root))].map(readLayer);
-}
 function removeDevelopmentDependencies(root) {
     const packagePath = (0, node_path_1.join)(root, "package.json");
     if (!(0, node_fs_1.existsSync)(packagePath))
@@ -104,7 +67,7 @@ function removeDevelopmentDependencies(root) {
     delete packageData.devDependencies;
     (0, node_fs_1.writeFileSync)(packagePath, `${JSON.stringify(packageData, null, 2)}\n`);
 }
-function materializeWorkspace(workspace, layers) {
+function materializeWorkspace(workspace, layers, localPackages) {
     const templateRoot = (0, node_path_1.join)((0, common_1.getPackageRoot)(), "templates", "vue");
     const templateFiles = (0, node_fs_1.readdirSync)(templateRoot).filter((file) => !file.startsWith("npmrc"));
     for (const file of templateFiles)
@@ -121,7 +84,6 @@ function materializeWorkspace(workspace, layers) {
     (0, common_1.writeWorkspacePackageJson)(workspace, layers);
     const packagePath = (0, node_path_1.join)(workspace, "package.json");
     const workspacePackage = readJson(packagePath);
-    const localPackages = JSON.parse(process.env.DMS_LOCAL_PACKAGES ?? "{}");
     workspacePackage.pnpm = {
         overrides: {
             ...Object.fromEntries(layers.map((layer) => [layer.packageName, "workspace:*"])),
@@ -314,8 +276,10 @@ function describeError(error, isVerbose) {
     };
 }
 async function verifySources() {
-    const layers = readSources();
+    const options = (0, verify_source_sources_1.readSourceOptions)();
+    const { layers, coreLayer } = (0, verify_source_sources_1.readSources)(options);
     (0, output_1.writeHeader)("verify-source", [(0, cli_1.pluralize)(layers.length, "module")]);
+    (0, cli_1.getProcessUi)().message("info", `Verifying against ${coreLayer}`);
     (0, common_1.assertLayersSupportRenderer)(layers);
     const workspace = (0, temporary_workspace_1.createTemporaryWorkspace)("dms-frontend-real-source-");
     const isVerbose = (0, cli_1.isVerboseRun)();
@@ -327,7 +291,7 @@ async function verifySources() {
         env: { ...process.env, [vite_output_1.VITE_LOG_LEVEL_VARIABLE]: (0, vite_output_1.viteLogLevel)(isVerbose) },
     };
     const tasks = (0, cli_1.getProcessTasks)();
-    await tasks.run(`Materializing ${(0, cli_1.pluralize)(layers.length, "module")}`, async () => materializeWorkspace(workspace, layers), { done: `Materialized ${(0, cli_1.pluralize)(layers.length, "module")}` });
+    await tasks.run(`Materializing ${(0, cli_1.pluralize)(layers.length, "module")}`, async () => materializeWorkspace(workspace, layers, options.localPackages), { done: `Materialized ${(0, cli_1.pluralize)(layers.length, "module")}` });
     await (0, common_1.installDeps)(workspace, context.mapLine, ["--ignore-scripts"]);
     await buildBundles(context);
     await tasks.run("Checking the client bundle", async () => checkClientBundle(workspace), { done: "Client bundle checked", failed: "Client bundle check failed" });

package/dist/verify-source-sources.d.ts

@@ -0,0 +1,13 @@
+import { type ResolvedLayer } from "./common";
+export interface SourceOptions {
+    projectDir: string;
+    layerSource?: string;
+    moduleSources: string[];
+    localPackages: Record<string, string>;
+}
+export interface Sources {
+    layers: ResolvedLayer[];
+    coreLayer: string;
+}
+export declare function readSourceOptions(): SourceOptions;
+export declare function readSources(options: SourceOptions): Sources;